UsersClient

ユーザー操作用クライアント

このクライアントは、X API のユーザーエンドポイントとやり取りするためのメソッドを提供します。認証、リクエストのフォーマット、レスポンスのパースを処理し、ユーザー関連の各種操作をサポートします。

​

コンストラクタ

​

constructor

• new UsersClient(client): UsersClient

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

​

パラメータ

名前	型	説明
client	Client	メインの X API クライアント インスタンス

​

戻り値

UsersClient

​

定義箇所

users/client.ts:720

​

メソッド

​

getMentions

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

メンションを取得 指定したユーザーIDにより、そのユーザーが言及されているPostの一覧を取得します。

​

パラメータ

名前	型	説明
id	string	取得対象のユーザーのid。
options	GetMentionsOptions	-

​

戻り値

Promise<Get2UsersIdMentionsResponse>

API レスポンスを返す Promise

​

定義箇所

users/client.ts:737

---

​

getRepostsOfMe

▸ getRepostsOfMe(options?): Promise<Get2UsersRepostsOfMeResponse>

自分のRepostの取得 認証済みユーザーのコンテンツをRepostしているPostの一覧を取得します。

​

パラメータ

項目名	型
options	GetRepostsOfMeOptions

​

戻り値

Promise<Get2UsersRepostsOfMeResponse>

API レスポンスに解決される Promise

​

定義場所

users/client.ts:849

---

​

getBookmarks

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

ブックマークの取得 認証済みユーザーがブックマークしたPostの一覧を取得します。

​

パラメータ

名称	型	説明
id	string	結果を返す対象となる認証済みのソースユーザーのID。
options	GetBookmarksOptions	-

​

戻り値

Promise<Get2UsersIdBookmarksResponse>

API レスポンスで解決される Promise

​

定義場所

users/client.ts:938

---

​

createBookmark

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

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

​

パラメーター

名前	型	説明
id	string	ブックマークを追加する対象となる、認証済みソースユーザーのID。
body	BookmarkAddRequest	リクエストボディ

​

戻り値

Promise<BookmarkMutationResponse>

API レスポンスで解決される Promise

​

定義元

users/client.ts:1032

---

​

getBlocking

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

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

​

パラメータ

名前	型	説明
id	string	結果を取得する対象となる、認証済みのソースユーザーのid。
options	GetBlockingOptions	-

​

返り値

Promise<Get2UsersIdBlockingResponse>

API レスポンスで解決される Promise

​

定義箇所

users/client.ts:1075

---

​

getBookmarksByFolderId

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

フォルダーIDでブックマークを取得 認証済みユーザーについて、指定したブックマークフォルダーのIDを用いて、そのフォルダー内のPostを取得します。

​

パラメータ

名前	型	説明
id	string	結果を返す対象となる認証済みソースユーザーのID。
folderId	string	認証済みユーザーがPostを取得しようとしているブックマークフォルダのID。

​

戻り値

Promise<BookmarkFolderPostsResponse>

API レスポンスに解決される Promise

​

定義元

users/client.ts:1153

---

​

getById

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

IDでユーザーを取得 指定したユーザーIDに基づいて、そのユーザーの詳細を取得します。

​

パラメータ

名前	型	説明
id	string	取得対象のユーザーのid。
options	GetByIdOptions	-

​

返り値

Promise<Get2UsersIdResponse>

API レスポンスで解決される Promise

​

定義場所

users/client.ts:1196

---

​

unrepostPost

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

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

​

パラメーター

名前	型	説明
id	string	Repost をリクエストしている認証済みソースユーザーの ID。
sourceTweetId	string	ユーザーがリツイート取り消し（unretweet）をリクエストしている Post の ID。

​

返り値

Promise<UsersRetweetsDeleteResponse>

API レスポンスに解決される Promise

​

定義場所

users/client.ts:1262

---

​

getFollowers

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

フォロワーを取得 指定したユーザーのIDに基づいて、そのユーザーのフォロワーの一覧を取得します。

​

パラメータ

名前	型	説明
id	string	取得対象のユーザーのid。
options	GetFollowersOptions	-

​

戻り値

Promise<Get2UsersIdFollowersResponse>

API レスポンスで解決される Promise

​

定義箇所

users/client.ts:1308

---

​

likePost

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

Post を「いいね」する 認証済みユーザーが、指定した ID の Post を「いいね」します。

​

パラメータ

名前	型	説明
id	string	Postに「いいね」を行うリクエストを送信する、認証済みのソースユーザーのID。
options	LikePostOptions	-

​

戻り値

Promise<UsersLikesCreateResponse>

API レスポンスで解決される Promise

​

定義元

users/client.ts:1382

---

​

unlikePost

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

Post の「いいね」を取り消す 認証済みユーザーが、指定した ID の特定の Post の「いいね」を取り消します。

​

パラメータ

Name	Type	Description
id	string	いいねの取り消しを要求している、認証済みのソースUserのID。
tweetId	string	Userがいいねの取り消しを要求しているPostのID。

​

戻り値

Promise<UsersLikesDeleteResponse>

API レスポンスで解決される Promise

​

定義箇所

users/client.ts:1434

---

​

unfollowList

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

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

​

パラメータ

名前	型	説明
id	string	対象のリストのフォローを解除する、認証済みの送信元ユーザーのID。
listId	string	フォローを解除するリストのID。

​

戻り値

Promise<ListFollowedResponse>

API レスポンスを返す Promise

​

定義箇所

users/client.ts:1478

---

​

getFollowing

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

フォローの取得 指定したユーザーIDに対して、そのユーザーがフォローしているユーザーの一覧を取得します。

​

パラメータ

名前	型	説明
id	string	取得対象のユーザーのid。
options	GetFollowingOptions	-

​

返り値

Promise<Get2UsersIdFollowingResponse>

API レスポンスで解決される Promise

​

定義箇所

users/client.ts:1521

---

​

followUser

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

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

​

パラメータ

名前	型	説明
id	string	ターゲットユーザーのフォローをリクエストする認証済みの発信元ユーザーのid。
options	FollowUserOptions	-

​

戻り値

Promise<UsersFollowingCreateResponse>

API レスポンスに解決される Promise

​

定義元

users/client.ts:1595

---

​

getLikedPosts

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

「いいね」したPostを取得 指定したUserのIDを基に、そのUserが「いいね」したPostの一覧を取得します。

​

パラメーター

名前	型	説明
id	string	取得対象のユーザーのID。
options	GetLikedPostsOptions	-

​

返り値

Promise<Get2UsersIdLikedTweetsResponse>

API レスポンスに解決される Promise

​

定義箇所

users/client.ts:1643

---

​

unfollowUser

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

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

​

パラメータ

名前	型	説明
sourceUserId	string	認証済みのソースユーザー（フォロー解除をリクエストしている側）のユーザーのid。
targetUserId	string	ソースユーザーがフォロー解除をリクエストしている対象ユーザーのid。

​

戻り値

Promise<UsersFollowingDeleteResponse>

API レスポンスで解決される Promise

​

定義箇所

users/client.ts:1739

---

​

unpinList

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

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

​

パラメータ

名前	型	説明
id	string	結果を返す対象の認証済みソースユーザーのID。
listId	string	ピン留めを解除するリストのID。

​

戻り値

Promise<ListUnpinResponse>

API レスポンスで解決される Promise

​

定義元

users/client.ts:1792

---

​

repostPost

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

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

​

パラメーター

名前	型	説明
id	string	認証済みのソースユーザーのID。PostのリポストをリクエストしているユーザーのIDです。
options	RepostPostOptions	-

​

返り値

Promise<UsersRetweetsCreateResponse>

API レスポンスで解決される Promise

​

定義元

users/client.ts:1832

---

​

getPinnedLists

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

ピン留めされたListを取得 認証済みユーザーがピン留めしたListの一覧を取得します。

​

パラメータ

名前	型	説明
id	string	結果を返す対象となる、認証済みのソースユーザーのID。
options	GetPinnedListsOptions	-

​

戻り値

Promise<Get2UsersIdPinnedListsResponse>

API レスポンスで解決される Promise

​

定義箇所

users/client.ts:1880

---

​

pinList

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

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

​

パラメータ

名称	型	説明
id	string	リストをピン留めする認証済みのソースユーザーのID。
body	ListPinnedRequest	リクエストボディ

​

返り値

Promise<ListPinnedResponse>

API レスポンスで解決される Promise

​

定義箇所

users/client.ts:1944

---

​

getListMemberships

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

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

​

パラメータ

名前	型	説明
id	string	取得対象のユーザーのID。
options	GetListMembershipsOptions	-

​

返り値

Promise<Get2UsersIdListMembershipsResponse>

API レスポンスで解決される Promise

​

定義元

users/client.ts:1984

---

​

unmuteUser

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

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

​

パラメータ

名前	型	説明
sourceUserId	string	対象ユーザーのミュート解除をリクエストしている、認証済みのソースユーザーのid。
targetUserId	string	ソースユーザーがミュート解除をリクエストしている対象ユーザーのid。

​

戻り値

Promise<MuteUserMutationResponse>

API レスポンスに解決される Promise

​

定義元

users/client.ts:2062

---

​

blockDms

▸ blockDms(id): Promise<UsersDMBlockCreateResponse>

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

​

パラメーター

名前	型	説明
id	string	認証済みユーザーがDMの受信をブロックしようとしている対象ユーザーのid。

​

戻り値

Promise<UsersDMBlockCreateResponse>

API レスポンスで解決される Promise

​

定義元

users/client.ts:2111

---

​

getFollowedLists

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

フォロー中のListを取得 指定したユーザーのIDに基づいて、そのユーザーがフォローしているListの一覧を取得します。

​

パラメータ

名前	型	説明
id	string	参照するユーザーのid。
options	GetFollowedListsOptions	-

​

戻り値

Promise<Get2UsersIdFollowedListsResponse>

API レスポンスに解決される Promise

​

定義箇所

users/client.ts:2149

---

​

followList

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

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

​

パラメータ

名前	型	説明
id	string	リストをフォローする認証済みソースユーザーのid。
options	FollowListOptions	-

​

戻り値

Promise<ListFollowedResponse>

API レスポンスに解決される Promise

​

定義場所

users/client.ts:2223

---

​

getByIds

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

ID でUsersを取得 複数のUsersの詳細をIDで取得します。

​

パラメーター

名前	型	説明
ids	any[]	ユーザーIDのリスト（カンマ区切り）。最大100件まで指定できます。
options	GetByIdsOptions	-

​

返り値

Promise<Get2UsersResponse>

API レスポンスで解決される Promise

​

定義箇所

users/client.ts:2271

---

​

getMe

▸ getMe(options?): Promise<Get2UsersMeResponse>

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

​

パラメータ

Name	Type
options	GetMeOptions

​

返り値

Promise<Get2UsersMeResponse>

API レスポンスで解決される Promise

​

定義箇所

users/client.ts:2331

---

​

unblockDms

▸ unblockDms(id): Promise<UsersDMUnBlockCreateResponse>

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

​

パラメータ

名前	型	説明
id	string	認証済みユーザーがDMのブロック解除をリクエストしている対象ユーザーのid。

​

返却値

Promise<UsersDMUnBlockCreateResponse>

API レスポンスで解決される Promise

​

定義場所

users/client.ts:2388

---

​

getMuting

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

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

​

パラメータ

名前	型	説明
id	string	結果を返す対象の認証済みソースユーザーのid。
options	GetMutingOptions	-

​

戻り値

Promise<Get2UsersIdMutingResponse>

API レスポンスで解決される Promise

​

定義

users/client.ts:2426

---

​

muteUser

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

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

​

パラメータ

名前	型	説明
id	string	対象ユーザーのミュートをリクエストする、認証済みソースユーザーのid。
options	MuteUserOptions	-

​

返り値

Promise<MuteUserMutationResponse>

API レスポンスで解決される Promise

​

定義場所

users/client.ts:2500

---

​

getPosts

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

Posts を取得 指定したユーザー ID を基に、そのユーザーが作成した Post の一覧を取得します。

​

パラメーター

名前	型	説明
id	string	参照するユーザーのid。
options	GetPostsOptions	-

​

戻り値

Promise<Get2UsersIdTweetsResponse>

API レスポンスで解決される Promise

​

定義場所

users/client.ts:2548

---

​

deleteBookmark

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

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

​

パラメータ

名前	型	説明
id	string	ブックマークを削除する認証済みソースユーザーのID。
tweetId	string	ソースユーザーがブックマークから削除するPostのID。

​

戻り値

Promise<BookmarkMutationResponse>

API レスポンスに解決される Promise

​

定義元

users/client.ts:2674

---

​

getByUsernames

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

ユーザー名でユーザーを取得 ユーザー名を指定して複数のユーザーの詳細を取得します。

​

パラメータ

名前	型	説明
usernames	any[]	カンマ区切りのユーザー名のリスト。
options	GetByUsernamesOptions	-

​

戻り値

Promise<Get2UsersByResponse>

API レスポンスに解決される Promise

​

定義先

users/client.ts:2717

---

​

getByUsername

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

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

​

パラメータ

名前	型	説明
username	string	ユーザー名。
options	GetByUsernameOptions	-

​

返り値

Promise<Get2UsersByUsernameUsernameResponse>

API レスポンスで解決される Promise

​

定義場所

users/client.ts:2781

---

​

getBookmarkFolders

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

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

​

パラメーター

名前	型	説明
id	string	結果を返す対象の、認証済みソースユーザーのid。
options	GetBookmarkFoldersOptions	-

​

戻り値

Promise<BookmarkFoldersResponse>

API レスポンスで解決される Promise

​

定義元

users/client.ts:2843

---

​

search

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

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

​

パラメーター

名前	型	説明
query	any	ユーザーを検索するためのクエリ文字列。
options	SearchOptions	-

​

返り値

Promise<Get2UsersSearchResponse>

API レスポンスに解決される Promise

​

定義場所

users/client.ts:2899

---

​

getTimeline

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

タイムラインの取得 認証済みユーザーのタイムラインにあるPostを新しい順（逆時系列）で取得します。

​

パラメータ

名前	型	説明
id	string	逆時系列タイムラインのPostを取得する対象となる、認証済み送信元ユーザーのid。
options	GetTimelineOptions	-

​

返り値

Promise<Get2UsersIdTimelinesReverseChronologicalResponse>

API レスポンスで解決される Promise

​

定義場所

users/client.ts:2975

---

​

getOwnedLists

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

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

​

パラメータ

名前	型	説明
id	string	取得対象のユーザーのid。
options	GetOwnedListsOptions	-

​

戻り値

Promise<Get2UsersIdOwnedListsResponse>

API レスポンスで解決される Promise

​

定義箇所

users/client.ts:3097