CommunitiesClient

コミュニティ機能向けクライアント

このクライアントは、X API のコミュニティ関連エンドポイントと連携するためのメソッドを提供します。コミュニティに関するすべての操作について、認証、リクエストの整形、レスポンスの解析を処理します。

​

コンストラクタ

​

constructor

• new CommunitiesClient(client): CommunitiesClient

新しい CommunitiesClient インスタンスを作成します

​

パラメータ

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

コミュニティを検索 指定した検索クエリに一致するコミュニティのリストを取得します。

​

パラメータ

名前	型	説明
query	string	コミュニティを検索するためのクエリ。
options	SearchOptions	-

​

戻り値

Promise<Get2CommunitiesSearchResponse>

API レスポンスに解決される Promise

​

定義箇所

communities/client.ts:135