متد ها

کلاس کلاینت

• متد : __init__(Client)
• ورودی

• مثال

  Python

  from fast_rub import Client bot = Client("name_session")

  گرفتن اطلاعات بات

  • متد : get_me

  • خروجی

  فیلد	نوع	توضیحات
  get_me	get_me	بات

  • مثال

    Python

    سینک(sync)

    from fast_rub import Client bot = Client("test") def test(): me = bot.get_me() print(me) test()

    آیسینک(async)

    from fast_rub import Client import asyncio bot = Client("test") async def test(): me = await bot.get_me() print(me) asyncio.run(test())

  ارسال پیام (Text, InlineKeypad)

  • متد : send_text
  • ورودی

  فیلد	نوع	توضیحات
  chat_id	str	چت آیدی
  text	str	متن پیام
  disable_notification	bool or None	غیرفعال کردن اعلان؟ (پیشفرض false)
  inline_keypad	Keypad or None	keypad
  reply_to_message_id	str or None	در جوابِ پیامِ؟
  auto_delete	str or None	حذف خودکار پیام
  parse_mode	"Markdown" or "HTML" or None	پارس مود متن

  • خروجی

  فیلد	نوع	توضیحات
  message_id	str	شناسه پیام

  • مثال

    Python

    سینک(sync)

    from fast_rub import Client from fast_rub.button import KeyPad import asyncio chat_id = "b..." text = "test" bot = Client("test") def test(): sending = bot.send_text(text, chat_id) buttons = KeyPad() buttons.add_1row().simple("100", "buttun 1") buttons.add_4row().simple("101", "buttun 1", "102", "buttun 2", "103", "buttun 3", "104", "buttun 4") sending2 = bot.send_text(text, chat_id, inline_keypad=buttons.get()) print(sending) print(sending2) test()

    ایسینک(async)

    from fast_rub import Client from fast_rub.button import KeyPad import asyncio chat_id = "b..." text = "test" bot = Client("test") async def test(): sending = await bot.send_text(text, chat_id) buttons = KeyPad() buttons.add_1row().simple("100", "buttun 1") buttons.add_4row().simple("101", "buttun 1", "102", "buttun 2", "103", "buttun 3", "104", "buttun 4") sending2 = await bot.send_text(text, chat_id, inline_keypad=buttons.get()) print(sending) print(sending2) asyncio.run(test())

  ارسال keypad

  • متد : send_message_keypad
  • ورودی

  فیلد	نوع	توضیحات
  chat_id	str	چت آیدی
  text	str	متن پیام
  chat_keypad	Keypad	keypad
  disable_notification	bool	غیرفعال کردن اعلان؟ (پیشفرض false)
  reply_to_message_id	str or None	در جوابِ پیامِ؟
  resize_keyboard	bool or None	resize_keyboard
  on_time_keyboard	bool or None	on_time_keyboard
  parse_mode	"Markdown" or "HTML" or None	پارس مود متن

  • خروجی

  فیلد	نوع	توضیحات
  message_id	str	شناسه پیام

  • مثال

    Python

    سینک(sync)

    from fast_rub import Client from fast_rub.button import KeyPad bot = Client("test") def test(): buttons = KeyPad() buttons.add_1row().simple("100", "buttun 1") buttons.add_4row().simple("101", "buttun 1", "102", "buttun 2", "103", "buttun 3", "104", "buttun 4") sending = bot.send_message_keypad("chat id", "my text", Keypad=buttons.get()) print(sending) test()

    آیسینک(async)

    from fast_rub import Client from fast_rub.button import KeyPad import asyncio bot = Client("test") async def test(): buttons = KeyPad() buttons.add_1row().simple("100", "buttun 1") buttons.add_4row().simple("101", "buttun 1", "102", "buttun 2", "103", "buttun 3", "104", "buttun 4") sending = await bot.send_message_keypad("chat id", "my text", Keypad=buttons.get()) print(sending) asyncio.run(test())
ارسال پیام متنی
• متد : send_text
• ورودی
فیلد	نوع	توضیحات
text	str	متن پیام
chat_id	str	چت آیدی
inline_keypad	KepPad or None	کی پد
disable_notification	bool or None	غیرفعال کردن اعلان؟ (پیشفرض false)
reply_to_message_id	str or None	در جوابِ پیامِ؟
auto_delete	int or None	پاکسازی خودکار پیام پس از مدتی(ثانیه)
parse_mode	"Markdown" or "HTML" or None	پارس مود متن
• خروجی
فیلد	نوع	توضیحات
message_id	str	شناسه پیام
• مثال

  Python

  سینک(sync)

  from fast_rub import Client bot = Client("test") def test(): sending = bot.send_text("my text", "chat id") print(sending) test()

  آیسینک(async)

  from fast_rub import Client import asyncio bot = Client("test") async def test(): sending = await bot.send_text("my text", "chat id") print(sending) asyncio.run(test())
ارسال نظرسنجی
• متد : send_poll
• ورودی
فیلد	نوع	توضیحات
chat_id	str	چت آیدی
question	str	متن سوال
options	list	گزینه‌های سوال
auto_delete	int or None	پاکسازی خودکار پیام پس از مدتی(ثانیه)
• خروجی
فیلد	نوع	توضیحات
message_id	str	شناسه پیام
• مثال

  Python

  سینک(sync)

  from fast_rub import Client bot = Client("test") def test(): list_foods = ["چلو قرمه سبزی", "زرشک پلو با مرغ"] sending = bot.send_poll("chat id", "به چه غذایی علاقه دارید؟", list_foods) print(sending) test()

  آیسینک(async)

  from fast_rub import Client import asyncio bot = Client("test") async def test(): list_foods = ["چلو قرمه سبزی", "زرشک پلو با مرغ"] sending = await bot.send_poll("chat id", "به چه غذایی علاقه دارید؟", list_foods) print(sending) asyncio.run(test())
ارسال موقعیت مکانی
• متد : send_location
• ورودی
فیلد	نوع	توضیحات
chat_id	str	چت آیدی
latitude	str	عرض جغرافیایی
longitude	str	طول جغرافیایی
chat_keypad	str or None	keypad
disable_notification	str or None	غیرفعال کردن اعلان؟ (پیشفرض false)
inline_keypad	KeyPad or None	Keypad
reply_to_message_id	str or None	در جوابِ پیامِ؟
chat_keypad_type	str or None	نوع keypad
auto_delete	int or None	پاکسازی خودکار پیام پس از مدتی(ثانیه)
• خروجی
فیلد	نوع	توضیحات
message_id	str	شناسه پیام
• مثال

  Python

  سینک(sync)

  from fast_rub import Client bot = Client("test") def test(): sending = bot.send_location("chat id", "35.6892", "51.3890") print(sending) test()

  آیسینک(async)

  from fast_rub import Client import asyncio bot = Client("test") async def test(): sending = await bot.send_location("chat id", "35.6892", "51.3890") print(sending) asyncio.run(test())
ارسال مخاطب
• متد : send_contact
• ورودی
فیلد	نوع	توضیحات
chat_id	str	چت آیدی
first_name	str	نام مخاطب
last_name	str	نام‌خانوادگی مخاطب
phone_number	str	شماره مخاطب
chat_keypad	str or None	keypad
disable_notification	str or None	غیرفعال کردن اعلان؟ (پیشفرض false)
inline_keypad	Keypad or None	keypad
reply_to_message_id	str	در جوابِ پیامِ؟
chat_keypad_type	str	نوع keypad
auto_delete	int or None	پاکسازی خودکار پیام پس از مدتی(ثانیه)
• خروجی
فیلد	نوع	توضیحات
message_id	str	شناسه پیام
• مثال

  Python

  سینک(sync)

  from fast_rub import Client bot = Client("test") def test(): sending = bot.send_contact("chat id", "first name", "last name", "+989017760881") print(sending) test()

  آیسینک(async)

  from fast_rub import Client import asyncio bot = Client("test") async def test(): sending = await bot.send_contact("chat id", "first name", "last name", "+989017760881") print(sending) asyncio.run(test())
گرفتن آپدیت پیام ها
• متد : on_message
• ورودی
فیلد	نوع	توضیحات
filters	filters or None	فیلتر کردن گرفتن پیام
• خروجی
فیلد	نوع	توضیحات
Update	Update	مسیج آپدیت
• مثال

  Python

  سینک(sync)

  from fast_rub import Client from fast_rub.type import Update bot = Client("test") @bot.on_message() def test(msg:Update): print(msg) msg.reply("this is a reply text from fast rub") bot.run()

  آیسینک(async)

  from fast_rub import Client from fast_rub.type import Update bot = Client("test") @bot.on_message() async def test(msg:Update): print(msg) await msg.reply("this is a reply text from fast rub") bot.run()
گرفتن آپدیت کلیک های دکمه های شیشه ای
• متد : on_button
• خروجی
فیلد	نوع	توضیحات
Update button	Update button	مسیج آپدیت
• مثال

  Python

  سینک(sync)

  from fast_rub import Client from fast_rub.type import UpdateButton bot = Client("test") @bot.on_button() def test(msg:UpdateButton): print(msg) msg.send_text("this is a text from fast rub") bot.run()

  آیسینک(async)

  from fast_rub import Client from fast_rub.type import UpdateButton bot = Client("test") @bot.on_button() async def test(msg:UpdateButton): print(msg) await msg.send_text("this is a text from fast rub") bot.run()
گرفتن اطلاعات چت
• متد : get_chat
• ورودی
فیلد	نوع	توضیحات
chat_id	str	چت آیدی کاربر/گروه/کانال
• خروجی
فیلد	نوع	توضیحات
chat	chat	اطلاعات چت
• مثال

  Python

  سینک(sync)

  from fast_rub import Client bot = Client("test") def test(): sending = bot.get_chat("chat id") print(sending) test()

  آیسینک(async)

  from fast_rub import Client import asyncio bot = Client("test") async def test(): sending = await bot.get_chat("chat id") print(sending) asyncio.run(test())
فوروارد کردن پیام
• متد : forward_message
• ورودی
فیلد	نوع	توضیحات
from_chat_id	str	از چتِ؟
message_id	str	شناسه پیام
to_chat_id	str	به چتِ؟
disable_notification	bool or None	غیرفعال کردن اعلان؟ (پیشفرض false)
auto_delete	int or None	پاکسازی خودکار پیام پس از مدتی(ثانیه)
• خروجی
فیلد	نوع	توضیحات
new_message_id	str	شناسه پیام جدید
• مثال

  Python

  سینک(sync)

  from fast_rub import Client bot = Client("test") def test(): sending = bot.forward_message("from chat id", "message id", "to chat id") print(sending) test()

  آیسینک(async)

  from fast_rub import Client import asyncio bot = Client("test") async def test(): sending = await bot.forward_message("from chat id", "message id", "to chat id") print(sending) asyncio.run(test())
ویرایش متن پیام
• متد : edit_message_text
• ورودی
فیلد	نوع	توضیحات
chat_id	str	چت آیدی
message_id	str	شناسه پیام
text	str	پیام
parse_mode	"Markdown" or "HTML" or None	پارس مود متن
• مثال

  Python

  سینک(sync)

  from fast_rub import Client bot = Client("test") def test(): sending = bot.edit_message_text("chat id", "message id", "new text") print(sending) test()

  آیسینک(async)

  from fast_rub import Client import asyncio bot = Client("test") async def test(): sending = await bot.edit_message_text("chat id", "message id", "new text") print(sending) asyncio.run(test())
ویرایش Inline Keypad
• متد : edit_message_keypad_Inline
• ورودی
فیلد	نوع	توضیحات
chat_id	str	چت آیدی
message_id	str	شناسه پیام
inline_keypad	KeyPad	کی پد
disable_notification	bool or None	غیرفعال کردن اعلان؟ (پیشفرض false)
reply_to_message_id	str or None	در جوابِ پیامِ؟
parse_mode	"Markdown" or "HTML" or None	پارس مود متن
• مثال

  Python

  سینک(sync)

  from fast_rub import Client from fast_rub.button import KeyPad bot = Client("test") def test(): buttons = KeyPad() buttons.add_1row("100", "this Key Pad inline is edited !") sending = bot.edit_message_keypad_Inline("chat id", "message id", buttons.get()) print(sending) test()

  آیسینک(async)

  from fast_rub import Client from fast_rub.button import KeyPad import asyncio bot = Client("test") async def test(): buttons = KeyPad() buttons.add_1row("100", "this Key Pad inline is edited !") sending = await bot.edit_message_keypad_Inline("chat id", "message id", buttons.get()) print(sending) asyncio.run(test())
حذف پیام
• متد : delete_message
• ورودی
فیلد	نوع	توضیحات
chat_id	str	چت آیدی
message_id	str	شناسه پیام
• مثال

  Python

  سینک(sync)

  from fast_rub import Client bot = Client("test") def test(): sending = bot.delete_message("chat id", "message id") print(sending) test()

  آیسینک(async)

  from fast_rub import Client import asyncio bot = Client("test") async def test(): sending = await bot.delete_message("chat id", "message id") print(sending) asyncio.run(test())
تنظیم دستور‌ها (commands)
• متد : set_commands
• مثال

  Python

  سینک(sync)

  from fast_rub import Client bot = Client("test") def test(): bot.add_commands("/help", "راهنمای ربات") sending = bot.set_commands() print(sending) deleting = bot.delete_commands() print(deleting) test()

  آیسینک(async)

  from fast_rub import Client import asyncio bot = Client("test") async def test(): await bot.add_commands("/help", "راهنمای ربات") sending = await bot.set_commands() print(sending) deleting = await bot.delete_commands() print(deleting) asyncio.run(test())
آپدیت آدرس بات (URL Endpoint)
• متد : set_endpoint
• ورودی
فیلد	نوع	توضیحات
url	str	آدرس جدید
type	EndPoint	نوع آدرس
• مثال

  Python

  سینک(sync)

  from fast_rub import Client bot = Client("test") def test(): update_end_point = bot.set_endpoint("my url end point", "ReceiveUpdate") print(update_end_point) test()

  آیسینک(async)

  from fast_rub import Client import asyncio bot = Client("test") async def test(): update_end_point = await bot.set_endpoint("my url end point", "ReceiveUpdate") print(update_end_point) asyncio.run(test())

ارسال فایل/ویدیو/تصویر/پیغام صوتی/موسیقی/گیف

• متد : send_file , send_video , send_image , send_voice , send_music , send_gif
• ورودی

• مثال

  Python

  سینک(sync)

  from fast_rub import Client bot = Client("test") def test(): sending = bot.send_file("chat id", "test.json", name_file="data.json", text="this is a caption") sending2 = bot.send_image("chat id", "test.png", name_file="picture.png", text="this is a caption") print(sending) print(sending2) test()

  آیسینک(async)

  from fast_rub import Client import asyncio bot = Client("test") async def test(): sending = await bot.send_file("chat id", "test.json", name_file="data.json", text="this is a caption") sending2 = await bot.send_image("chat id", "test.png", name_file="picture.png", text="this is a caption") print(sending) print(sending2) asyncio.run(test())

دانلود فایل

• متد : download_file
• ورودی

• مثال

  Python

  سینک(sync)

  from fast_rub import Client bot = Client("test") async def test(): bot.download_file("file id","test.txt") test()

  آیسینک(async)

  from fast_rub import Client import asyncio bot = Client("test") async def test(): await bot.download_file("file id","test.txt") asyncio.run(test())

  گرفتن لینک دانلود فایل

  • متد : get_download_file_url
  • ورودی

  فیلد	نوع	توضیحات
  id_file	str	فایل آیدی

  • مثال

    Python

    سینک(sync)

    from fast_rub import Client bot = Client("test") async def test(): url = bot.get_download_file_url("file id") print(url) test()

    آیسینک(async)

    from fast_rub import Client import asyncio bot = Client("test") async def test(): url = await bot.get_download_file_url("file id") print(url) asyncio.run(test())

    نسخه BotApi

    • متد : version_botapi

    • مثال

      Python

      سینک(sync)

      from fast_rub import Client bot = Client("test") def test(): version = bot.version_botapi() print(version) test()

      آیسینک(async)

      from fast_rub import Client import asyncio bot = Client("test") async def test(): version = await bot.version_botapi() print(version) asyncio.run(test())

      تنظیم تنظیمات لاگ ها

      • متد : set_logging
      • ورودی ها

      فیلد	نوع	توضیحات
      saving	bool or None	ذخیره لاگ ها
      viewing	bool or None	نمایش لاگ ها

      • مثال

        Python

        سینک(sync)

        from fast_rub import Client bot = Client("test") def test(): version = bot.set_logging(viewing = False) test()

        آیسینک(async)

        from fast_rub import Client import asyncio bot = Client("test") async def test(): version = await bot.set_logging(saving = True) asyncio.run(test())

        تنظیم تایم اوت

        • متد : set_timeout
        • ورودی ها

        فیلد	نوع	توضیحات
        time_out	int	تایم اوت

        • مثال

          Python

          سینک(sync)

          from fast_rub import Client bot = Client("test") async def test(): version = bot.set_timeout(time_out = 30) test()

          آیسینک(async)

          from fast_rub import Client import asyncio bot = Client("test") async def test(): version = await bot.set_timeout(time_out = 30) asyncio.run(test())

          پاکسازی خودکار پیام

          • متد : auto_delete
          • ورودی ها

          فیلد	نوع	توضیحات
          chat_id	str	چت آیدی
          message_id	str	مسیج آیدی
          time_sleep	float	زمان ایستادن قبل از پاکسازی پیام

          • مثال

            Python

            سینک(sync)

            from fast_rub import Client bot = Client("test") async def test(): bot.auto_delete("b...","message id",30) test()

            آیسینک(async)

            from fast_rub import Client import asyncio bot = Client("test") async def test(): await bot.auto_delete("b...","message id",30) asyncio.run(test())