サークル

説明

---

説明

class yaylib.api.GroupApi(client)

サークル API

async accept_group_join_request(group_id: int, user_id: int) → Response

サークル参加リクエストを承認します

Args:

group_id (int): user_id (int):

Returns:

Response:

async accept_moderator_offer(group_id: int) → Response

サークル副管理人の権限オファーを引き受ける

Args:

group_id (int):

Returns:

Response:

async accept_ownership_offer(group_id: int) → Response

サークル管理人の権限オファーを引き受けます

Args:

group_id (int):

Returns:

Response:

async add_related_groups(group_id: int, related_group_id: List[int]) → Response

関連サークルを追加する

Args:

group_id (int): related_group_id (List[int]):

Returns:

Response:

async ban_group_user(group_id: int, user_id: int) → Response

サークルからユーザーを追放する

Args:

group_id (int): user_id (int):

Returns:

Response:

async check_group_unread_status(**params) → UnreadStatusResponse

サークルの未読ステータスを取得する

Args:

from_time (int, optional):

Returns:

UnreadStatusResponse:

async create_group(**params) → CreateGroupResponse

サークルを作成する

Args:

topic (str): description (str, optional): secret (bool, optional): hide_reported_posts (bool, optional): hide_conference_call (bool, optional): is_private (bool, optional): only_verified_age (bool, optional): only_mobile_verified (bool, optional): call_timeline_display (bool, optional): allow_ownership_transfer (bool, optional): allow_thread_creation_by (str, optional): gender (int, optional): generation_groups_limit (int, optional): group_category_id (int, optional): cover_image_filename (str, optional): sub_category_id (str, optional): hide_from_game_eight (bool, optional): allow_members_to_post_media (bool, optional): allow_members_to_post_url (bool, optional): guidelines (str, optional):

Returns:

CreateGroupResponse:

async decline_group_join_request(group_id: int, user_id: int) → Response

サークル参加リクエストを断る

Args:

group_id (int): user_id (int):

Returns:

Response:

async decline_moderator_offer(group_id: int) → Response

サークル副管理人の権限オファーを断る

Args:

group_id (int):

Returns:

Response:

async decline_ownership_offer(group_id: int) → Response

サークル管理人の権限オファーを断る

Args:

group_id (int):

Returns:

Response:

async delete_group_cover(group_id: int) → Response

サークルのカバー画像を削除する

Args:

group_id (int):

Returns:

Response:

async delete_moderator(group_id: int, user_id: int) → Response

サークルの副管理人を削除する

Args:

group_id (int): user_id (int):

Returns:

Response:

async delete_related_groups(group_id: int, related_group_ids: List[int]) → Response

関連のあるサークルを削除する

Args:

group_id (int): related_group_ids (List[int]):

Returns:

Response:

async get_banned_group_members(group_id: int, **params) → UsersResponse

追放されたサークルメンバーを取得する

Args:

group_id (int): page (int, optional):

Returns:

UsersResponse:

async get_create_group_quota() → CreateGroupQuota

残りのサークル作成可能回数を取得する

Returns:

CreateGroupQuota:

async get_group(group_id: int) → GroupResponse

サークルの詳細を取得する

Args:

group_id (int):

Returns:

GroupResponse:

async get_group_categories(**params) → GroupCategoriesResponse

サークルのカテゴリーを取得する

Args:

page (int, optional): number (int, optional):

Returns:

GroupCategoriesResponse:

async get_group_member(group_id: int, user_id: int) → GroupUserResponse

特定のサークルメンバーの情報を取得する

Args:

group_id (int): user_id (int):

Returns:

GroupUserResponse:

async get_group_members(group_id: int, **params) → GroupUsersResponse

サークルメンバーを取得する

Args:

group_id (int): id (int): mode (str, optional): keyword (str, optional): from_id (int, optional): from_timestamp (int, optional): order_by (str, optional): followed_by_me: (bool, optional)

Returns:

GroupUsersResponse:

async get_groups(**params) → GroupsResponse

複数のサークル情報を取得する

Args:

group_category_id (int, optional): keyword (str, optional): from_timestamp (int, optional): sub_category_id (int, optional):

Returns:

GroupsResponse:

async get_invitable_users(group_id: int, **params) → UsersByTimestampResponse

サークルに招待可能なユーザーを取得する

Args:

group_id (int): from_timestamp (int, optional): user[nickname] (str, optional):

Returns:

UsersByTimestampResponse:

async get_joined_statuses(ids: List[int]) → Response

サークルの参加ステータスを取得する

Args:

ids (List[int]):

Returns:

Response:

async get_my_groups(**params) → GroupsResponse

自分のサークルを取得する

Args:

from_timestamp (_type_, optional):

Returns:

GroupsResponse:

async get_relatable_groups(group_id: int, **params) → GroupsRelatedResponse

関連がある可能性があるサークルを取得する

Args:

group_id (int): keyword (str, optional): from (str, optional):

Returns:

GroupsRelatedResponse:

async get_related_groups(group_id: int, **params) → GroupsRelatedResponse

関連があるサークルを取得する

Args:

group_id (int): keyword (str, optional): from (str, optional):

Returns:

GroupsRelatedResponse:

async get_user_groups(**params) → GroupsResponse

特定のユーザーが参加しているサークルを取得する

Args:

user_id (int): page (int, optional):

Returns:

GroupsResponse:

async invite_users_to_group(group_id: int, user_ids: List[int]) → Response

サークルにユーザーを招待する

Args:

group_id (int): user_ids (List[int]):

Returns:

Response:

async join_group(group_id: int) → Response

サークルに参加する

Args:

group_id (int):

Returns:

Response:

async leave_group(group_id: int) → Response

サークルから脱退する

Args:

group_id (int):

Returns:

Response:

async pin_group(group_id: int) → Response

サークルをピン留めする

Args:

group_id (int):

Returns:

Response:

async send_moderator_offers(group_id: int, user_ids: List[int]) → Response

複数人にサークル副管理人のオファーを送信する

Args:

group_id (int): user_ids (List[int]):

Returns:

Response:

async send_ownership_offer(group_id: int, user_id: int) → Response

サークル管理人権限のオファーを送信する

Args:

group_id (int): user_id (int):

Returns:

Response:

async set_group_title(group_id: int, title: str) → Response

サークルのタイトルを設定する

Args:

group_id (int): title (str):

Returns:

Response:

async take_over_group_ownership(group_id: int) → Response

サークル管理人の権限を引き継ぐ

Args:

group_id (int):

Returns:

Response:

async unban_group_member(group_id: int, user_id: int) → Response

特定のサークルメンバーの追放を解除する

Args:

group_id (int): user_id (int):

Returns:

Response:

async unpin_group(group_id: int) → Response

サークルのピン留めを解除する

Args:

group_id (int):

Returns:

Response:

async update_group(group_id: int, **params) → GroupResponse

サークルを編集する

Args:

group_id (int): topic (str): description (str, optional): secret (bool, optional): hide_reported_posts (bool, optional): hide_conference_call (bool, optional): is_private (bool, optional): only_verified_age (bool, optional): only_mobile_verified (bool, optional): call_timeline_display (bool, optional): allow_ownership_transfer (bool, optional): allow_thread_creation_by (str, optional): gender (int, optional): generation_groups_limit (int, optional): group_category_id (int, optional): cover_image_filename (str, optional): sub_category_id (str, optional): hide_from_game_eight (bool, optional): allow_members_to_post_media (bool, optional): allow_members_to_post_url (bool, optional): guidelines (str, optional):

Returns:

GroupResponse:

async withdraw_moderator_offer(group_id: int, user_id: int) → Response

サークル副管理人のオファーを取り消す

Args:

group_id (int): user_id (int):

Returns:

Response:

async withdraw_ownership_offer(group_id: int, user_id: int) → Response

サークル管理人のオファーを取り消す

Args:

group_id (int): user_id (int):

Returns:

Response: