投稿

説明

---

説明

class yaylib.api.PostApi(client)

投稿 API

async add_bookmark(user_id: int, post_id: int) → BookmarkPostResponse

ブックマークに追加する

Args:

user_id (int): post_id (int):

Returns:

BookmarkPostResponse:

async add_group_highlight_post(group_id: int, post_id: int) → Response

投稿をグループのまとめに追加する

Args:

group_id (int): post_id (int):

Returns:

Response:

async create_call_post(text: str = None, **params) → CreatePostResponse

通話の投稿を作成する

Args:

text (str, optional): font_size (int, optional): color (int, optional): group_id (int, optional): call_type (str, optional): category_id (int, optional): game_title (str, optional): joinable_by (str, optional): message_tags (List, optional): attachment_filename (str, optional): attachment_2_filename (str, optional): attachment_3_filename (str, optional): attachment_4_filename (str, optional): attachment_5_filename (str, optional): attachment_6_filename (str, optional): attachment_7_filename (str, optional): attachment_8_filename (str, optional): attachment_9_filename (str, optional):

Returns:

CreatePostResponse:

async create_post(text: str = None, **params) → Post

投稿を作成する

Args:

text (str, optional): font_size (int, optional): . Defaults to 0. color (int, optional): . Defaults to 0. in_reply_to (int, optional): group_id (int, optional): mention_ids (List[int], optional): choices (List[str], optional): shared_url (str, optional): message_tags (List, optional): attachment_filename (str, optional): attachment_2_filename (str, optional): attachment_3_filename (str, optional): attachment_4_filename (str, optional): attachment_5_filename (str, optional): attachment_6_filename (str, optional): attachment_7_filename (str, optional): attachment_8_filename (str, optional): attachment_9_filename (str, optional): video_file_name (str, optional):

Returns:

Post:

async create_repost(post_id: int, text: str = None, **params) → CreatePostResponse

投稿を(´∀｀∩)↑age↑する

Args:

post_id (int): text (str, optional): font_size (int, optional): color (int, optional): in_reply_to (int, optional): group_id (int, optional): mention_ids (List[int], optional): choices (List[str], optional): shared_url (Dict[str, str | int], optional): message_tags (List, optional): attachment_filename (str, optional): attachment_2_filename (str, optional): attachment_3_filename (str, optional): attachment_4_filename (str, optional): attachment_5_filename (str, optional): attachment_6_filename (str, optional): attachment_7_filename (str, optional): attachment_8_filename (str, optional): attachment_9_filename (str, optional): video_file_name (str, optional):

Returns:

CreatePostResponse:

async create_share_post(shareable_type: str, shareable_id: int, text: str = None, **params) → Post

シェア投稿を作成する

Args:

shareable_type (str): shareable_id (int): text (str, optional): font_size (int, optional): color (int, optional): group_id (int, optional):

Returns:

Post:

async create_thread_post(thread_id: int, text: str = None, **params) → Post

スレッドの投稿を作成する

Args:

thread_id (int): text (str, optional): font_size (int, optional): color (int, optional): in_reply_to (int, optional): group_id (int, optional): mention_ids (List[int], optional): choices (list[str], optional): shared_url (Dict[str, str | int], optional): message_tags (List, optional): attachment_filename (str, optional): attachment_2_filename (str, optional): attachment_3_filename (str, optional): attachment_4_filename (str, optional): attachment_5_filename (str, optional): attachment_6_filename (str, optional): attachment_7_filename (str, optional): attachment_8_filename (str, optional): attachment_9_filename (str, optional): video_file_name (str, optional):

Returns:

Post:

async delete_all_posts() → Response

すべての自分の投稿を削除する

Returns:

Response:

async delete_bookmark(user_id: int, post_id: int) → Response

ブックマークを削除する

Args:

user_id (int): post_id (int):

Returns:

Response:

async delete_group_highlight_post(group_id: int, post_id: int) → Response

サークルのまとめから投稿を解除する

Args:

group_id (int): post_id (int):

Returns:

Response:

async delete_posts(post_ids: List[int]) → Response

投稿を削除する

Args:

post_ids (List[int]):

Returns:

Response:

async get_bookmark(user_id: int, **params) → PostsResponse

ブックマークを取得する

Args:

user_id (int): from_str (str, optional):

Returns:

PostsResponse:

async get_conversation(conversation_id: int, **params) → PostsResponse

リプライを含める投稿の会話を取得する

Args:

conversation_id (int): group_id (int, optional): thread_id (int, optional): from_post_id (int, optional): number (int, optional): reverse (bool, optional):

Returns:

PostsResponse:

async get_conversation_root_posts(post_ids: List[int]) → PostsResponse

会話の原点の投稿を取得する

Args:

post_ids (List[int]):

Returns:

PostsResponse:

async get_following_call_timeline(**params) → PostsResponse

フォロー中の通話を取得する

Args:

from_timestamp (int, optional): number (int, optional): category_id (int, optional): include_circle_call (bool, optional): exclude_recent_gomimushi (bool, optional):

Returns:

PostsResponse:

async get_following_timeline(**params) → PostsResponse

フォロー中のタイムラインを取得する

Args:

from_str (str, optional): only_root (bool, optional): order_by (str, optional): number (int, optional): mxn (int, optional): reduce_selfie (bool, optional): custom_generation_range (bool, optional):

Returns:

PostsResponse:

async get_group_highlight_posts(group_id: int, **params) → PostsResponse

グループのまとめ投稿を取得する

Args:

group_id (int): from_post (int, optional): number (int, optional):

Returns:

PostsResponse:

async get_group_timeline(group_id: int, **params) → PostsResponse

グループのタイムラインを取得する

Args:

group_id (int): from_post_id (int, optional): reverse (bool, optional): post_type (str, optional): number (int, optional): only_root (bool, optional):

Returns:

PostsResponse:

async get_group_timeline_by_keyword(group_id: int, keyword: str, **params) → PostsResponse

グループの投稿をキーワードで検索する

Args:

group_id (int): keyword (str): from_post_id (int, optional): number (int, optional): only_thread_posts (bool, optional):

Returns:

PostsResponse:

async get_my_posts(**params) → PostsResponse

自分の投稿を取得する

Args:

from_post_id (int, optional): number (int, optional): include_group_post (bool, optional):

Returns:

PostsResponse:

async get_post(post_id: int) → PostResponse

投稿の詳細を取得する

Args:

post_id (int):

Returns:

PostResponse:

async get_post_likers(post_id: int, **params) → PostLikersResponse

投稿にいいねしたユーザーを取得する

Args:

post_id (int): from_id (int, optional): number (int, optional):

Returns:

PostLikersResponse:

async get_posts(post_ids: List[int]) → PostsResponse

複数の投稿を取得する

Args:

post_ids (List[int]):

Returns:

PostsResponse:

async get_recommended_post_tags(**params) → PostTagsResponse

おすすめのタグ候補を取得する

Args:

tag (str, optional): save_recent_search (bool, optional):

Returns:

PostTagsResponse:

async get_recommended_posts(**params) → PostsResponse

おすすめの投稿を取得する

Args:

experiment_num (int): variant_num (int, optional): number (int, optional):

Returns:

PostsResponse:

async get_reposts(post_id: int, **params: int) → PostsResponse

投稿の(´∀｀∩)↑age↑を取得する

Args:

post_id (int): from_post_id (int, optional): number (int, optional):

Returns:

PostsResponse:

async get_timeline(**params) → PostsResponse

タイムラインを取得する

Args:

noreply_mode (bool, optional): from_post_id (int, optional): number (int, optional): order_by (str, optional): experiment_older_age_rules (bool, optional): shared_interest_categories (bool, optional): mxn (int, optional): en (int, optional): vn (int, optional): reduce_selfie (bool, optional): custom_generation_range (bool, optional):

Returns:

PostsResponse:

async get_timeline_by_hashtag(hashtag: str, **params) → PostsResponse

ハッシュタグでタイムラインを検索する

Args:

hashtag (str): from_post_id (int, optional): number (int, optional):

Returns:

PostsResponse:

async get_timeline_by_keyword(keyword: str = None, **params) → PostsResponse

キーワードでタイムラインを検索する

Args:

keyword (str, optional): from_post_id (int, optional): number (int, optional):

Returns:

PostsResponse:

async get_timeline_calls(**params) → PostsResponse

誰でも通話を取得する

Args:

group_id (int, optional): from_timestamp (int, optional): number (int, optional): category_id (int, optional): call_type (str, optional): Defaults to "voice". include_circle_call (bool, optional): cross_generation (bool, optional): exclude_recent_gomimushi (bool, optional): shared_interest_categories (bool, optional):

Returns:

PostsResponse:

async get_url_metadata(url: str) → SharedUrl

URLのメタデータを取得する

Args:

url (str):

Returns:

SharedUrl:

async get_user_timeline(user_id: int, **params) → PostsResponse

ユーザーのタイムラインを取得する

Args:

user_id (int): from_post_id (int, optional): number (int, optional): post_type (str, optional):

Returns:

PostsResponse:

async like(post_ids: List[int]) → LikePostsResponse

投稿にいいねする

Args:

post_ids (List[int]):

Returns:

LikePostsResponse:

async pin_group_post(post_id: int, group_id: int) → Response

サークルの投稿をピン留めする

Args:

post_id (int): group_id (int):

Returns:

Response:

async pin_post(post_id: int) → Response

プロフィールに投稿をピン留めする

Args:

post_id (int):

Returns:

Response:

async unlike(post_id: int) → Response

いいねを解除する

Args:

post_id (int):

Returns:

Response:

async unpin_group_post(group_id: int) → Response

グループのピン投稿を解除する

Args:

group_id (int):

Returns:

Response:

async unpin_post(post_id: int) → Response

プロフィール投稿のピンを解除する

Args:

post_id (int):

Returns:

Response:

async update_post(post_id: int, text: str = None, **params) → Post

投稿を編集する

Args:

post_id (int): text (str, optional): font_size (int, optional): color (int, optional): message_tags (List, optional):

Returns:

Post:

async view_video(video_id: int) → Response

動画を視聴する

Args:

video_id (int):

Returns:

Response:

async vote_survey(survey_id: int, choice_id: int) → VoteSurveyResponse

アンケートに投票する

Args:

survey_id (int): choice_id (int):

Returns:

VoteSurveyResponse: