チャット¶
説明
説明
- 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:
非表示に設定したチャットルームを取得する
- 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 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: