SpacesClient

スペース操作用の Client

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

​

コンストラクタ

​

constructor

• new SpacesClient(client): SpacesClient

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

​

パラメーター

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

​

戻り値

SpacesClient

​

定義元

spaces/client.ts:316

​

メソッド

​

getByIds

▸ getByIds(ids, options): Promise<Response>

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

​

パラメーター

Name	Type	Description
ids	any[]	返却する Space の id のリスト。
options	GetByIdsOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

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

​

定義場所

spaces/client.ts:361

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

​

パラメータ

名前	型
ids	any[]
options?	GetByIdsOptions

​

戻り値

Promise<Get2SpacesResponse>

​

定義元

spaces/client.ts:374

---

​

getPosts

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

スペース内の投稿を取得 特定のスペースで共有された投稿の一覧を、そのスペースのIDを指定して取得します。

​

パラメーター

Name	Type	Description
id	string	取得対象の Space の ID。
options	GetPostsOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

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

​

定義場所

spaces/client.ts:572

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

​

パラメーター

名前	型
id	string
options?	GetPostsOptions

​

戻り値

Promise<Get2SpacesIdTweetsResponse>

​

定義元

spaces/client.ts:585

---

​

search

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

スペースを検索します 指定した検索クエリに一致するスペースの一覧を取得します。

​

パラメーター

Name	type	説明
query	string	検索クエリ。
options	SearchOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

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

​

定義場所

spaces/client.ts:835

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

​

パラメータ

名前	type
query	string
options?	SearchOptions

​

戻り値

Promise<Get2SpacesSearchResponse>

​

定義場所

spaces/client.ts:848

---

​

getBuyers

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

Space のチケット購入者を取得します
特定の Space の id を指定して、その Space のチケットを購入したユーザーのリストを取得します。

​

パラメーター

名前	型	説明
id	string	取得する Space の ID。
options	GetBuyersOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンスを解決値とする Promise。requestOptions.raw が true の場合は生の Response オブジェクト

​

定義元

spaces/client.ts:1080

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

​

パラメーター

名前	型
id	string
options?	GetBuyersOptions

​

戻り値

Promise<Get2SpacesIdBuyersResponse>

​

定義場所

spaces/client.ts:1093

---

​

getById

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

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

​

パラメーター

名前	型	説明
id	string	取得する Space の ID。
options	GetByIdOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

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

​

定義場所

spaces/client.ts:1293

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

​

パラメータ

名前	型
id	string
options?	GetByIdOptions

​

戻り値

Promise<Get2SpacesIdResponse>

​

定義場所

spaces/client.ts:1306

---

​

getByCreatorIds

▸ getByCreatorIds(userIds, options): Promise<Response>

作成者IDでSpacesを取得します
指定したユーザーIDが作成したSpacesの詳細を取得します。

​

パラメータ

Name	Type	Description
userIds	any[]	検索対象とするユーザーのid。
options	GetByCreatorIdsOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

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

​

定義場所

spaces/client.ts:1495

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

​

パラメータ

名前	型
userIds	any[]
options?	GetByCreatorIdsOptions

​

戻り値

Promise<Get2SpacesByCreatorIdsResponse>

​

定義場所

spaces/client.ts:1508