CommunitiesClient

コミュニティ関連の操作を行うための Client

この Client は、X API のコミュニティ関連エンドポイントとやり取りするためのメソッドを提供します。認証、リクエストのフォーマット、レスポンスの解析を処理し、コミュニティに関連するすべての操作を扱います。

​

コンストラクタ

​

constructor

• new CommunitiesClient(client): CommunitiesClient

新しい Communities クライアントのインスタンスを作成します

​

パラメーター

Name	Type	Description
client	Client	メインの X API 用 Client インスタンス

​

戻り値

CommunitiesClient

​

定義場所

communities/client.ts:102

​

メソッド

​

search

▸ search(query, options): Promise<Response>

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

​

パラメーター

Name	Type	Description
query	string	コミュニティ検索用のクエリ。
options	SearchOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンス、または requestOptions.raw が true の場合は生の Response に解決される Promise

​

定義元

communities/client.ts:147

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

​

パラメータ

名前	type
query	string
options?	SearchOptions

​

戻り値

Promise<Get2CommunitiesSearchResponse>

​

定義元

communities/client.ts:160

---

​

getById

▸ getById(id, options): Promise<Response>

ID でコミュニティを取得する
指定した ID のコミュニティの詳細情報を取得します。

​

パラメータ

名前	型	説明
id	string	Community の ID。
options	GetByIdOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンスで解決される Promise。requestOptions.raw が true の場合は生の Response で解決されます

​

定義場所

communities/client.ts:352

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

​

パラメーター

名前	型
id	string
options?	GetByIdOptions

​

戻り値

Promise<Get2CommunitiesIdResponse>

​

定義元

communities/client.ts:365