\MeApi

All URIs are relative to https://q.trap.jp/api/v3

Method	HTTP request	Description
add_my_star	POST /users/me/stars	チャンネルをスターに追加
add_my_user_tag	POST /users/me/tags	自分にタグを追加
change_my_icon	PUT /users/me/icon	自分のアイコン画像を変更
change_my_notify_citation	PUT /users/me/settings/notify-citation	メッセージ引用通知の設定情報を変更
change_my_password	PUT /users/me/password	自分のパスワードを変更
edit_me	PATCH /users/me	自分のユーザー情報を変更
edit_my_user_tag	PATCH /users/me/tags/{tagId}	自分のタグを編集
get_me	GET /users/me	自分のユーザー詳細を取得
get_my_channel_subscriptions	GET /users/me/subscriptions	自分のチャンネル購読状態を取得
get_my_external_accounts	GET /users/me/ex-accounts	外部ログインアカウント一覧を取得
get_my_icon	GET /users/me/icon	自分のアイコン画像を取得
get_my_notify_citation	GET /users/me/settings/notify-citation	メッセージ引用通知の設定情報を取得
get_my_qr_code	GET /users/me/qr-code	QRコードを取得
get_my_sessions	GET /users/me/sessions	自分のログインセッションリストを取得
get_my_stamp_history	GET /users/me/stamp-history	スタンプ履歴を取得
get_my_stars	GET /users/me/stars	スターチャンネルリストを取得
get_my_tokens	GET /users/me/tokens	有効トークンのリストを取得
get_my_unread_channels	GET /users/me/unread	未読チャンネルを取得
get_my_user_tags	GET /users/me/tags	自分のタグリストを取得
get_my_view_states	GET /users/me/view-states	自身のチャンネル閲覧状態一覧を取得
get_oidc_user_info	GET /users/me/oidc	自分のユーザー詳細を取得 (OIDC UserInfo)
get_user_settings	GET /users/me/settings	ユーザー設定を取得
link_external_account	POST /users/me/ex-accounts/link	外部ログインアカウントを紐付ける
read_channel	DELETE /users/me/unread/{channelId}	チャンネルを既読にする
register_fcm_device	POST /users/me/fcm-device	FCMデバイスを登録
remove_my_star	DELETE /users/me/stars/{channelId}	チャンネルをスターから削除します
remove_my_user_tag	DELETE /users/me/tags/{tagId}	自分からタグを削除します
revoke_my_session	DELETE /users/me/sessions/{sessionId}	セッションを無効化
revoke_my_token	DELETE /users/me/tokens/{tokenId}	トークンの認可を取り消す
set_channel_subscribe_level	PUT /users/me/subscriptions/{channelId}	チャンネル購読レベルを設定
unlink_external_account	POST /users/me/ex-accounts/unlink	外部ログインアカウントの紐付けを解除

add_my_star

add_my_star(post_star_request) チャンネルをスターに追加

指定したチャンネルをスターチャンネルに追加します。スター済みのチャンネルIDを指定した場合、204を返します。不正なチャンネルIDを指定した場合、400を返します。

Parameters

Name	Type	Description	Required	Notes
post_star_request	Option<PostStarRequest>

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

add_my_user_tag

crate::models::UserTag add_my_user_tag(post_user_tag_request) 自分にタグを追加

自分に新しくタグを追加します。

Parameters

Name	Type	Description	Required	Notes
post_user_tag_request	Option<PostUserTagRequest>

Return type

crate::models::UserTag

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

change_my_icon

change_my_icon(file) 自分のアイコン画像を変更

自分のアイコン画像を変更します。

Parameters

Name	Type	Description	Required	Notes
file	std::path::PathBuf	アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif)	[required]

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: multipart/form-data
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

change_my_notify_citation

change_my_notify_citation(put_notify_citation_request) メッセージ引用通知の設定情報を変更

メッセージ引用通知の設定情報を変更します

Parameters

Name	Type	Description	Required	Notes
put_notify_citation_request	Option<PutNotifyCitationRequest>

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

change_my_password

change_my_password(put_my_password_request) 自分のパスワードを変更

自身のパスワードを変更します。

Parameters

Name	Type	Description	Required	Notes
put_my_password_request	Option<PutMyPasswordRequest>

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_me

edit_me(patch_me_request) 自分のユーザー情報を変更

自身のユーザー情報を変更します。

Parameters

Name	Type	Description	Required	Notes
patch_me_request	Option<PatchMeRequest>

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_my_user_tag

edit_my_user_tag(tag_id, patch_user_tag_request) 自分のタグを編集

自分の指定したタグの状態を変更します。

Parameters

Name	Type	Description	Required	Notes
tag_id	uuid::Uuid	タグUUID	[required]
patch_user_tag_request	Option<PatchUserTagRequest>

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_me

crate::models::MyUserDetail get_me() 自分のユーザー詳細を取得

自身のユーザー詳細情報を取得します。

Parameters

This endpoint does not need any parameter.

Return type

crate::models::MyUserDetail

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_my_channel_subscriptions

Veccrate::models::UserSubscribeState get_my_channel_subscriptions() 自分のチャンネル購読状態を取得

自身のチャンネル購読状態を取得します。

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::UserSubscribeState

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_my_external_accounts

Veccrate::models::ExternalProviderUser get_my_external_accounts() 外部ログインアカウント一覧を取得

自分に紐付けられている外部ログインアカウント一覧を取得します。

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::ExternalProviderUser

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_my_icon

std::path::PathBuf get_my_icon() 自分のアイコン画像を取得

自分のアイコン画像を取得します。

Parameters

This endpoint does not need any parameter.

Return type

std::path::PathBuf

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: image/jpeg, image/gif, image/png

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_my_notify_citation

crate::models::GetNotifyCitation get_my_notify_citation() メッセージ引用通知の設定情報を取得

メッセージ引用通知の設定情報を変更します。

Parameters

This endpoint does not need any parameter.

Return type

crate::models::GetNotifyCitation

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_my_qr_code

std::path::PathBuf get_my_qr_code(token) QRコードを取得

自身のQRコードを取得します。返されたQRコードまたはトークンは、発行後の5分間のみ有効です

Parameters

Name	Type	Description	Required	Notes
token	Option<bool>	画像でなくトークン文字列で返すかどうか		[default to false]

Return type

std::path::PathBuf

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: image/png, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_my_sessions

Veccrate::models::LoginSession get_my_sessions() 自分のログインセッションリストを取得

自分のログインセッションのリストを取得します。

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::LoginSession

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_my_stamp_history

Veccrate::models::StampHistoryEntry get_my_stamp_history(limit) スタンプ履歴を取得

自分のスタンプ履歴を最大100件まで取得します。結果は降順で返されます。このAPIが返すスタンプ履歴は厳密な履歴ではありません。

Parameters

Name	Type	Description	Required	Notes
limit	Option<i32>	件数		[default to 100]

Return type

Veccrate::models::StampHistoryEntry

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_my_stars

Vecuuid::Uuid get_my_stars() スターチャンネルリストを取得

自分がスターしているチャンネルのUUIDの配列を取得します。

Parameters

This endpoint does not need any parameter.

Return type

Vecuuid::Uuid

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_my_tokens

Veccrate::models::ActiveOAuth2Token get_my_tokens() 有効トークンのリストを取得

有効な自分に発行されたOAuth2トークンのリストを取得します。

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::ActiveOAuth2Token

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_my_unread_channels

Veccrate::models::UnreadChannel get_my_unread_channels() 未読チャンネルを取得

自分が現在未読のチャンネルの未読情報を取得します。

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::UnreadChannel

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_my_user_tags

Veccrate::models::UserTag get_my_user_tags() 自分のタグリストを取得

自分に付けられているタグの配列を取得します。

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::UserTag

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_my_view_states

Veccrate::models::MyChannelViewState get_my_view_states() 自身のチャンネル閲覧状態一覧を取得

自身のチャンネル閲覧状態一覧を取得します。

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::MyChannelViewState

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_oidc_user_info

crate::models::OidcUserInfo get_oidc_user_info() 自分のユーザー詳細を取得 (OIDC UserInfo)

OIDCトークンを用いてユーザー詳細を取得します。 OIDC UserInfo Endpointです。

Parameters

This endpoint does not need any parameter.

Return type

crate::models::OidcUserInfo

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_user_settings

crate::models::UserSettings get_user_settings() ユーザー設定を取得

ユーザー設定を取得します。

Parameters

This endpoint does not need any parameter.

Return type

crate::models::UserSettings

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

link_external_account

link_external_account(post_link_external_account) 外部ログインアカウントを紐付ける

自分に外部ログインアカウントを紐付けます。指定したproviderNameがサーバー側で有効である必要があります。リクエストが受理された場合、外部サービスの認証画面にリダイレクトされ、認証される必要があります。

Parameters

Name	Type	Description	Required	Notes
post_link_external_account	Option<PostLinkExternalAccount>

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read_channel

read_channel(channel_id) チャンネルを既読にする

自分が未読のチャンネルを既読にします。

Parameters

Name	Type	Description	Required	Notes
channel_id	uuid::Uuid	チャンネルUUID	[required]

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

register_fcm_device

register_fcm_device(post_my_fcm_device_request) FCMデバイスを登録

自身のFCMデバイスを登録します。

Parameters

Name	Type	Description	Required	Notes
post_my_fcm_device_request	Option<PostMyFcmDeviceRequest>

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_my_star

remove_my_star(channel_id) チャンネルをスターから削除します

既にスターから削除されているチャンネルを指定した場合は204を返します。

Parameters

Name	Type	Description	Required	Notes
channel_id	uuid::Uuid	チャンネルUUID	[required]

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_my_user_tag

remove_my_user_tag(tag_id) 自分からタグを削除します

既に存在しないタグを削除しようとした場合は204を返します。

Parameters

Name	Type	Description	Required	Notes
tag_id	uuid::Uuid	タグUUID	[required]

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

revoke_my_session

revoke_my_session(session_id) セッションを無効化

指定した自分のセッションを無効化(ログアウト)します。既に存在しない・無効化されているセッションを指定した場合も204を返します。

Parameters

Name	Type	Description	Required	Notes
session_id	uuid::Uuid	セッションUUID	[required]

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

revoke_my_token

revoke_my_token(token_id) トークンの認可を取り消す

自分の指定したトークンの認可を取り消します。

Parameters

Name	Type	Description	Required	Notes
token_id	uuid::Uuid	OAuth2トークンUUID	[required]

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_channel_subscribe_level

set_channel_subscribe_level(channel_id, put_channel_subscribe_level_request) チャンネル購読レベルを設定

自身の指定したチャンネルの購読レベルを設定します。

Parameters

Name	Type	Description	Required	Notes
channel_id	uuid::Uuid	チャンネルUUID	[required]
put_channel_subscribe_level_request	Option<PutChannelSubscribeLevelRequest>

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unlink_external_account

unlink_external_account(post_unlink_external_account) 外部ログインアカウントの紐付けを解除

自分に紐付けられている外部ログインアカウントの紐付けを解除します。

Parameters

Name	Type	Description	Required	Notes
post_unlink_external_account	Option<PostUnlinkExternalAccount>

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

MeApi.md

Latest commit

History

MeApi.md

File metadata and controls

\MeApi

add_my_star

Parameters

Return type

Authorization

HTTP request headers

add_my_user_tag

Parameters

Return type

Authorization

HTTP request headers

change_my_icon

Parameters

Return type

Authorization

HTTP request headers

change_my_notify_citation

Parameters

Return type

Authorization

HTTP request headers

change_my_password

Parameters

Return type

Authorization

HTTP request headers

edit_me

Parameters

Return type

Authorization

HTTP request headers

edit_my_user_tag

Parameters

Return type

Authorization

HTTP request headers

get_me

Parameters

Return type

Authorization

HTTP request headers

get_my_channel_subscriptions

Parameters

Return type

Authorization

HTTP request headers

get_my_external_accounts

Parameters

Return type

Authorization

HTTP request headers

get_my_icon

Parameters

Return type

Authorization

HTTP request headers

get_my_notify_citation

Parameters

Return type

Authorization

HTTP request headers

get_my_qr_code

Parameters

Return type

Authorization

HTTP request headers

get_my_sessions

Parameters

Return type

Authorization

HTTP request headers

get_my_stamp_history

Parameters

Return type