UsersClient

用户操作客户端

该客户端提供与 X API 的 users 端点交互的方法，负责处理身份验证、请求格式与响应解析，覆盖所有与用户相关的操作。

​

构造器

​

构造函数

• 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>

获取对我的转帖 检索转帖经身份验证用户内容的 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	发起转帖请求的已认证源用户的 ID。
sourceTweetId	string	用户请求取消转贴的 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 的点赞。

​

参数

名称	类型	说明
id	string	发起取消点赞请求的已认证源用户的 id。
tweetId	string	该用户请求取消点赞的 Post 的 id。

​

返回

Promise<UsersLikesDeleteResponse>

一个会解析为 API 响应的 Promise

​

定义于

users/client.ts:1434

---

​

unfollowList

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

取消关注 List 使经过身份验证的用户根据其 ID 取消关注指定的 List。

​

参数

名称	类型	说明
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 按用户的 ID 获取该用户点赞过的 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	发起转发该 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>

固定 List 使已认证用户根据其 id 固定指定的 List。

​

参数

名称	类型	描述
id	string	将要置顶该 List 的已认证源用户的 id。
body	ListPinnedRequest	请求体

​

返回

Promise<ListPinnedResponse>

解析为 API 响应的 Promise

​

定义于

users/client.ts:1944

---

​

getListMemberships

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

获取 List 成员关系 根据用户的id，检索该用户所加入的所有 List。

​

参数

名称	类型	说明
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>

屏蔽私信 为已认证用户按目标用户的 ID 屏蔽与该用户之间的私信往来。

​

参数

名称	类型	描述
id	string	发起屏蔽私信请求的已认证用户要屏蔽其私信的目标用户的 id。

​

返回

Promise<UsersDMBlockCreateResponse>

解析为 API 响应的 Promise

​

定义于

users/client.ts:2111

---

​

getFollowedLists

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

获取已关注的 Lists 按用户 ID 检索该用户关注的 Lists。

​

参数

名称	类型	描述
id	string	要查询的用户 id。
options	GetFollowedListsOptions	-

​

返回

Promise<Get2UsersIdFollowedListsResponse>

解析为 API 响应的 Promise

​

定义位置

users/client.ts:2149

---

​

followList

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

关注列表 让已认证用户通过其 ID 关注指定的列表。

​

参数

名称	类型	描述
id	string	将要关注该 List 的已认证源用户的 id。
options	FollowListOptions	-

​

返回

Promise<ListFollowedResponse>

解析为 API 响应的 Promise

​

定义位置

users/client.ts:2223

---

​

getByIds

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

按 ID 获取用户 根据其 id 获取多个用户的详细信息。

​

参数

名称	类型	描述
ids	any[]	以逗号分隔的用户 id 列表。最多可指定 100 个 id。
options	GetByIdsOptions	-

​

返回

Promise<Get2UsersResponse>

解析为 API 响应的 Promise

​

定义于

users/client.ts:2271

---

​

getMe

▸ getMe(options?): Promise<Get2UsersMeResponse>

获取当前用户 检索已认证用户的详细信息。

​

参数

名称	类型
options	GetMeOptions

​

返回

Promise<Get2UsersMeResponse>

解析为 API 响应的 Promise

​

定义于

users/client.ts:2331

---

​

unblockDms

▸ unblockDms(id): Promise<UsersDMUnBlockCreateResponse>

取消屏蔽私信 为已认证用户，根据目标用户的 ID 取消与该用户之间的私信屏蔽（收发皆可）。

​

参数

名称	类型	描述
id	string	发起解除私信阻止请求的已认证用户所针对的目标用户的 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>

获取 Post 根据用户的 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	已认证源用户的 id，用于列出其按时间倒序的时间线中的 Post。
options	GetTimelineOptions	-

​

返回

Promise<Get2UsersIdTimelinesReverseChronologicalResponse>

会解析为 API 响应的 Promise

​

定义于

users/client.ts:2975

---

​

getOwnedLists

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

获取拥有的 Lists 根据用户 ID 检索该用户拥有的 Lists。

​

参数

名称	类型	说明
id	string	要查询的用户 id。
options	GetOwnedListsOptions	-

​

返回

Promise<Get2UsersIdOwnedListsResponse>

解析为 API 响应的 Promise

​

定义位置

users/client.ts:3097