Skip to content

سایر متدها

متدهای اصلی و راه‌اندازی

connect

برقراری ارتباط با API روبیکا. یک نمونه Api ایجاد می‌کند و اطلاعات نشست ذخیره شده (auth, guid, private_key, user_agent) را در صورت وجود بارگذاری می‌کند.

خروجی:

  • Messenger: نمونه کلاینت با اتصال فعال.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    app.connect()

start

شروع کلاینت، مدیریت احراز هویت و ثبت‌نام.

پارامترها:

  • phone_number (str, optional): شماره تلفن برای ثبت‌نام.

خروجی:

  • Messenger: نمونه کلاینت مقداردهی‌شده.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    app.start("+989123456789")

run

شروع کلاینت و گوش دادن به به‌روزرسانی‌ها. اطمینان از برقراری اتصال، سپس اجرای اختیاری یک coroutine قبل از ورود به حلقه به‌روزرسانی. هم در محیط‌های sync و هم async کار می‌کند.

پارامترها:

  • coroutine (Coroutine, optional): Coroutine اختیاری برای اجرا قبل از گوش دادن به به‌روزرسانی‌ها.

خروجی:

  • None: در حالت عادی تا زمانی که متوقف نشود، اجرا می‌شود.

مثال sync:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    app.run()

مثال async:

Python
from maxrubika import Messenger

async with Messenger("mySession") as app:
    await app.run()

disconnect

قطع ارتباط با سرور روبیکا.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    app.start()
    # ... انجام عملیات ...
    app.disconnect()

متدهای دریافت به‌روزرسانی

get_updates

دریافت به‌روزرسانی‌ها از WebSocket روبیکا.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        # این متد به صورت نامحدود اجرا می‌شود و به‌روزرسانی‌ها را دریافت می‌کند
        app.get_updates()

    except Exception as e:
        print(e)

متدهای درخواست

request

ساخت و ارسال درخواست به API روبیکا.

پارامترها:

  • method (str): نام متد API (مانند 'sendMessage', 'getUserInfo').
  • input (dict, optional): داده‌های ورودی برای متد.
  • tmp_session (bool): استفاده از نشست موقت به جای auth (پیش‌فرض: False).
  • encrypt (bool): رمزگذاری داده‌های درخواست (پیش‌فرض: True).

خروجی:

  • Data or None: پاسخ API.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        result = app.request(
            method="getUserInfo",
            input={"user_guid": "u0abc123..."}
        )
        print(result)

    except Exception as e:
        print(e)

متدهای فایل

upload_file

آپلود فایل به روبیکا.

پارامترها:

  • file (str or bytes): مسیر فایل یا bytes برای آپلود.
  • mime (str, optional): نوع MIME فایل.
  • file_name (str, optional): نام فایل.
  • chunk (int, optional): اندازه هر بخش به بایت (پیش‌فرض: 1MB).
  • callback (callable, optional): تابع پیشرفت آپلود (total_size, uploaded_bytes).

خروجی:

  • متادیتای فایل آپلود شده شامل mime, size, dc_id, file_id, file_name, access_hash_rec.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        result = app.upload_file(
            file="file.jpg",
            mime="image/jpeg",
            file_name="my_image.jpg"
        )
        print(result)

    except Exception as e:
        print(e)

download_file

دانلود فایل از سرورهای روبیکا با استفاده از شناسه فایل و access hash.

پارامترها:

  • file_inline: دیکشنری یا Data حاوی اطلاعات فایل (dc_id, file_id, access_hash_rec, size, file_name).
  • dc_id (int, optional): شناسه دیتاسنتر (در صورت عدم ارسال file_inline).
  • file_id (int, optional): شناسه یکتای فایل.
  • access_hash (str, optional): هش دسترسی مرتبط با فایل.
  • size (int, optional): اندازه کل فایل به بایت.
  • chunk (int, optional): اندازه هر بخش دانلود (پیش‌فرض: 131072).
  • callback (callable, optional): تابع پیشرفت دانلود (total_size, downloaded_size).
  • gather (bool, optional): دانلود بخش‌ها به صورت موازی (پیش‌فرض: False).
  • save_as (str or bool, optional): مسیر دایرکتوری یا True برای دایرکتوری جاری. اگر None باشد، بایت‌ها را برمی‌گرداند.
  • file_name (str, optional): نام سفارشی فایل.
  • as_base64 (bool, optional): بازگرداندن فایل به صورت base64 (پیش‌فرض: False).

خروجی:

  • bytes, str, or Data: محتوای فایل (bytes)، رشته base64 یا Data (زمانی که save_as استفاده می‌شود).

مثال‌ها:

  1. دانلود با file_inline:
Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        result = app.download_file(
            file_inline={"dc_id": 1, "file_id": 123456, "access_hash_rec": "hash_example", "size": 1024000},
            save_as=True,
            file_name="my_file.jpg"
        )
        print(result)

    except Exception as e:
        print(e)
  1. دانلود با پارامترهای جداگانه و دریافت bytes:
Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        result = app.download_file(
            dc_id=1,
            file_id=123456,
            access_hash="hash_example",
            size=1024000
        )
        print(result)

    except Exception as e:
        print(e)

متدهای کمکی

get_time

این متد برای دریافت زمان فعلی سرور به کار می‌رود.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        time = app.get_time()
        print(time)

    except Exception as e:
        print(e)

get_available_reactions

این متد برای دریافت لیست ری‌اکشن‌های قابل استفاده در چت‌ها به کار می‌رود.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        reactions = app.get_available_reactions()
        print(reactions)

    except Exception as e:
        print(e)

get_location_view

این متد برای دریافت نقشه یک موقعیت جغرافیایی به کار می‌رود.

پارامترها:

  • latitude: عرض جغرافیایی. (عددی بین ۹۰- تا ۹۰)
  • longitude: طول جغرافیایی. (عددی بین ۱۸۰- تا ۱۸۰)

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        view = app.get_location_view(latitude=35.6892, longitude=51.3890)
        print(view)

    except Exception as e:
        print(e)

get_wallpapers

این متد برای دریافت تنظیمات فعلی تصویر پس‌زمینه چت به کار می‌رود.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        wallpapers = app.get_wallpapers()
        print(wallpapers)

    except Exception as e:
        print(e)

reset_wallpapers

این متد برای بازنشانی تمام تصاویر پس‌زمینه چت‌ها به حالت پیش‌فرض به کار می‌رود.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        result = app.reset_wallpapers()
        print(result)

    except Exception as e:
        print(e)

متدهای استیکر و گیف

get_sticker_setting

این متد برای دریافت تنظیمات استیکر کاربر فعلی به کار می‌رود.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        settings = app.get_sticker_setting()
        print(settings)

    except Exception as e:
        print(e)

get_my_sticker_sets

این متد برای دریافت مجموعه استیکرهای متعلق به کاربر به کار می‌رود.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        stickers = app.get_my_sticker_sets()
        print(stickers)

    except Exception as e:
        print(e)

get_my_archived_sticker_sets

این متد برای دریافت مجموعه استیکرهای آرشیو شده کاربر به کار می‌رود.

پارامتر:

  • start_id: شناسه شروع برای صفحه‌بندی. (پیش‌فرض: None)

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        archived = app.get_my_archived_sticker_sets()
        print(archived)

    except Exception as e:
        print(e)

get_sticker_set_by_id

این متد برای دریافت یک مجموعه استیکر با شناسه آن به کار می‌رود.

پارامتر:

  • sticker_set_id: شناسه مجموعه استیکر.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        sticker_set = app.get_sticker_set_by_id("sticker_set_id_123")
        print(sticker_set)

    except Exception as e:
        print(e)

get_stickers_by_set_ids

این متد برای دریافت استیکرها با شناسه مجموعه‌های آن‌ها به کار می‌رود.

پارامتر:

  • sticker_set_ids: یک شناسه یا لیستی از شناسه‌های مجموعه استیکر.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        stickers = app.get_stickers_by_set_ids(["id1", "id2", "id3"])
        print(stickers)

    except Exception as e:
        print(e)

get_stickers_by_emoji

این متد برای دریافت استیکرها بر اساس ایموجی به کار می‌رود.

پارامترها:

  • emoji: کاراکتر ایموجی.
  • suggest_by: نوع پیشنهاد. (پیش‌فرض: All)

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        stickers = app.get_stickers_by_emoji("😊")
        print(stickers)

    except Exception as e:
        print(e)

search_stickers

این متد برای جستجوی استیکرها به کار می‌رود.

پارامترها:

  • search_text: متن جستجو. (پیش‌فرض: خالی)
  • start_id: شناسه شروع برای صفحه‌بندی. (پیش‌فرض: None)

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        results = app.search_stickers(search_text="سلام")
        print(results)

    except Exception as e:
        print(e)

get_trend_sticker_sets

این متد برای دریافت مجموعه استیکرهای پرطرفدار به کار می‌رود.

پارامتر:

  • start_id: شناسه شروع برای صفحه‌بندی. (پیش‌فرض: None)

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        trending = app.get_trend_sticker_sets()
        print(trending)

    except Exception as e:
        print(e)

add_sticker_set

این متد برای افزودن یک مجموعه استیکر به مجموعه‌های کاربر به کار می‌رود.

پارامتر:

  • sticker_set_id: شناسه مجموعه استیکر.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        result = app.add_sticker_set("sticker_set_id_123")
        print(result)

    except Exception as e:
        print(e)

delete_sticker_set

این متد برای حذف یک مجموعه استیکر از مجموعه‌های کاربر به کار می‌رود.

پارامتر:

  • sticker_set_id: شناسه مجموعه استیکر.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        result = app.delete_sticker_set("sticker_set_id_123")
        print(result)

    except Exception as e:
        print(e)

get_my_gif_set

این متد برای دریافت مجموعه گیف‌های شخصی کاربر به کار می‌رود.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        gifs = app.get_my_gif_set()
        print(gifs)

    except Exception as e:
        print(e)

add_to_my_gif_set

این متد برای افزودن یک گیف به مجموعه گیف‌های شخصی کاربر به کار می‌رود.

پارامترها:

  • chat: شناسه (GUID)، لینک یا نام‌کاربری چت حاوی گیف.
  • message_id: شناسه پیام گیف.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        result = app.add_to_my_gif_set("g0abc123...", message_id="123456")
        print(result)

    except Exception as e:
        print(e)

delete_my_gif_set

این متد برای حذف یک گیف از مجموعه گیف‌های شخصی کاربر به کار می‌رود.

پارامتر:

  • file_id: شناسه فایل گیف.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        result = app.delete_my_gif_set("file_id_123")
        print(result)

    except Exception as e:
        print(e)

متدهای پخش زنده

get_live_status

این متد برای دریافت وضعیت یک پخش زنده به کار می‌رود.

پارامترها:

  • live_id: شناسه پخش زنده.
  • access_token: توکن دسترسی دریافت‌شده از پاسخ send_live.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        status = app.get_live_status(live_id="live_123", access_token="token_abc")
        print(status)

    except Exception as e:
        print(e)

get_live_comments

این متد برای دریافت نظرات یک پخش زنده به کار می‌رود.

پارامترها:

  • live_id: شناسه پخش زنده.
  • access_token: توکن دسترسی.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        comments = app.get_live_comments(live_id="live_123", access_token="token_abc")
        print(comments)

    except Exception as e:
        print(e)

get_live_play_url

این متد برای دریافت URL پخش یک لایو به کار می‌رود.

پارامترها:

  • access_token: توکن دسترسی.
  • live_id: شناسه پخش زنده.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        url = app.get_live_play_url(access_token="token_abc", live_id="live_123")
        print(url)

    except Exception as e:
        print(e)

add_live_comment

این متد برای افزودن نظر به یک پخش زنده به کار می‌رود.

پارامترها:

  • access_token: توکن دسترسی.
  • live_id: شناسه پخش زنده.
  • comment: متن نظر.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        result = app.add_live_comment(
            access_token="token_abc",
            live_id="live_123",
            comment="نظر تستی"
        )
        print(result)

    except Exception as e:
        print(e)

متدهای بازخورد

feedback_voice_transcription

این متد برای ارسال بازخورد برای تبدیل صوت به متن به کار می‌رود.

پارامترها:

  • chat: شناسه (GUID)، لینک یا نام‌کاربری چت.
  • message_id: شناسه پیام صوتی.
  • feedback_type: نوع بازخورد. مقادیر قابل قبول: OK یا Incorrect.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    try:
        result = app.feedback_voice_transcription(
            chat="u0abc123...",
            message_id="123456",
            feedback_type="OK"
        )
        print(result)

    except Exception as e:
        print(e)