ユーザー

説明

---

説明

class yaylib.api.UserApi(client)

ユーザー API

async block_user(user_id: int) → Response

ユーザーをブロックする

Args:

user_id (int):

Returns:

Response:

async delete_footprint(user_id: int, footprint_id: int) → Response

足跡を削除する

Args:

user_id (int): footprint_id (int):

Returns:

Response:

async delete_user_avatar() → Response

ユーザーのアイコンを削除する

Returns:

Response:

async delete_user_cover() → Response

ユーザーのカバー画像を削除する

Returns:

Response:

async follow_user(user_id: int) → Response

ユーザーをフォローする

Args:

user_id (int):

Returns:

Response:

async follow_users(user_ids: List[int]) → Response

複数のユーザーをフォローする

Args:

user_ids (List[int]):

Returns:

Response:

async get_active_followings(**params) → ActiveFollowingsResponse

アクティブなフォロー中のユーザーを取得する

Args:

only_online (bool, optional): from_loggedin_at (int, optional):

Returns:

ActiveFollowingsResponse:

async get_blocked_user_ids() → BlockedUserIdsResponse

あなたをブロックしたユーザーを取得する

Returns:

BlockedUserIdsResponse:

async get_blocked_users(**params) → BlockedUsersResponse

ブロックしたユーザーを取得する

Args:

from_id (int, optional):

Returns:

BlockedUsersResponse:

async get_follow_recommendations(**params) → FollowRecommendationsResponse

フォローするのにおすすめのユーザーを取得する

Args:

from_timestamp (int, optional): number (int, optional): sources (List[str], optional):

Returns:

FollowRecommendationsResponse:

async get_follow_request(**params) → UsersByTimestampResponse

フォローリクエストを取得する

Args:

from_timestamp (int, optional):

Returns:

UsersByTimestampResponse:

async get_follow_request_count() → FollowRequestCountResponse

フォローリクエストの数を取得する

Returns:

FollowRequestCountResponse:

async get_following_users_born(**params) → UsersResponse

フォロー中のユーザーの誕生日を取得する

Args:

birthdate (int, optional):

Returns:

UsersResponse:

async get_footprints(**params) → FootprintsResponse

足跡を取得する

Args:

from_id (int, optional): number (int, optional): mode (str, optional):

Returns:

FootprintsResponse:

async get_fresh_user(user_id: int) → UserResponse

認証情報などを含んだユーザー情報を取得する

Args:

user_id (int):

Returns:

UserResponse:

async get_hidden_users_list(**params) → HiddenResponse

非表示のユーザー一覧を取得する

Args:

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

Returns:

HiddenResponse:

async get_hima_users(**params) → HimaUsersResponse

暇なユーザーを取得する

Args:

from_hima_id (int, optional): number (int, optional):

Returns:

HimaUsersResponse:

async get_profile_refresh_counter_requests() → RefreshCounterRequestsResponse

投稿数やフォロワー数をリフレッシュするための残リクエスト数を取得する

Returns:

RefreshCounterRequestsResponse:

async get_social_shared_users(**params) → SocialShareUsersResponse

SNS共有をしたユーザーを取得する

Args:

sns_name (str): number (int, optional): from_id (int, optional):

Returns:

SocialShareUsersResponse:

async get_timestamp() → UserTimestampResponse

タイムスタンプを取得する

Returns:

UserTimestampResponse:

async get_user(user_id: int) → UserResponse

ユーザーの情報を取得する

Args:

user_id (int):

Returns:

UserResponse:

async get_user_followers(user_id: int, **params) → FollowUsersResponse

ユーザーのフォロワーを取得する

Args:

user_id (int): from_follow_id (int, optional): followed_by_me: (int, optional): number: (int, optional):

Returns:

FollowUsersResponse:

async get_user_followings(user_id: int, **params) → FollowUsersResponse

フォロー中のユーザーを取得する

Args:

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

Returns:

FollowUsersResponse:

async get_user_from_qr(qr: str) → UserResponse

QRコードからユーザーを取得する

Args:

qr (str):

Returns:

UserResponse:

async get_user_ranking(mode: str) → RankingUsersResponse

ユーザーのフォロワーランキングを取得する

Examples:

>>> # ルーキーを取得する:
>>> client.get_user_ranking(mode="one_month")

>>> # ミドルを取得する:
>>> client.get_user_ranking(mode="six_months")

>>> # 殿堂入りを取得する:
>>> client.get_user_ranking(mode="all_time")

Args:

mode (str):

Returns:

RankingUsersResponse:

async get_user_without_leaving_footprint(user_id: int) → UserResponse

足跡をつけずにユーザーの情報を取得する

Args:

user_id (int):

Returns:

UserResponse:

async get_users(user_ids: List[int]) → UsersResponse

複数のユーザーの情報を取得する

Args:

user_ids (List[int]):

Returns:

UsersResponse:

async hide_user(user_id: int) → Response

ユーザーを非表示にする

Args:

user_id (int):

Returns:

Response:

async refresh_profile_counter(counter: str) → Response

プロフィールのカウンターを更新する

Args:

counter (str):

Returns:

Response:

async register(**params) → CreateUserResponse

Args:

email (str): email_grant_token (str): password (str): nickname (str): birth_date (str): gender (int, optional): country_code (str, optional): biography (str, optional): prefecture (str, optional): profile_icon_filename (str, optional): cover_image_filename (str, optional): en (int, optional): vn (int, optional):

Returns:

CreateUserResponse:

async reset_password(**params) → Response

パスワードをリセットする

Args:

email (str): email_grant_token (str): password (str):

Returns:

Response:

async search_lobi_users(**params) → UsersResponse

Lobiのユーザーを検索する

Args:

nickname (str, optional): number (int, optional): from_str (str, optional):

Returns:

UsersResponse:

async search_users(**params) → UsersResponse

ユーザーを検索する

Args:

gender (int, optional): nickname (str, optional): title (str, optional): biography (str, optional): from_timestamp (int, optional): similar_age (bool, optional): not_recent_gomimushi (bool, optional): recently_created (bool, optional): same_prefecture (bool, optional): save_recent_search (bool, optional):

Returns:

UsersResponse:

async set_follow_permission_enabled(**params) → Response

フォローを許可制にするかを設定する

Args:

nickname (str): is_private (bool, optional):

Returns:

Response:

async take_action_follow_request(user_id: int, action: str) → Response

フォローリクエストを操作する

Args:

user_id (int): action (str):

Returns:

Response:

async turn_on_hima() → Response

ひまなうを有効にする

Returns:

Response:

async unblock_user(user_id: int) → Response

ユーザーをアンブロックする

Args:

user_id (int):

Returns:

Response:

async unfollow_user(user_id: int) → Response

ユーザーをアンフォローする

Args:

user_id (int):

Returns:

Response:

async unhide_users(user_ids: List[int]) → Response

ユーザーの非表示を解除する

Args:

user_ids (List[int]):

Returns:

Response:

async update_user(nickname: str, **params) → Response

プロフィールを更新する

Args:

nickname (str): biography (str, optional): prefecture (str, optional): gender (int, optional): country_code (str, optional): profile_icon_filename (str, optional): cover_image_filename (str, optional): username (str, optional):

Returns:

Response: