SpacesClient

スペース操作用クライアント

このクライアントは、X API のスペース関連エンドポイントとやり取りするためのメソッドを提供します。認証、リクエストのフォーマット、レスポンスのパースを処理し、スペースに関するあらゆる操作をサポートします。

​

コンストラクタ

​

constructor

• new SpacesClient(client): SpacesClient

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

​

パラメータ

名前	型	説明
client	Client	X API のメインクライアントインスタンス

​

返り値

SpacesClient

​

定義場所

spaces/client.ts:190

​

メソッド

​

getByIds

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

ID で Spaces を取得 複数の Spaces の詳細を、指定した ID で取得します。

​

パラメーター

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

スペースのPostを取得 指定したIDのスペースで共有されたPostの一覧を取得します。

​

パラメーター

名称	型	説明
id	string	取得するSpaceのid。
options	GetPostsOptions	-

​

戻り値

Promise<Get2SpacesIdTweetsResponse>

API のレスポンスで解決される Promise

​

定義箇所

spaces/client.ts:433

---

​

getById

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

IDでスペースを取得 指定したIDのスペースの詳細を取得します。

​

パラメータ

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