CommunitiesClient

用于社区相关操作的客户端

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

​

构造器

​

构造函数

• new CommunitiesClient(client): CommunitiesClient

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

​

参数

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

​

返回值

CommunitiesClient

​

定义于

communities/client.ts:68

​

方法

​

getById

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

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

​

参数

名称	类型	说明
id	string	社区的 id。
options	GetByIdOptions	-

​

返回

Promise<Get2CommunitiesIdResponse>

解析为 API 响应的 Promise

​

定义位置

communities/client.ts:85

---

​

search

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

搜索 Communities 返回与指定搜索条件匹配的 Communities 列表。

​

参数

名称	类型	描述
query	string	搜索社区的查询字符串。
options	SearchOptions	-

​

返回

Promise<Get2CommunitiesSearchResponse>

解析为 API 响应的 Promise

​

定义位置

communities/client.ts:135