گروه‌ها

get_group_info

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

پارامتر:

group: شناسه (GUID) یا لینک گروه هدف.

نکته: شناسه گروه باید با g0 شروع شده و ۳۲ کاراکتر باشد.

مثال:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    info = app.get_group_info("https://shad.ir/joing/JGDJDBDJ0SRHELBQEBMZQFTPTKWSHDSD")
    print(info)

get_group_link

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

پارامتر:

group: شناسه (GUID) یا لینک گروه هدف.

مثال:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    link = app.get_group_link("g0G3R19035f77574adc0127ab97c999c")
    print(link)

set_group_link

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

پارامتر:

group: شناسه (GUID) یا لینک گروه هدف.

مثال:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    result = app.set_group_link("g0G3R19035f77574adc0127ab97c999c")
    print(result)

get_group_online_count

این متد برای دریافت تعداد اعضای آنلاین یک گروه به کار می‌رود.

پارامتر:

group: شناسه (GUID) یا لینک گروه هدف.

مثال:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    count = app.get_group_online_count("https://shad.ir/joing/JGDJDBDJ0SRHELBQEBMZQFTPTKWSHDSD")
    print(count)

create_group

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

پارامترها:

title: عنوان گروه. (حداکثر ۶۰ کاراکتر، نمی‌تواند خالی باشد)
members: یک عضو یا لیستی از اعضا (GUID یا نام‌کاربری). حداقل یک عضو الزامی است. فقط کاربران (u0) و بات‌ها (b0) مجاز هستند.
description: متن توضیحات گروه. (حداکثر ۳۰۰ کاراکتر، پیش‌فرض: None)
avatar: تصویر آواتار گروه. مسیر فایل، رشته یا bytes. (پیش‌فرض: None)
thumbnail_avatar: تصویر بندانگشتی آواتار گروه. مسیر فایل، رشته یا bytes. (پیش‌فرض: None)

نکته: تفاوتی ندارد که نام‌کاربری با @ نوشته شود یا بدون آن؛ کتابخانه هر دو حالت را می‌پذیرد.

نکته: اگر فقط avatar داده شود، بندانگشتی از همان تصویر گرفته می‌شود. اگر هیچ‌کدام داده نشود، آواتاری تنظیم نمی‌شود.

مثال:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    result = app.create_group(
        title="گروه تست",
        members=["Online_User", "@ShowInfoBot", "u0HryBf03dbfba68374497983bc850a0"],
        description="این یک گروه تست است.",
        avatar="avatar.jpg"
    )
    print(result)

delete_group

این متد برای حذف یک گروه به کار می‌رود.

پارامترها:

group: شناسه (GUID) یا لینک گروه هدف.
confirm: در صورت True بودن، قبل از حذف از کاربر تأیید گرفته می‌شود (y/n). در صورت False بودن، بدون پرسش حذف می‌شود. (پیش‌فرض: True)

توجه: در حالت confirm=True، برای تکمیل عملیات حذف باید حرف y را در کنسول وارد نمایید.

مثال:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    result = app.delete_group("https://shad.ir/joing/JGDJDBDJ0SRHELBQEBMZQFTPTKWSHDSD")
    print(result)

    # حذف بدون تأیید
    result = app.delete_group("g0CyVlK0cae995e5b46031170a358a4e", confirm=False)
    print(result)

join_group

این متد برای عضویت در یک گروه از طریق لینک دعوت به کار می‌رود.

پارامتر:

group: لینک دعوت گروه. باید با https://shad.ir/joing/ شروع شود.

نکته: این متد فقط لینک دعوت را می‌پذیرد؛ نه GUID و نه نام‌کاربری.

مثال:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    result = app.join_group("https://shad.ir/joing/JGDJDBDJ0SRHELBQEBMZQFTPTKWSHDSD")
    print(result)

leave_group

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

پارامتر:

group: شناسه (GUID) یا لینک گروه هدف.

مثال:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    result = app.leave_group("g0CyVlK0cae995e5b46031170a358a4e")
    print(result)

edit_group_info

این متد برای ویرایش تنظیمات یک گروه به کار می‌رود.

پارامترها:

group: شناسه (GUID) یا لینک گروه هدف.
title: عنوان جدید گروه. (حداکثر ۶۰ کاراکتر)
description: توضیحات جدید گروه. (حداکثر ۳۰۰ کاراکتر)
slow_mode: تنظیم حالت آهسته (محدودیت زمانی بین پیام‌ها).
event_messages: فعال یا غیرفعال کردن پیام‌های رویدادی (ورود/خروج اعضا).
is_restricted_content: محدود کردن محتوا (جلوگیری از اسکرین‌شات و ذخیره فایل).
reactions: تنظیمات ری‌اکشن. مقادیر قابل قبول: All، Disable، یا لیستی از اعداد.
chat_history_for_new_members: نمایش تاریخچه چت برای اعضای جدید. مقادیر: Visible یا Hidden.
restricted_period: محدودیت زمانی برای ارسال پیام. لیستی از دیکشنری‌ها شامل days_of_week، from_time و to_time.

نکته: برای restricted_period قوانین زیر اعمال می‌شود: - روزهای مجاز: Saturday, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday - فرمت زمان: HH:MM (۲۴ ساعته) - بازه‌ها می‌توانند از نیمه‌شب عبور کنند (مثلاً 22:00 تا 04:00)

مثال‌ها:

ویرایش عنوان و توضیحات:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    result = app.edit_group_info(
        group="g0G3R19035f77574adc0127ab97c999c",
        title="گروه جدید",
        description="توضیحات جدید گروه"
    )
    print(result)

تنظیم ری‌اکشن‌های خاص:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    result = app.edit_group_info(
        group="g0G3R19035f77574adc0127ab97c999c",
        reactions=[1, 2, 6, 7, 8, 23, 44]
    )
    print(result)

تنظیم محدودیت زمانی:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    result = app.edit_group_info(
        group="g0G3R19035f77574adc0127ab97c999c",
        restricted_period=[{
            "days_of_week": ["Saturday", "Sunday"],
            "from_time": "00:00",
            "to_time": "06:00"
        }]
    )
    print(result)

edit_group_title

این متد برای ویرایش عنوان یک گروه به کار می‌رود. این متد میانبری برای edit_group_info با پارامتر title است.

پارامترها:

group: شناسه (GUID) یا لینک گروه هدف.
title: عنوان جدید گروه.

مثال:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    result = app.edit_group_title("https://shad.ir/joing/JGDJDBDJ0SRHELBQEBMZQFTPTKWSHDSD", "عنوان جدید")
    print(result)

edit_group_timer

این متد برای تنظیم Slow Mode (حالت آهسته) یک گروه به کار می‌رود. این متد میانبری برای edit_group_info با پارامتر slow_mode است.

پارامترها:

group: شناسه (GUID) یا لینک گروه هدف.
timer: مقدار Slow Mode جدید.

مثال:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    result = app.edit_group_timer("https://shad.ir/joing/JGDJDBDJ0SRHELBQEBMZQFTPTKWSHDSD", "30")
    print(result)

edit_slow_mode

این متد نیز برای تنظیم Slow Mode یک گروه به کار می‌رود و عملکردی مشابه edit_group_timer دارد.

پارامترها:

group: شناسه (GUID) یا لینک گروه هدف.
slow_mode: مقدار Slow Mode جدید.

مثال:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    result = app.edit_slow_mode("https://shad.ir/joing/JGDJDBDJ0SRHELBQEBMZQFTPTKWSHDSD", "60")
    print(result)

get_group_admins

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

پارامترها:

group: شناسه (GUID) یا لینک گروه هدف.
show_admin_guids: در صورت True بودن، شناسه (GUID) ادمین‌ها به صورت جداگانه در خروجی نمایش داده می‌شود. (پیش‌فرض: False)

مثال:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    admins = app.get_group_admins("g0G3R19035f37574adc0127ab97c999c")
    print(admins)

get_group_admin_access

این متد برای دریافت سطح دسترسی‌های یک ادمین خاص در گروه به کار می‌رود.

پارامترها:

group: شناسه (GUID) یا لینک گروه هدف.
admin: شناسه (GUID) یا نام‌کاربری ادمین مورد نظر. فقط کاربران (u0) و بات‌ها (b0) مجاز هستند.

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

مثال:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    access = app.get_group_admin_access("g0G3R19035f77574adc0127ab97c999c", "@Online_User")
    print(access)

get_group_default_access

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

پارامتر:

group: شناسه (GUID) یا لینک گروه هدف.

مثال:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    access = app.get_group_default_access("https://shad.ir/joing/JGDJDBDJ0SRHELBQEBMZQFTPTKWSHDSD")
    print(access)

set_group_default_access

این متد برای تنظیم دسترسی‌های پیش‌فرض اعضای یک گروه به کار می‌رود.

پارامترها:

group: شناسه (GUID) یا لینک گروه هدف.
access: لیستی از دسترسی‌های مجاز. مقادیر قابل قبول:
- ViewMembers: مشاهده اعضا
- ViewAdmins: مشاهده ادمین‌ها
- SendMessages: ارسال پیام
- AddMember: افزودن عضو
- [] (لیست خالی): غیرفعال کردن تمام دسترسی‌ها

مثال‌ها:

فقط اجازه ارسال پیام:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    result = app.set_group_default_access(
        "https://shad.ir/joing/JGDJDBDJ0SRHELBQEBMZQFTPTKWSHDSD",
        ["SendMessages"]
    )
    print(result)

بستن کامل گروه:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    result = app.set_group_default_access(
        "g0G3R19035f77574adc0127ab97c999c",
        []
    )
    print(result)

lock_group

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

پارامتر:

group: شناسه (GUID) یا لینک گروه هدف.

نکته: اگر گروه از قبل قفل باشد، پیام مناسبی بازگردانده می‌شود.

مثال:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    result = app.lock_group("g0G3R19035f77574adc0127ab97c999c")
    print(result)

unlock_group

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

پارامتر:

group: شناسه (GUID) یا لینک گروه هدف.

نکته: اگر گروه از قبل باز باشد، پیام مناسبی بازگردانده می‌شود.

مثال:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    result = app.unlock_group("g0G3R19035f77574adc0127ab97c999c")
    print(result)

get_group_members

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

پارامترها:

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

مثال‌ها:

دریافت اعضای گروه:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    members = app.get_group_members("g0G3R19035f77574adc0127ab97c999c")
    print(members)

جستجوی یک کاربر خاص:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    members = app.get_group_members("g0G3R19035f77574adc0127ab97c999c", search_text="@Online_User")
    print(members)

get_group_mention_list

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

پارامترها:

group: شناسه (GUID) یا لینک گروه هدف.
search_mention: عبارت جستجو برای فیلتر منشن‌ها. (پیش‌فرض: None)

مثال:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    mentions = app.get_group_mention_list("g0G3R19035f77574adc0127ab97c999c")
    print(mentions)

get_unread_mentions

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

پارامترها:

group: شناسه (GUID) یا لینک گروه هدف.
max_id: حداکثر شناسه پیام.
min_id: حداقل شناسه پیام.
sort: ترتیب مرتب‌سازی. (پیش‌فرض: None)

مثال:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    mentions = app.get_unread_mentions(
        "g0G3R19035f77574adc0127ab97c999c",
        max_id="1000",
        min_id="1"
    )
    print(mentions)

get_group_message_read_participants

این متد برای دریافت فهرست اعضایی که یک پیام خاص را در گروه خوانده‌اند به کار می‌رود.

پارامترها:

group: شناسه (GUID) یا لینک گروه هدف.
message_id: شناسه پیام مورد نظر.

مثال:

Python

from maxrubika import Shad

with Shad("mySession") as app:
    participants = app.get_group_message_read_participants(
        "g0G3R19035f77574adc0127ab97c999c",
        message_id="123456"
    )
    print(participants)

بازگشت به صفحه قبل