UsersClient

ユーザー操作用の Client

この Client は、X API の users エンドポイントとやり取りするためのメソッドを提供します。認証、リクエストのフォーマット、レスポンスの解析など、ユーザー関連のすべての操作を処理します。

​

コンストラクタ

​

constructor

• new UsersClient(client): UsersClient

新しい Users クライアントのインスタンスを生成します

​

パラメーター

Name	Type	Description
client	Client	X API のメイン Client インスタンス

​

戻り値

UsersClient

​

定義場所

users/client.ts:1234

​

メソッド

​

getByUsernames

▸ getByUsernames(usernames, options): Promise<Response>

ユーザー名からユーザーを取得する
複数のユーザーの詳細をユーザー名で取得します。

​

パラメーター

Name	Type	Description
usernames	any[]	カンマ区切りのユーザー名のリスト。
options	GetByUsernamesOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンスを返す Promise。requestOptions.raw が true の場合は、生の Response。

​

定義場所

users/client.ts:1279

▸ getByUsernames(usernames, options?): Promise<Get2UsersByResponse>

​

パラメーター

名前	型
usernames	any[]
options?	GetByUsernamesOptions

​

戻り値

Promise<Get2UsersByResponse>

​

定義場所

users/client.ts:1292

---

​

getRepostsOfMe

▸ getRepostsOfMe(options): Promise<Response>

自分のポストがリポストされた投稿を取得
認証済みユーザーのポストをリポストしている投稿の一覧を取得します。

​

パラメーター

名前	型
options	GetRepostsOfMeOptions & { requestOptions: { raw: true } }

​

戻り値

Promise<Response>

API レスポンスで解決される Promise。requestOptions.raw が true の場合は生の Response を返します

​

定義元

users/client.ts:1471

▸ getRepostsOfMe(options?): Promise<Get2UsersRepostsOfMeResponse>

​

パラメータ

名前	型
options?	GetRepostsOfMeOptions

​

戻り値

Promise<Get2UsersRepostsOfMeResponse>

​

定義場所

users/client.ts:1480

---

​

unlikePost

▸ unlikePost(id, tweetId, options): Promise<Response>

ポストのいいねを取り消す
認証済みユーザーが、指定されたIDのポストに対するいいねを取り消します。

​

パラメーター

Name	Type	Description
id	string	いいねの取り消しをリクエストしている、認証済みの発信元ユーザーのID。
tweetId	string	ユーザーがいいねを取り消そうとしているポストのID。
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

戻り値

Promise<Response>

API レスポンス、または requestOptions.raw が true の場合は生の Response に解決される Promise

​

定義元

users/client.ts:1741

▸ unlikePost(id, tweetId): Promise<UsersLikesDeleteResponse>

​

パラメーター

名前	型
id	string
tweetId	string

​

戻り値

Promise<UsersLikesDeleteResponse>

​

定義場所

users/client.ts:1758

---

​

getBookmarks

▸ getBookmarks(id, options): Promise<Response>

ブックマークを取得
認証済みユーザーがブックマークに追加した投稿の一覧を取得します。

​

パラメーター

Name	Type	Description
id	string	結果を返す対象となる認証済みソースユーザーの ID。
options	GetBookmarksOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンス、または requestOptions.raw が true の場合は生の Response で解決される Promise

​

定義場所

users/client.ts:1861

▸ getBookmarks(id, options?): Promise<Get2UsersIdBookmarksResponse>

​

パラメータ

名前	型
id	string
options?	GetBookmarksOptions

​

戻り値

Promise<Get2UsersIdBookmarksResponse>

​

定義箇所

users/client.ts:1874

---

​

createBookmark

▸ createBookmark(id, body, options): Promise<Response>

ブックマークを作成 認証済みのユーザーのブックマークにポストを追加します。

​

パラメーター

Name	Type	Description
id	string	ブックマークを追加する対象となる、認証済みソースユーザーのID
body	BookmarkAddRequest	リクエストボディ
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

返り値

Promise<Response>

API レスポンスで解決される Promise。requestOptions.raw が true の場合は生の Response。

​

定義場所

users/client.ts:2139

▸ createBookmark(id, body): Promise<BookmarkMutationResponse>

​

パラメータ

名前	型
id	string
body	BookmarkAddRequest

​

戻り値

Promise<BookmarkMutationResponse>

​

定義場所

users/client.ts:2154

---

​

getFollowers

▸ getFollowers(id, options): Promise<Response>

フォロワーの取得
特定のユーザーの id を指定して、そのユーザーのフォロワーの一覧を取得します。

​

パラメーター

Name	Type	Description
id	string	取得するユーザーのID。
options	GetFollowersOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンスに解決される Promise。requestOptions.raw が true の場合は、生の Response に解決される

​

定義場所

users/client.ts:2245

▸ getFollowers(id, options?): Promise<Get2UsersIdFollowersResponse>

​

パラメータ

名前	型
id	string
options?	GetFollowersOptions

​

戻り値

Promise<Get2UsersIdFollowersResponse>

​

定義場所

users/client.ts:2258

---

​

unpinList

▸ unpinList(id, listId, options): Promise<Response>

リストのピン留めを解除する
認証されたユーザーが、指定したIDのリストのピン留めを解除します。

​

パラメータ

Name	Type	Description
id	string	結果を返す対象となる認証済みソースユーザーのID。
listId	string	ピン留めを解除するリストのID。
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

返り値

Promise<Response>

API レスポンスで解決される Promise。requestOptions.raw が true の場合は生の Response

​

定義元

users/client.ts:2474

▸ unpinList(id, listId): Promise<ListUnpinResponse>

​

パラメーター

名前	型
id	string
listId	string

​

戻り値

Promise<ListUnpinResponse>

​

定義元

users/client.ts:2491

---

​

getById

▸ getById(id, options): Promise<Response>

ID で User を取得します
指定した User の詳細情報を、その id を用いて取得します。

​

パラメーター

Name	Type	Description
id	string	取得対象のユーザーのID。
options	GetByIdOptions & { requestOptions: { raw: true } }	-

​

返り値

Promise<Response>

API レスポンスで解決される Promise。requestOptions.raw が true の場合は生の Response

​

定義場所

users/client.ts:2594

▸ getById(id, options?): Promise<Get2UsersIdResponse>

​

パラメータ

名前	型
id	string
options?	GetByIdOptions

​

戻り値

Promise<Get2UsersIdResponse>

​

定義元

users/client.ts:2607

---

​

getMentions

▸ getMentions(id, options): Promise<Response>

メンションを取得します 特定のユーザー ID を指定して、そのユーザーがメンションされている投稿の一覧を取得します。

​

パラメーター

Name	Type	Description
id	string	取得するユーザーのID。
options	GetMentionsOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンスを返す Promise。requestOptions.raw が true の場合は生の Response

​

定義場所

users/client.ts:2781

▸ getMentions(id, options?): Promise<Get2UsersIdMentionsResponse>

​

パラメーター

名前	型
id	string
options?	GetMentionsOptions

​

戻り値

Promise<Get2UsersIdMentionsResponse>

​

定義場所

users/client.ts:2794

---

​

unrepostPost

▸ unrepostPost(id, sourceTweetId, options): Promise<Response>

ポストのリポストを取り消す
認証済みユーザーが、指定した ID のポストのリポストを取り消します。

​

Parameters

Name	Type	Description
id	string	ポストのリポストを要求している認証済みの発信元ユーザーのID。
sourceTweetId	string	ユーザーがリポストの取り消しを要求しているポストのID。
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

戻り値

Promise<Response>

API レスポンス、または requestOptions.raw が true の場合は生の Response で解決される Promise

​

定義元

users/client.ts:3149

▸ unrepostPost(id, sourceTweetId): Promise<UsersRetweetsDeleteResponse>

​

パラメータ

名前	型
id	string
sourceTweetId	string

​

戻り値

Promise<UsersRetweetsDeleteResponse>

​

定義箇所

users/client.ts:3166

---

​

deleteBookmark

▸ deleteBookmark(id, tweetId, options): Promise<Response>

ブックマークを削除 認証済みユーザーのブックマークから、IDで指定したポストを削除します。

​

パラメーター

Name	Type	Description
id	string	ブックマークを削除する認証済みソースユーザーのID。
tweetId	string	ソースユーザーがブックマークから削除するポストのID。
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Returns

Promise<Response>

API レスポンスを返す Promise。requestOptions.raw が true の場合は生の Response オブジェクト

​

定義元

users/client.ts:3273

▸ deleteBookmark(id, tweetId): Promise<BookmarkMutationResponse>

​

パラメーター

名前	型
id	string
tweetId	string

​

戻り値

Promise<BookmarkMutationResponse>

​

定義元

users/client.ts:3290

---

​

unfollowList

▸ unfollowList(id, listId, options): Promise<Response>

リストのフォローを解除する
認証済みユーザーが、指定したリストIDのリストのフォローを解除します。

​

パラメーター

Name	Type	Description
id	string	リストのフォローを解除する、認証済みソースユーザーのID。
listId	string	フォローを解除するリストのID。
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

戻り値

Promise<Response>

API レスポンスを返す Promise。requestOptions.raw が true の場合は生の Response を返します。

​

定義元

users/client.ts:3391

▸ unfollowList(id, listId): Promise<ListFollowedResponse>

​

パラメータ

名前	型
id	string
listId	string

​

戻り値

Promise<ListFollowedResponse>

​

定義場所

users/client.ts:3408

---

​

unmuteUser

▸ unmuteUser(sourceUserId, targetUserId, options): Promise<Response>

ユーザーのミュートを解除 認証済みユーザーが、指定したユーザーidのミュートを解除します。

​

パラメータ

Name	Type	Description
sourceUserId	string	ミュート解除をリクエストしている認証済みのソースユーザーのID。
targetUserId	string	ソースユーザーがミュート解除をリクエストしている対象ユーザーのID。
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

戻り値

Promise<Response>

API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response を返します。

​

定義場所

users/client.ts:3515

▸ unmuteUser(sourceUserId, targetUserId): Promise<MuteUserMutationResponse>

​

パラメータ

名前	型
sourceUserId	string
targetUserId	string

​

戻り値

Promise<MuteUserMutationResponse>

​

定義元

users/client.ts:3532

---

​

getMe

▸ getMe(options): Promise<Response>

自分のユーザー情報を取得します 認証済みのユーザーの詳細を取得します。

​

パラメータ

名前	Type
options	GetMeOptions & { requestOptions: { raw: true } }

​

戻り値

Promise<Response>

API レスポンス、または requestOptions.raw が true の場合は生の Response オブジェクトに解決される Promise

​

定義場所

users/client.ts:3631

▸ getMe(options?): Promise<Get2UsersMeResponse>

​

パラメータ

名前	型
options?	GetMeOptions

​

戻り値

Promise<Get2UsersMeResponse>

​

定義元

users/client.ts:3640

---

​

getMuting

▸ getMuting(id, options): Promise<Response>

ミュート中のユーザーの取得 認証済みユーザーがミュートしているユーザーのリストを取得します。

​

パラメーター

Name	Type	Description
id	string	結果を返す対象の認証済みソースユーザーのID。
options	GetMutingOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンスで解決される Promise。requestOptions.raw が true の場合は生の Response

​

定義元

users/client.ts:3796

▸ getMuting(id, options?): Promise<Get2UsersIdMutingResponse>

​

パラメーター

名前	型
id	string
options?	GetMutingOptions

​

戻り値

Promise<Get2UsersIdMutingResponse>

​

定義場所

users/client.ts:3809

---

​

muteUser

▸ muteUser(id, options): Promise<Response>

ユーザーをミュートする
認証済みのユーザーが、指定したidのユーザーをミュートします。

​

パラメーター

Name	Type	Description
id	string	ターゲット User のミュートをリクエストする認証済みソース User の ID。
options	MuteUserOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンス、または requestOptions.raw が true の場合は生の Response を返す Promise

​

定義場所

users/client.ts:4015

▸ muteUser(id, options?): Promise<MuteUserMutationResponse>

​

パラメーター

名前	型
id	string
options?	MuteUserOptions

​

戻り値

Promise<MuteUserMutationResponse>

​

定義元

users/client.ts:4028

---

​

search

▸ search(query, options): Promise<Response>

ユーザーを検索 検索クエリに一致するユーザーの一覧を取得します。

​

パラメーター

Name	Type	Description
query	string	ユーザーを検索するためのクエリ文字列。
options	SearchOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンスを返す Promise。requestOptions.raw が true の場合は生の Response

​

定義場所

users/client.ts:4136

▸ search(query, options?): Promise<Get2UsersSearchResponse>

​

パラメーター

名前	type
query	string
options?	SearchOptions

​

戻り値

Promise<Get2UsersSearchResponse>

​

定義元

users/client.ts:4149

---

​

getBlocking

▸ getBlocking(id, options): Promise<Response>

ブロックしているユーザーの取得 指定したユーザーIDがブロックしているユーザーの一覧を取得します。

​

パラメーター

Name	Type	Description
id	string	結果を返す対象となる認証済みソースユーザーのID。
options	GetBlockingOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンスで解決される Promise。requestOptions.raw が true の場合は生の Response

​

定義場所

users/client.ts:4362

▸ getBlocking(id, options?): Promise<Get2UsersIdBlockingResponse>

​

パラメーター

名前	型
id	string
options?	GetBlockingOptions

​

戻り値

Promise<Get2UsersIdBlockingResponse>

​

定義場所

users/client.ts:4375

---

​

getByIds

▸ getByIds(ids, options): Promise<Response>

id でユーザーを取得する 複数のユーザーの詳細を、それぞれの id を指定して取得します。

​

Parameters

Name	Type	Description
ids	any[]	カンマ区切りのユーザーIDのリスト。最大100個まで指定できます。
options	GetByIdsOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンスで解決される Promise。requestOptions.raw が true の場合は、生の Response が返されます

​

定義場所

users/client.ts:4581

▸ getByIds(ids, options?): Promise<Get2UsersResponse>

​

パラメーター

名前	型
ids	any[]
options?	GetByIdsOptions

​

戻り値

Promise<Get2UsersResponse>

​

定義場所

users/client.ts:4594

---

​

getFollowing

▸ getFollowing(id, options): Promise<Response>

フォローしているUserを取得 特定のUserのidを指定して、そのUserがフォローしているUserのリストを取得します。

​

パラメーター

名前	型	説明
id	string	取得するユーザーのID。
options	GetFollowingOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンス (または requestOptions.raw が true の場合は生の Response) で解決される Promise

​

定義場所

users/client.ts:4777

▸ getFollowing(id, options?): Promise<Get2UsersIdFollowingResponse>

​

パラメータ

名前	型
id	string
options?	GetFollowingOptions

​

戻り値

Promise<Get2UsersIdFollowingResponse>

​

定義場所

users/client.ts:4790

---

​

followUser

▸ followUser(id, options): Promise<Response>

ユーザーをフォローする
認証済みユーザーが、指定したユーザー ID を持つ特定のユーザーをフォローします。

​

パラメータ

Name	Type	Description
id	string	対象ユーザーのフォローをリクエストしている、認証済みのソースユーザーのID。
options	FollowUserOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンス、または requestOptions.raw が true の場合は生の Response を返す Promise

​

定義元

users/client.ts:5002

▸ followUser(id, options?): Promise<UsersFollowingCreateResponse>

​

パラメーター

名前	型
id	string
options?	FollowUserOptions

​

戻り値

Promise<UsersFollowingCreateResponse>

​

定義元

users/client.ts:5015

---

​

likePost

▸ likePost(id, options): Promise<Response>

ポストに「いいね」する
認証済みユーザーが、特定の ID のポストに「いいね」します。

​

パラメーター

Name	Type	Description
id	string	ポストへの「いいね」をリクエストしている認証済みソースユーザーのID。
options	LikePostOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンス (または requestOptions.raw が true の場合は生の Response) で解決される Promise

​

定義場所

users/client.ts:5123

▸ likePost(id, options?): Promise<UsersLikesCreateResponse>

​

パラメータ

名前	型
id	string
options?	LikePostOptions

​

戻り値

Promise<UsersLikesCreateResponse>

​

定義場所

users/client.ts:5136

---

​

getLikedPosts

▸ getLikedPosts(id, options): Promise<Response>

「いいね」した投稿を取得します 指定したユーザーIDが「いいね」した投稿の一覧を取得します。

​

パラメーター

Name	Type	Description
id	string	取得するユーザーのID。
options	GetLikedPostsOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンスを解決結果とする Promise。requestOptions.raw が true の場合は、生の Response が返されます

​

定義元

users/client.ts:5244

▸ getLikedPosts(id, options?): Promise<Get2UsersIdLikedTweetsResponse>

​

パラメーター

名前	型
id	string
options?	GetLikedPostsOptions

​

戻り値

Promise<Get2UsersIdLikedTweetsResponse>

​

定義場所

users/client.ts:5257

---

​

getPosts

▸ getPosts(id, options): Promise<Response>

投稿の取得 特定のユーザーが作成した投稿のリストを、そのユーザーのidを指定して取得します。

​

パラメーター

Name	Type	Description
id	string	取得するユーザーのID。
options	GetPostsOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンスに解決される Promise、または requestOptions.raw が true の場合は生の Response

​

定義元

users/client.ts:5526

▸ getPosts(id, options?): Promise<Get2UsersIdTweetsResponse>

​

パラメータ

名前	型
id	string
options?	GetPostsOptions

​

戻り値

Promise<Get2UsersIdTweetsResponse>

​

定義元

users/client.ts:5539

---

​

blockDms

▸ blockDms(id, options): Promise<Response>

DM をブロックする
認証済みユーザーについて、特定の User の id を指定して、そのユーザーとの間で行われるダイレクトメッセージの送受信をブロックします。

​

Parameters

Name	Type	Description
id	string	このメソッドを呼び出している認証済みユーザーがDMの受信をブロックしようとしている対象ユーザーのID。
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

戻り値

Promise<Response>

API レスポンス、または requestOptions.raw が true の場合は生の Response を返す Promise

​

定義場所

users/client.ts:5909

▸ blockDms(id): Promise<UsersDMBlockCreateResponse>

​

パラメータ

名称	型
id	string

​

戻り値

Promise<UsersDMBlockCreateResponse>

​

定義場所

users/client.ts:5922

---

​

getListMemberships

▸ getListMemberships(id, options): Promise<Response>

リストのメンバーシップ情報を取得します 指定したユーザーがメンバーになっているリストの一覧を、そのユーザーのIDで取得します。

​

Parameters

Name	Type	Description
id	string	取得するユーザーのID。
options	GetListMembershipsOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンスで解決される Promise。requestOptions.raw が true の場合は生の Response

​

定義元

users/client.ts:6013

▸ getListMemberships(id, options?): Promise<Get2UsersIdListMembershipsResponse>

​

パラメーター

名前	型
id	string
options?	GetListMembershipsOptions

​

戻り値

Promise<Get2UsersIdListMembershipsResponse>

​

定義場所

users/client.ts:6026

---

​

getPinnedLists

▸ getPinnedLists(id, options): Promise<Response>

ピン留めされたリストを取得します
認証済みユーザーがピン留めしているリストの一覧を取得します。

​

パラメーター

Name	Type	Description
id	string	結果を返す対象の認証済みソースユーザーのID。
options	GetPinnedListsOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンス (requestOptions.raw が true の場合は生の Response) で解決される Promise

​

定義場所

users/client.ts:6238

▸ getPinnedLists(id, options?): Promise<Get2UsersIdPinnedListsResponse>

​

パラメーター

名前	型
id	string
options?	GetPinnedListsOptions

​

戻り値

Promise<Get2UsersIdPinnedListsResponse>

​

定義場所

users/client.ts:6251

---

​

pinList

▸ pinList(id, body, options): Promise<Response>

リストをピン留めする 認証済みユーザーが、指定したIDのリストをピン留めします。

​

パラメータ

名前	Type	説明
id	string	リストをピン留めする認証済みのソースユーザーのID。
body	ListPinnedRequest	リクエストボディ
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

戻り値

Promise<Response>

API レスポンスで解決される Promise。requestOptions.raw が true の場合は生の Response

​

定義元

users/client.ts:6421

▸ pinList(id, body): Promise<ListPinnedResponse>

​

パラメーター

名前	Type
id	string
body	ListPinnedRequest

​

戻り値

Promise<ListPinnedResponse>

​

定義場所

users/client.ts:6436

---

​

getByUsername

▸ getByUsername(username, options): Promise<Response>

ユーザー名で User を取得 指定したユーザー名の User の詳細情報を取得します。

​

パラメーター

名前	type	説明
username	string	ユーザー名。
options	GetByUsernameOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response

​

定義場所

users/client.ts:6533

▸ getByUsername(username, options?): Promise<Get2UsersByUsernameUsernameResponse>

​

パラメーター

名前	Type
username	string
options?	GetByUsernameOptions

​

戻り値

Promise<Get2UsersByUsernameUsernameResponse>

​

定義場所

users/client.ts:6546

---

​

unfollowUser

▸ unfollowUser(sourceUserId, targetUserId, options): Promise<Response>

ユーザーのフォロー解除 認証済みユーザーが、指定したユーザーのidを基にそのユーザーのフォローを解除します。

​

パラメータ

Name	Type	Description
sourceUserId	string	フォロー解除を要求している認証済みソースユーザーのID。
targetUserId	string	ソースユーザーがフォロー解除を要求している対象ユーザーのID。
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

戻り値

Promise<Response>

API レスポンス (requestOptions.raw が true の場合は生の Response) で解決される Promise

​

定義場所

users/client.ts:6724

▸ unfollowUser(sourceUserId, targetUserId): Promise<UsersFollowingDeleteResponse>

​

パラメータ

名前	型
sourceUserId	string
targetUserId	string

​

戻り値

Promise<UsersFollowingDeleteResponse>

​

定義元

users/client.ts:6741

---

​

getTimeline

▸ getTimeline(id, options): Promise<Response>

タイムラインを取得 認証済みユーザーのタイムライン上の投稿を、新しいものから順に取得します。

​

パラメーター

Name	Type	Description
id	string	逆時系列タイムラインの投稿を一覧取得する対象となる、認証済みソースユーザーの ID。
options	GetTimelineOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンスで解決される Promise オブジェクト。requestOptions.raw が true の場合は生の Response

​

定義場所

users/client.ts:6844

▸ getTimeline(id, options?): Promise<Get2UsersIdTimelinesReverseChronologicalResponse>

​

パラメータ

名前	型
id	string
options?	GetTimelineOptions

​

戻り値

Promise<Get2UsersIdTimelinesReverseChronologicalResponse>

​

定義場所

users/client.ts:6857

---

​

getFollowedLists

▸ getFollowedLists(id, options): Promise<Response>

フォローしているリストを取得 指定したユーザーの id に基づき、そのユーザーがフォローしているリストの一覧を取得します。

​

パラメータ

Name	Type	Description
id	string	取得するユーザーのID。
options	GetFollowedListsOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンス (requestOptions.raw が true の場合は生の Response) で解決される Promise

​

定義場所

users/client.ts:7221

▸ getFollowedLists(id, options?): Promise<Get2UsersIdFollowedListsResponse>

​

パラメータ

名前	型
id	string
options?	GetFollowedListsOptions

​

戻り値

Promise<Get2UsersIdFollowedListsResponse>

​

定義場所

users/client.ts:7234

---

​

followList

▸ followList(id, options): Promise<Response>

リストをフォロー
認証済みユーザーが、指定されたIDの特定のリストをフォローします。

​

パラメーター

Name	Type	Description
id	string	リストをフォローする認証済みソースユーザーのID。
options	FollowListOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンスへと解決される Promise。requestOptions.raw が true の場合は生の Response

​

定義元

users/client.ts:7446

▸ followList(id, options?): Promise<ListFollowedResponse>

​

パラメーター

名前	型
id	string
options?	FollowListOptions

​

戻り値

Promise<ListFollowedResponse>

​

定義元

users/client.ts:7459

---

​

unblockDms

▸ unblockDms(id, options): Promise<Response>

DM のブロック解除 認証済みユーザーについて、指定したユーザー ID とのダイレクトメッセージの送受信ブロックを解除します。

​

パラメータ

Name	Type	Description
id	string	認証済みユーザーがDMのブロック解除をリクエストしている対象ユーザーのID。
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

戻り値

Promise<Response>

API レスポンスを返す Promise。requestOptions.raw が true の場合は生の Response。

​

定義場所

users/client.ts:7567

▸ unblockDms(id): Promise<UsersDMUnBlockCreateResponse>

​

パラメーター

名前	型
id	string

​

戻り値

Promise<UsersDMUnBlockCreateResponse>

​

定義場所

users/client.ts:7580

---

​

repostPost

▸ repostPost(id, options): Promise<Response>

ポストをリポストする 認証済みユーザーが、指定したIDのポストをリポストします。

​

パラメーター

Name	Type	Description
id	string	ポストのリポストを要求している、認証済み送信元ユーザーのID。
options	RepostPostOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンスを返す Promise、または requestOptions.raw が true の場合は生の Response

​

定義場所

users/client.ts:7671

▸ repostPost(id, options?): Promise<UsersRetweetsCreateResponse>

​

パラメーター

名前	型
id	string
options?	RepostPostOptions

​

戻り値

Promise<UsersRetweetsCreateResponse>

​

定義場所

users/client.ts:7684

---

​

getBookmarkFolders

▸ getBookmarkFolders(id, options): Promise<Response>

ブックマークフォルダを取得します
認証されたユーザーが作成したブックマークフォルダの一覧を取得します。

​

パラメータ

Name	Type	Description
id	string	結果を返す対象となる、認証済みのソースユーザーのID。
options	GetBookmarkFoldersOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンス、または requestOptions.raw が true の場合は生の Response を返す Promise

​

定義場所

users/client.ts:7792

▸ getBookmarkFolders(id, options?): Promise<BookmarkFoldersResponse>

​

パラメーター

名前	型
id	string
options?	GetBookmarkFoldersOptions

​

戻り値

Promise<BookmarkFoldersResponse>

​

定義場所

users/client.ts:7805

---

​

getOwnedLists

▸ getOwnedLists(id, options): Promise<Response>

所有するリストを取得します
ユーザーIDを指定して、そのユーザーが所有するリストの一覧を取得します。

​

パラメーター

Name	Type	Description
id	string	取得対象のユーザーのID。
options	GetOwnedListsOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンス (requestOptions.raw が true の場合は生の Response) で解決される Promise

​

定義元

users/client.ts:7944

▸ getOwnedLists(id, options?): Promise<Get2UsersIdOwnedListsResponse>

​

パラメーター

名前	型
id	string
options?	GetOwnedListsOptions

​

戻り値

Promise<Get2UsersIdOwnedListsResponse>

​

定義場所

users/client.ts:7957

---

​

getBookmarksByFolderId

▸ getBookmarksByFolderId(id, folderId, options): Promise<Response>

フォルダーIDでブックマークを取得
認証済みユーザーの特定のブックマークフォルダーに含まれる投稿を、そのフォルダーのIDを指定して取得します。

​

パラメーター

Name	Type	Description
id	string	結果を返す対象となる、認証済みユーザーのID。
folderId	string	認証済みユーザーが投稿を取得しようとしているブックマークフォルダーのID。
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

戻り値

Promise<Response>

API レスポンスで解決される Promise。requestOptions.raw が true の場合は生の Response

​

定義場所

users/client.ts:8173

▸ getBookmarksByFolderId(id, folderId): Promise<BookmarkFolderPostsResponse>

​

パラメータ

名前	型
id	string
folderId	string

​

戻り値

Promise<BookmarkFolderPostsResponse>

​

定義元

users/client.ts:8190