SpacesClient

用于 Spaces 操作的客户端

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

​

构造器

​

构造函数

• new SpacesClient(client): SpacesClient

创建一个新的 Spaces 客户端实例

​

参数

名称	类型	说明
client	Client	X API 的主客户端实例

​

返回值

SpacesClient

​

定义位置

spaces/client.ts:190

​

方法

​

getByIds

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

根据 ID 获取 Spaces 按其 ID 获取多个 Spaces 的详细信息。

​

参数

名称	类型	描述
ids	any[]	要返回的 Space 的 id 列表。
options	GetByIdsOptions	-

​

返回

Promise<Get2SpacesResponse>

解析为 API 响应的 Promise

​

定义于

spaces/client.ts:207

---

​

search

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

搜索 Spaces 检索与指定搜索条件匹配的 Spaces 列表。

​

参数

名称	类型	描述
query	string	搜索词。
options	SearchOptions	-

​

返回

Promise<Get2SpacesSearchResponse>

一个解析为 API 响应的 Promise

​

定义于

spaces/client.ts:277

---

​

getBuyers

▸ getBuyers(id, options?): Promise<Get2SpacesIdBuyersResponse>

获取 Space 门票购买者 根据其 ID 获取为特定 Space 购买门票的用户列表。

​

参数

名称	类型	说明
id	string	要检索的 Space 的 id。
options	GetBuyersOptions	-

​

返回

Promise<Get2SpacesIdBuyersResponse>

一个会解析为 API 响应的 Promise

​

定义于

spaces/client.ts:359

---

​

getPosts

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

获取 Space 的 Post 根据其 ID 获取在特定 Space 中分享的 Post 列表。

​

参数

名称	类型	说明
id	string	要获取的 Space 的 id。
options	GetPostsOptions	-

​

返回

Promise<Get2SpacesIdTweetsResponse>

解析为 API 响应的 Promise

​

定义位置

spaces/client.ts:433

---

​

getById

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

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

​

参数

名称	类型	描述
id	string	要获取的 Space 的 id。
options	GetByIdOptions	-

​

返回

Promise<Get2SpacesIdResponse>

解析为 API 响应的 Promise

​

定义位置

spaces/client.ts:519

---

​

getByCreatorIds

▸ getByCreatorIds(userIds, options?): Promise<Get2SpacesByCreatorIdsResponse>

按创建者 ID 获取 Spaces 检索由指定用户 ID 创建的 Spaces 的详细信息。

​

参数

名称	类型	说明
userIds	any[]	要检索的用户 id 列表。
options	GetByCreatorIdsOptions	-

​

返回

Promise<Get2SpacesByCreatorIdsResponse>

解析为 API 响应的 Promise

​

定义位置

spaces/client.ts:587