チャット

説明

---

説明

class yaylib.api.ChatApi(client)

チャット API

async accept_chat_requests(**params) → Response

チャットリクエストを承認する

Args:

chat_room_ids (List[int]):

Returns:

Response:

async check_unread_status(**params) → UnreadStatusResponse

チャットの未読ステータスを確認する

Args:

from_time (int):

Returns:

UnreadStatusResponse:

async create_group_chat(**params) → CreateChatRoomResponse

グループチャットを作成する

Args:

name (str): with_user_ids (List[int]): icon_filename (str, optional): background_filename (str, optional):

Returns:

CreateChatRoomResponse:

async create_private_chat(**params) → CreateChatRoomResponse

個人チャットを作成する

Args:

with_user_id (int): matching_id (int, optional): hima_chat (bool, optional):

Returns:

CreateChatRoomResponse:

async delete_chat_background(room_id: int) → Response

チャットの背景を削除する

Args:

room_id (int):

Returns:

Response:

async delete_chat_rooms(**params) → Response

チャットルームを削除する

Args:

chat_room_ids (List[int]):

Returns:

Response:

async delete_message(room_id: int, message_id: int) → Response

チャットメッセージを削除する

Args:

room_id (int): message_id (int):

Returns:

Response:

async edit_chat_room(chat_room_id: int, **params) → Response

チャットルームを編集する

Args:

chat_room_id (int): name (str): icon_filename (str, optional): background_filename (str, optional):

Returns:

Response:

async get_chat_requests(**params) → ChatRoomsResponse

チャットリクエストを取得する

Args:

number (int, optional): from_timestamp (int, optional):

Returns:

ChatRoomsResponse:

async get_chat_room(chat_room_id: int) → ChatRoomResponse

チャットルームを取得する

Args:

chat_room_id (int):

Returns:

ChatRoomResponse:

async get_chatable_users(**params) → FollowUsersResponse

チャット可能なユーザーを取得する

Args:

from_follow_id (int, optional): from_timestamp (int, optional): order_by (str, optional):

Returns:

FollowUsersResponse:

async get_gifs_data() → GifsDataResponse

チャット用 GIF データを取得する

Returns:

GifsDataResponse:

async get_hidden_chat_rooms(**params) → ChatRoomsResponse

非表示に設定したチャットルームを取得する

Args:

from_timestamp (int, optional): number (int, optional)

Returns:

ChatRoomsResponse:

async get_main_chat_rooms(**params) → ChatRoomsResponse

メインのチャットルームを取得する

Args:

from_timestamp (int, optional):

Returns:

ChatRoomsResponse:

async get_messages(chat_room_id: int, **params) → MessagesResponse

メッセージを取得する

Args:

from_message_id (int, optional): to_message_id (int, optional):

Returns:

MessagesResponse:

async get_sticker_packs() → StickerPacksResponse

チャット用のスタンプを取得する

Returns:

StickerPacksResponse:

async get_total_chat_requests() → TotalChatRequestResponse

チャットリクエストの総数を取得する

Returns:

TotalChatRequestResponse:

async hide_chat(chat_room_id: int) → Response

チャットルームを非表示にする

Args:

chat_room_id (int):

Returns:

Response:

async invite_to_chat(chat_room_id: int, **params) → Response

チャットルームにユーザーを招待する

Args:

chat_room_id (int): with_user_ids (List[int]):

Returns:

Response:

async kick_users_from_chat(chat_room_id: int, **params) → Response

チャットルームからユーザーを追放する

Args:

chat_room_id (int): with_user_ids (List[int]):

Returns:

Response:

async pin_chat(room_id: int) → Response

チャットルームをピン留めする

Args:

room_id (int):

Returns:

Response:

async read_message(chat_room_id: int, message_id: int) → Response

メッセージを既読にする

Args:

chat_room_id (int): message_id (int):

Returns:

Response:

async refresh_chat_rooms(**params) → ChatRoomsResponse

チャットルームを更新する

Args:

from_time (int, optional):

Returns:

ChatRoomsResponse:

async send_message(chat_room_id: int, **params) → MessageResponse

チャットを送信する

Args:

chat_room_id (int):

Returns:

MessageResponse:

async unhide_chat(**params) → Response

非表示に設定したチャットルームを表示する

Args:

chat_room_ids (int):

Returns:

Response:

async unpin_chat(chat_room_id: int) → Response

チャットのピン留めを解除する

Args:

chat_room_id (int):

Returns:

Response: