متد ها

کلاس کلاینت

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

• مثال

  Python

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

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

  • متد : get_me

  • خروجی

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

  • مثال

    Python

    سینک(sync)

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

    آیسینک(async)

    from fast_rub.pyrubi import Client import asynico bot = Client("name_session") def test(): me = await bot.get_me() print(me) asynico.run(test())

  ارسال پیام

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

  فیلد	نوع	توضیحات
  object_guid	str	آبجکت گوید
  text	str	متن پیام
  message_id	str or None	در جوابِ پیامِ؟

  • خروجی

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

  • مثال

    Python

    سینک(sync)

    from fast_rub.pyrubi import Client import asyncio object_guid = "u..." text = "test" bot = Client("name_session") def test(): sending = bot.send_text(object_guid,text) test()

    ایسینک(async)

    from fast_rub.pyrubi import Client import asyncio object_guid = "u..." text = "test" bot = Client("name_session") def test(): sending = bot.send_text(object_guid,text) asyncio.run(test())

  ارسال نظرسنجی

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

  فیلد	نوع	توضیحات
  object_guid	str	آبجکت گوید
  question	str	متن سوال
  options	list	گزینه‌های سوال
  message_id	str or None	در جواب پیام؟

  • خروجی

  فیلد	نوع	توضیحات
  message_id	str or None	شناسه پیام
  multiple_answers	bool or None	چند گزینه ای
  anonymous	bool or None	ناشناس بودن نظرسنجی
  quiz	bool or None	حالت کوییز

  • مثال

    Python

    سینک(sync)

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

    آیسینک(async)

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

  ارسال موقعیت مکانی

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

  فیلد	نوع	توضیحات
  object_guid	str	آبجکت گوید
  latitude	str	عرض جغرافیایی
  longitude	str	طول جغرافیایی
  message_id	str or None	در جوابِ پیامِ؟

  • خروجی

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

  • مثال

    Python

    سینک(sync)

    from fast_rub.pyrubi import Client bot = Client("name_session") def test(): sending = bot.send_location("object guid", "35.6892", "51.3890") print(sending) test()

    آیسینک(async)

    from fast_rub.pyrubi import Client import asyncio bot = Client("name_session") async def test(): sending = await bot.send_location("object guid", "35.6892", "51.3890") print(sending) asyncio.run(test())

  ارسال مخاطب

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

  فیلد	نوع	توضیحات
  object_guid	str	آبجکت گوید
  first_name	str	نام مخاطب
  last_name	str	نام‌خانوادگی مخاطب
  phone_number	str	شماره مخاطب
  user_guid	str	گوید کاربر
  message_id	str	در جوابِ پیامِ؟

  • خروجی

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

  • مثال

    Python

    سینک(sync)

    from fast_rub.pyrubi import Client bot = Client("name_session") def test(): sending = bot.send_contact("object guid", "first name", "last name", "+989017760881","user guid") print(sending) test()

    آیسینک(async)

    from fast_rub.pyrubi import Client import asyncio bot = Client("name_session") async def test(): bot.send_contact("object guid", "first name", "last name", "+989017760881","user guid") print(sending) asyncio.run(test())

  گرفتن آپدیت پیام ها

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

  فیلد	نوع	توضیحات
  filters	filters or None	فیلتر کردن گرفتن پیام

  • خروجی

  فیلد	نوع	توضیحات
  Message	Message	مسیج آپدیت

  • مثال

    Python

    سینک(sync)

    from fast_rub.pyrubi import Client from fast_rub.pyrubi.types import Message bot = Client("name_session") @bot.on_message() def test(msg:Message): print(msg) msg.reply("this is a reply text from fast rub fork pyrubi") bot.run()

    آیسینک(async)

    from fast_rub.pyrubi import Client from fast_rub.pyrubi.types import Message bot = Client("name_session") @bot.on_message() async def test(msg:Message): print(msg) await msg.reply("this is a reply text from fast rub fork pyrubi") bot.run()

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

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

  فیلد	نوع	توضیحات
  object_guid	str	آبجکت گوید کاربر/گروه/کانال

  • خروجی

  فیلد	نوع	توضیحات
  chat	chat	اطلاعات چت

  • مثال

    Python

    سینک(sync)

    from fast_rub.pyrubi import Client bot = Client("name_session") def test(): info = bot.get_chat_info("object guid") print(info) test()

    آیسینک(async)

    from fast_rub.pyrubi import Client import asyncio bot = Client("name_session") async def test(): info = await bot.get_chat_info("object guid") print(info) asyncio.run(test())

  فوروارد کردن پیام

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

  فیلد	نوع	توضیحات
  object_guid	str	از آبجکت گوید
  message_ids	list	شناسه های پیام ها
  to_object_guid	str	به آبجکت گوید

  • خروجی

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

  • مثال

    Python

    سینک(sync)

    from fast_rub.pyrubi import Client bot = Client("name_session") def test(): sending = bot.forward_messages("from object guid", ["message id"], "to object guid") print(sending) test()

    آیسینک(async)

    from fast_rub.pyrubi import Client import asyncio bot = Client("name_session") async def test(): sending = await bot.forward_messages("from object guid", ["message id"], "to object guid") print(sending) asyncio.run(test())

  ویرایش متن پیام

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

  فیلد	نوع	توضیحات
  object_guid	str	آبجکت گوید
  text	str	پیام
  message_id	str	شناسه پیام

  • مثال

    Python

    سینک(sync)

    from fast_rub.pyrubi import Client bot = Client("name_session") def test(): sending = bot.edit_message("Object guid", "new text", "message id") print(sending) test()

    آیسینک(async)

    from fast_rub.pyrubi import Client import asyncio bot = Client("name_session") async def test(): sending = await bot.edit_message("Object guid", "new text", "message id") print(sending) asyncio.run(test())

  حذف پیام

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

  فیلد	نوع	توضیحات
  object_guid	str	آبجکت گوید
  message_ids	list	شناسه های پیام ها
  delete_for_all	bool = True	حذف برای همه

  • مثال

    Python

    سینک(sync)

    from fast_rub.pyrubi import Client bot = Client("name_session) def test(): deleting = bot.delete_messages("object guid", ["message id"]) print(deleting) test()

    آیسینک(async)

    from fast_rub.pyrubi import Client import asyncio bot = Client("test") async def test(): deleting = await bot.delete_messages("object guid", ["message id"]) print(deleting) asyncio.run(test())

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

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

  فیلد	نوع	توضیحات
  object guid	str	چت آیدی
  file	str	فایل
  name_file	str or None(name_file = "file")	نام فایل
  message_id	str or None	در جواب ؟
  text	str or None	کپشن فایل
  thumbnail	str or None	thumbnail
  file_name	str or None	اسم فایل

  • مثال

    Python

    سینک(sync)

    from fast_rub.pyrubi import Client bot = Client("name_session") def test(): sending = bot.send_file("object guid", "test.json", file_name="data.json", text="this is a caption") sending2 = bot.send_image("object guid", "test.png", file_name="picture.png", text="this is a caption") print(sending) print(sending2) test()

    آیسینک(async)

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

  دانلود فایل

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

  فیلد	نوع	توضیحات
  object_guid	str	آبجکت گوید
  message_id	str	مسیج آیدی
  save	bool = False	ذخیره
  save_as	str or None	ذخیره در
  save_as	str or None	ذخیره در
  file_inline	dict or None	فایل

  • مثال

    Python

    سینک(sync)

    from fast_rub.pyrubi import Client bot = Client("name_session") async def test(): bot.download("object guid","message id",save=True,save_as="text.bin") test()

    آیسینک(async)

    from fast_rub.pyrubi import Client import asyncio bot = Client("name_session") async def test(): await bot.download("object guid","message id",save=True,save_as="text.bin") asyncio.run(test())

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

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

    فیلد	نوع	توضیحات
    objcet_guid	str	آبجکت گوید
    message_id	str	مسیج آیدی
    file_inline	str or None	فایل

    • مثال

      Python

      سینک(sync)

      from fast_rub.pyrubi import Client bot = Client("name_session") async def test(): url = bot.get_download_link("objcet_guid", "message id") print(url) test()

      آیسینک(async)

      from fast_rub.pyrubi import Client import asyncio bot = Client("name_session") async def test(): url = await bot.get_download_link("objcet_guid", "message id") print(url) asyncio.run(test())

      پیوستن به چت

      • متد : join_chat

      • مثال

        Python

        سینک(sync)

        from fast_rub.pyrubi import Client bot = Client("name_session") def test(): joining = bot.join_chat("link or guid") print(joining) test()

        آیسینک(async)

        from fast_rub.pyrubi import Client import asyncio bot = Client("name_session") async def test(): joining = await bot.join_chat("link or guid") print(joining) asyncio.run(test())

        ترک چت

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

        فیلد	نوع	توضیحات
        object_guid	str	آبجکت گوید

        • مثال

          Python

          سینک(sync)

          from fast_rub.pyrubi import Client bot = Client("name_session") def test(): bot.leave_chat("object guid") test()

          آیسینک(async)

          from fast_rub.pyrubi import Client import asyncio bot = Client("name_session") async def test(): version = await bot.leave_chat("object guid") asyncio.run(test())

          حذف چت

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

          فیلد	نوع	توضیحات
          object_guid	str	آبجکت گوید

          • مثال

            Python

            سینک(sync)

            from fast_rub.pyrubi import Client bot = Client("name_session") def test(): bot.remove_chat("object guid") test()

            آیسینک(async)

            from fast_rub.pyrubi import Client import asyncio bot = Client("name_session") async def test(): await bot.remove_chat("object guid") asyncio.run(test())

            گرفتن اطلاعات چت با نام کاربری

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

            فیلد	نوع	توضیحات
            username	str	نام کاربری

            • مثال

              Python

              سینک(sync)

              from fast_rub.pyrubi import Client bot = Client("name_session") def test(): info = bot.get_chat_info_by_username("@O_and_ONE_01") print(info) test()

              آیسینک(async)

              from fast_rub.pyrubi import Client import asyncio bot = Client("name_session") async def test(): info = await bot.get_chat_info_by_username("@O_and_ONE_01") print(info) asyncio.run(test())

              گرفتن اطلاعات لینک چت

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

              فیلد	نوع	توضیحات
              object_guid	str	آبجکت گوید

              • مثال

                Python

                سینک(sync)

                from fast_rub.pyrubi import Client bot = Client("name_session") def test(): link_info = bot.get_link("object guid") print(link_info) test()

                آیسینک(async)

                from fast_rub.pyrubi import Client import asyncio bot = Client("name_session") async def test(): link_info = await bot.get_link("object guid") print(link_info) asyncio.run(test())

                تنظیم ادمین

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

                فیلد	نوع	توضیحات
                object_guid	str	آبجکت گوید
                member_guid	str	ممبر گوید
                access_list	list	لیست دسترسی ها
                custom_title	str = None	اسم سفارشی

                • مثال

                  Python

                  سینک(sync)

                  from fast_rub.pyrubi import Client bot = Client("name_session") def test(): admin = bot.set_admin("object guid","member guid",[],"admin test") print(admin) test()

                  آیسینک(async)

                  from fast_rub.pyrubi import Client import asyncio bot = Client("name_session") async def test(): admin = await bot.set_admin("object guid","member guid",[],"admin test") print(admin) asyncio.run(test())

                  برداشتن تنظیم ادمین

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

                  فیلد	نوع	توضیحات
                  object_guid	str	آبجکت گوید
                  member_guid	str	ممبر گوید

                  • مثال

                    Python

                    سینک(sync)

                    from fast_rub.pyrubi import Client bot = Client("name_session") def test(): admin = bot.set_admin("object guid","member guid") print(admin) test()

                    آیسینک(async)

                    from fast_rub.pyrubi import Client import asyncio bot = Client("name_session") async def test(): admin = await bot.set_admin("object guid","member guid") print(admin) asyncio.run(test())

                    افزودن ممبر به چت

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

                    فیلد	نوع	توضیحات
                    object_guid	str	آبجکت گوید
                    member_guids	str or list	ممبر گویدها

                    • مثال

                      Python

                      سینک(sync)

                      from fast_rub.pyrubi import Client bot = Client("name_session") def test(): add = bot.add_members("object guid","member guid") print(add) test()

                      آیسینک(async)

                      from fast_rub.pyrubi import Client import asyncio bot = Client("name_session") async def test(): add = await bot.add_members("object guid","member guid") print(add) asyncio.run(test())

                      بن کاربر

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

                      فیلد	نوع	توضیحات
                      object_guid	str	آبجکت گوید
                      member_guid	str	ممبر گوید

                      • مثال

                        Python

                        سینک(sync)

                        from fast_rub.pyrubi import Client bot = Client("name_session") def test(): ban = bot.ban_member("object guid","member guid") print(ban) test()

                        آیسینک(async)

                        from fast_rub.pyrubi import Client import asyncio bot = Client("name_session") async def test(): ban = await bot.ban_member("object guid","member guid") print(ban) asyncio.run(test())

                        برداشتن بن کاربر

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

                        فیلد	نوع	توضیحات
                        object_guid	str	آبجکت گوید
                        member_guid	str	ممبر گوید

                        • مثال

                          Python

                          سینک(sync)

                          from fast_rub.pyrubi import Client bot = Client("name_session") def test(): unban = bot.unban_member("object guid","member guid") print(unban) test()

                          آیسینک(async)

                          from fast_rub.pyrubi import Client import asyncio bot = Client("name_session") async def test(): unban = await bot.unban_member("object guid","member guid") print(unban) asyncio.run(test())

                          گرفتن لیست کاربران بن شده چت

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

                          فیلد	نوع	توضیحات
                          object_guid	str	آبجکت گوید
                          start_id	str = None	َشروع از

                          • مثال

                            Python

                            سینک(sync)

                            from fast_rub.pyrubi import Client bot = Client("name_session") def test(): members = bot.get_banned_members("object guid") print(members) test()

                            آیسینک(async)

                            from fast_rub.pyrubi import Client import asyncio bot = Client("name_session") async def test(): members = await bot.get_banned_members("object guid") print(members) asyncio.run(test())

                            گرفتن لیست کاربران چت

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

                            فیلد	نوع	توضیحات
                            object_guid	str	آبجکت گوید
                            search_text	str = None	جستجو متن
                            start_id	str = None	َشروع از
                            just_get_guids	bool = False	َدریافت فقط لیست ممبر ها

                            • مثال

                              Python

                              سینک(sync)

                              from fast_rub.pyrubi import Client bot = Client("name_session") def test(): members = bot.get_all_members("object guid") print(members) test()

                              آیسینک(async)

                              from fast_rub.pyrubi import Client import asyncio bot = Client("name_session") async def test(): members = await bot.get_all_members("object guid") print(members) asyncio.run(test())

                              گرفتن لیست کاربران ادمین

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

                              فیلد	نوع	توضیحات
                              object_guid	str	آبجکت گوید
                              start_id	str = None	َشروع از
                              just_get_guids	bool = False	َدریافت فقط لیست ممبر ها

                              • مثال

                                Python

                                سینک(sync)

                                from fast_rub.pyrubi import Client bot = Client("name_session") def test(): members = bot.get_admin_members("object guid") print(members) test()

                                آیسینک(async)

                                from fast_rub.pyrubi import Client import asyncio bot = Client("name_session") async def test(): members = await bot.get_admin_members("object guid") print(members) asyncio.run(test())