ListsClient

用于列表相关操作的客户端

此客户端提供与 X API 列表端点交互的方法，负责处理所有列表相关操作的身份验证、请求格式化和响应解析。

​

构造函数

​

构造函数

• new ListsClient(client): ListsClient

创建一个新的 ListsClient 实例

​

参数

名称	类型	描述
client	Client	X API 的主客户端实例

​

返回

ListsClient

​

定义于

lists/client.ts:188

​

方法

​

getFollowers

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

获取列表关注者 根据其ID，检索关注特定列表的用户。

​

参数

名称	类型	说明
id	string	列表的 id。
options	GetFollowersOptions	-

​

返回

Promise<Get2ListsIdFollowersResponse>

解析为 API 响应的 Promise

​

定义于

lists/client.ts:205

---

​

getMembers

▸ getMembers(id, options?): Promise<Get2ListsIdMembersResponse>

获取 List 成员 根据其 ID 获取特定 List 的成员用户。

​

参数

名称	类型	说明
id	string	列表的 id。
options	GetMembersOptions	-

​

返回

Promise<Get2ListsIdMembersResponse>

一个会解析为 API 响应的 Promise

​

定义于

lists/client.ts:279

---

​

addMember

▸ addMember(id, options?): Promise<ListMutateResponse>

添加列表成员 根据其 ID 将用户添加到指定的列表。

​

参数

名称	类型	描述
id	string	要添加成员的 List 的 id。
options	AddMemberOptions	-

​

返回

Promise<ListMutateResponse>

一个会解析为 API 响应的 Promise

​

定义于

lists/client.ts:353

---

​

removeMemberByUserId

▸ removeMemberByUserId(id, userId): Promise<ListMutateResponse>

移除 List 成员 根据 List 的 ID 和用户的 ID，将该用户从指定的 List 中移除。

​

参数

名称	类型	描述
id	string	要从中移除成员的列表的 id。
userId	string	将从该列表中移除的用户的 id。

​

返回

Promise<ListMutateResponse>

解析为 API 响应的 Promise

​

定义于

lists/client.ts:405

---

​

getPosts

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

获取列表中的 Post 按其 ID 检索与特定列表关联的 Post 列表。

​

参数

名称	类型	描述
id	string	List 的 id。
options	GetPostsOptions	-

​

返回

Promise<Get2ListsIdTweetsResponse>

解析为 API 响应的 Promise

​

定义位置

lists/client.ts:448

---

​

getById

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

按 ID 获取 List 根据其 ID 获取指定 List 的详细信息。

​

参数

名称	类型	描述
id	string	List 的 id。
options	GetByIdOptions	-

​

返回

Promise<Get2ListsIdResponse>

解析为 API 响应的 Promise

​

定义于

lists/client.ts:540

---

​

update

▸ update(id, options?): Promise<ListUpdateResponse>

更新 List 根据其 ID 更新经过身份验证的用户所拥有的特定 List 的详细信息。

​

参数

名称	类型	说明
id	string	要修改的 List 的id。
options	UpdateOptions	-

​

返回值

Promise<ListUpdateResponse>

解析为 API 响应的 Promise

​

定义于

lists/client.ts:602

---

​

delete

▸ delete(id): Promise<ListDeleteResponse>

删除列表 根据其 ID 删除经过身份验证的用户所拥有的特定列表。

​

参数

名称	类型	说明
id	string	要删除的列表的 id。

​

返回

Promise<ListDeleteResponse>

一个会解析为 API 响应的 Promise

​

定义位置

lists/client.ts:650

---

​

create

▸ create(options?): Promise<ListCreateResponse>

创建 List 为已认证用户新建一个 List。

​

参数

名称	类型
options	CreateOptions

​

返回

Promise<ListCreateResponse>

一个会解析为 API 响应的 Promise

​

定义于

lists/client.ts:684