UsersClient

users 操作向けのクライアントこのクライアントは X API の users エンドポイントと対話するためのメソッドを提供します。認証、リクエストの整形、users に関連するすべての操作のレスポンス解析を扱います。

コンストラクター

• new UsersClient(client): UsersClient 新しい users クライアントインスタンスを作成します

パラメーター

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

戻り値

UsersClient

定義場所

users/client.ts:1234

メソッド

getByUsernames

▸ getByUsernames(usernames, options): Promise<Response> Get Users by usernames Retrieves details of multiple Users by their usernames.

パラメーター

名前	型	説明
`usernames`	`any`[]	A list of usernames, comma-separated.
`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> Get Reposts of me 次の一覧を取得します: Posts that repost content from the authenticated user.

パラメーター

名前	型
`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> Unlike Post Causes the authenticated user to Unlike a specific Post by its ID.

パラメーター

名前	型	説明
`id`	`string`	The ID of the authenticated source User that is requesting to unlike the Post.
`tweetId`	`string`	The ID of the Post that the User is requesting to unlike.
`options`	`Object`	-
`options.requestOptions`	`Object`	-
`options.requestOptions.raw`	`true`	-

戻り値

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

定義場所

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> Get Bookmarks 次の一覧を取得します: Posts bookmarked by the authenticated user.

パラメーター

名前	型	説明
`id`	`string`	The ID of the authenticated source User for whom to return results.
`options`	`GetBookmarksOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

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

定義場所

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> Create Bookmark Adds a post to the authenticated user’s bookmarks.

パラメーター

名前	型	説明
`id`	`string`	The ID of the authenticated source User for whom to add bookmarks.
`body`	`BookmarkAddRequest`	Request body
`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> Get followers 次の一覧を取得します: Users who follow a specific User by their ID.

パラメーター

名前	型	説明
`id`	`string`	The ID of the User to lookup.
`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> Unpin List Causes the authenticated user to unpin a specific List by its ID.

パラメーター

名前	型	説明
`id`	`string`	The ID of the authenticated source User for whom to return results.
`listId`	`string`	The ID of the List to unpin.
`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> Get User by ID Retrieves details of a specific User by their ID.

パラメーター

名前	型	説明
`id`	`string`	The ID of the User to lookup.
`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> Get mentions 次の一覧を取得します: Posts that mention a specific User by their ID.

パラメーター

名前	型	説明
`id`	`string`	The ID of the User to lookup.
`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> Unrepost Post Causes the authenticated user to unrepost a specific Post by its ID.

パラメーター

名前	型	説明
`id`	`string`	The ID of the authenticated source User that is requesting to repost the Post.
`sourceTweetId`	`string`	The ID of the Post that the User is requesting to unretweet.
`options`	`Object`	-
`options.requestOptions`	`Object`	-
`options.requestOptions.raw`	`true`	-

戻り値

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

定義場所

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> Delete Bookmark Removes a Post from the authenticated user’s Bookmarks by its ID.

パラメーター

名前	型	説明
`id`	`string`	The ID of the authenticated source User whose bookmark is to be removed.
`tweetId`	`string`	The ID of the Post that the source User is removing from bookmarks.
`options`	`Object`	-
`options.requestOptions`	`Object`	-
`options.requestOptions.raw`	`true`	-

戻り値

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> Unfollow List Causes the authenticated user to unfollow a specific List by its ID.

パラメーター

名前	型	説明
`id`	`string`	The ID of the authenticated source User that will unfollow the List.
`listId`	`string`	The ID of the List to unfollow.
`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> Unmute User Causes the authenticated user to unmute a specific user by their ID.

パラメーター

名前	型	説明
`sourceUserId`	`string`	The ID of the authenticated source User that is requesting to unmute the target User.
`targetUserId`	`string`	The ID of the User that the source User is requesting to unmute.
`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> Get my User Retrieves details of the authenticated user.

パラメーター

名前	型
`options`	`GetMeOptions` & { `requestOptions`: { `raw`: `true` } }

戻り値

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

定義場所

users/client.ts:3631 ▸ getMe(options?): Promise<Get2UsersMeResponse>

パラメーター

名前	型
`options?`	`GetMeOptions`

戻り値

Promise<Get2UsersMeResponse>

定義場所

users/client.ts:3640

getMuting

▸ getMuting(id, options): Promise<Response> Get muting 次の一覧を取得します: Users muted by the authenticated user.

パラメーター

名前	型	説明
`id`	`string`	The ID of the authenticated source User for whom to return results.
`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> Mute User Causes the authenticated user to mute a specific User by their ID.

パラメーター

名前	型	説明
`id`	`string`	The ID of the authenticated source User that is requesting to mute the target User.
`options`	`MuteUserOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

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

定義場所

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> Search Users 次の一覧を取得します: Users matching a search query.

パラメーター

名前	型	説明
`query`	`string`	TThe the query string by which to query for users.
`options`	`SearchOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

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

定義場所

users/client.ts:4136 ▸ search(query, options?): Promise<Get2UsersSearchResponse>

パラメーター

名前	型
`query`	`string`
`options?`	`SearchOptions`

戻り値

Promise<Get2UsersSearchResponse>

定義場所

users/client.ts:4149

getBlocking

▸ getBlocking(id, options): Promise<Response> Get blocking 次の一覧を取得します: Users blocked by the specified User ID.

パラメーター

名前	型	説明
`id`	`string`	The ID of the authenticated source User for whom to return results.
`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> Get Users by IDs Retrieves details of multiple Users by their IDs.

パラメーター

名前	型	説明
`ids`	`any`[]	A list of User IDs, comma-separated. You can specify up to 100 IDs.
`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> Get following 次の一覧を取得します: Users followed by a specific User by their ID.

パラメーター

名前	型	説明
`id`	`string`	The ID of the User to lookup.
`options`	`GetFollowingOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

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

定義場所

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> Follow User Causes the authenticated user to follow a specific user by their ID.

パラメーター

名前	型	説明
`id`	`string`	The ID of the authenticated source User that is requesting to follow the target User.
`options`	`FollowUserOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

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

定義場所

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> Like Post Causes the authenticated user to Like a specific Post by its ID.

パラメーター

名前	型	説明
`id`	`string`	The ID of the authenticated source User that is requesting to like the Post.
`options`	`LikePostOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

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

定義場所

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> Get liked Posts 次の一覧を取得します: Posts liked by a specific User by their ID.

パラメーター

名前	型	説明
`id`	`string`	The ID of the User to lookup.
`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> Get Posts 次の一覧を取得します: posts authored by a specific User by their ID.

パラメーター

名前	型	説明
`id`	`string`	The ID of the User to lookup.
`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> Block DMs Blocks direct messages to or from a specific User by their ID for the authenticated user.

パラメーター

名前	型	説明
`id`	`string`	The ID of the target User that the authenticated user requesting to block dms for.
`options`	`Object`	-
`options.requestOptions`	`Object`	-
`options.requestOptions.raw`	`true`	-

戻り値

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

定義場所

users/client.ts:5909 ▸ blockDms(id): Promise<UsersDMBlockCreateResponse>

パラメーター

名前	型
`id`	`string`

戻り値

Promise<UsersDMBlockCreateResponse>

定義場所

users/client.ts:5922

getListMemberships

▸ getListMemberships(id, options): Promise<Response> Get List memberships 次の一覧を取得します: Lists that a specific User is a member of by their ID.

パラメーター

名前	型	説明
`id`	`string`	The ID of the User to lookup.
`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> Get pinned Lists 次の一覧を取得します: Lists pinned by the authenticated user.

パラメーター

名前	型	説明
`id`	`string`	The ID of the authenticated source User for whom to return results.
`options`	`GetPinnedListsOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

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

定義場所

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> Pin List Causes the authenticated user to pin a specific List by its ID.

パラメーター

名前	型	説明
`id`	`string`	The ID of the authenticated source User that will pin the List.
`body`	`ListPinnedRequest`	Request body
`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>

パラメーター

名前	型
`id`	`string`
`body`	`ListPinnedRequest`

戻り値

Promise<ListPinnedResponse>

定義場所

users/client.ts:6436

getByUsername

▸ getByUsername(username, options): Promise<Response> Get User by username Retrieves details of a specific User by their username.

パラメーター

名前	型	説明
`username`	`string`	A username.
`options`	`GetByUsernameOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

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

定義場所

users/client.ts:6533 ▸ getByUsername(username, options?): Promise<Get2UsersByUsernameUsernameResponse>

パラメーター

名前	型
`username`	`string`
`options?`	`GetByUsernameOptions`

戻り値

Promise<Get2UsersByUsernameUsernameResponse>

定義場所

users/client.ts:6546

unfollowUser

▸ unfollowUser(sourceUserId, targetUserId, options): Promise<Response> Unfollow User Causes the authenticated user to unfollow a specific user by their ID.

パラメーター

名前	型	説明
`sourceUserId`	`string`	The ID of the authenticated source User that is requesting to unfollow the target User.
`targetUserId`	`string`	The ID of the User that the source User is requesting to unfollow.
`options`	`Object`	-
`options.requestOptions`	`Object`	-
`options.requestOptions.raw`	`true`	-

戻り値

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

定義場所

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> Get Timeline Retrieves a reverse chronological list of Posts in the authenticated User’s Timeline.

パラメーター

名前	型	説明
`id`	`string`	The ID of the authenticated source User to list Reverse Chronological Timeline Posts of.
`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> Get followed Lists 次の一覧を取得します: Lists followed by a specific User by their ID.

パラメーター

名前	型	説明
`id`	`string`	The ID of the User to lookup.
`options`	`GetFollowedListsOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

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

定義場所

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> Follow List Causes the authenticated user to follow a specific List by its ID.

パラメーター

名前	型	説明
`id`	`string`	The ID of the authenticated source User that will follow the List.
`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> Unblock DMs Unblocks direct messages to or from a specific User by their ID for the authenticated user.

パラメーター

名前	型	説明
`id`	`string`	The ID of the target User that the authenticated user requesting to unblock dms for.
`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> Repost Post Causes the authenticated user to repost a specific Post by its ID.

パラメーター

名前	型	説明
`id`	`string`	The ID of the authenticated source User that is requesting to repost the Post.
`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> Get Bookmark folders 次の一覧を取得します: Bookmark folders created by the authenticated user.

パラメーター

名前	型	説明
`id`	`string`	The ID of the authenticated source User for whom to return results.
`options`	`GetBookmarkFoldersOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

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

定義場所

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> Get owned Lists 次の一覧を取得します: Lists owned by a specific User by their ID.

パラメーター

名前	型	説明
`id`	`string`	The ID of the User to lookup.
`options`	`GetOwnedListsOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

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

定義場所

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> Get Bookmarks by folder ID Retrieves Posts in a specific Bookmark folder by its ID for the authenticated user.

パラメーター

名前	型	説明
`id`	`string`	The ID of the authenticated source User for whom to return results.
`folderId`	`string`	The ID of the Bookmark Folder that the authenticated User is trying to fetch Posts for.
`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

​コンストラクター

​コンストラクター

​パラメーター

​戻り値

​定義場所

​メソッド

​getByUsernames

​パラメーター

​戻り値

​定義場所

​パラメーター

​戻り値

​定義場所

​getRepostsOfMe

​パラメーター

​戻り値

​定義場所

​パラメーター

​戻り値

​定義場所

​unlikePost

​パラメーター

​戻り値

​定義場所

​パラメーター

​戻り値

​定義場所

​getBookmarks

​パラメーター

​戻り値

​定義場所

​パラメーター

​戻り値

​定義場所

​createBookmark

​パラメーター

​戻り値

​定義場所

​パラメーター

​戻り値

​定義場所

​getFollowers

​パラメーター

​戻り値

​定義場所

​パラメーター

​戻り値

​定義場所

​unpinList

​パラメーター

​戻り値

​定義場所

​パラメーター

​戻り値

​定義場所

​getById

​パラメーター

​戻り値

​定義場所

​パラメーター

​戻り値

​定義場所

​getMentions

​パラメーター

​戻り値

​定義場所

​パラメーター

​戻り値

​定義場所

​unrepostPost

​パラメーター

​戻り値

​定義場所

​パラメーター

​戻り値

​定義場所

​deleteBookmark

​パラメーター

​戻り値

​定義場所

コンストラクター

コンストラクター

パラメーター

戻り値

定義場所

メソッド

getByUsernames

パラメーター

戻り値

定義場所

パラメーター

戻り値

定義場所

getRepostsOfMe

パラメーター

戻り値

定義場所

パラメーター

戻り値

定義場所

unlikePost

パラメーター

戻り値

定義場所

パラメーター

戻り値

定義場所

getBookmarks

パラメーター

戻り値

定義場所

パラメーター

戻り値

定義場所

createBookmark

パラメーター

戻り値

定義場所

パラメーター

戻り値

定義場所

getFollowers

パラメーター

戻り値

定義場所

パラメーター

戻り値

定義場所

unpinList

パラメーター

戻り値

定義場所

パラメーター

戻り値

定義場所

getById

パラメーター

戻り値

定義場所

パラメーター

戻り値

定義場所

getMentions

パラメーター

戻り値

定義場所

パラメーター

戻り値

定義場所

unrepostPost

パラメーター

戻り値

定義場所

パラメーター

戻り値

定義場所

deleteBookmark

パラメーター

戻り値

定義場所