ActivityClient

activity 操作向けのクライアント このクライアントは X API の activity エンドポイントと対話するためのメソッドを提供します。認証、リクエストの整形、activity に関連するすべての操作のレスポンス解析を扱います。

​

コンストラクター

​

コンストラクター

• new ActivityClient(client): ActivityClient 新しい activity クライアントインスタンスを作成します

​

パラメーター

​

戻り値

ActivityClient

​

定義場所

activity/client.ts:118

​

メソッド

​

getSubscriptions

▸ getSubscriptions(options): Promise<Response> Get X activity subscriptions Get a list of active subscriptions for XAA

​

パラメーター

​

戻り値

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

​

定義場所

activity/client.ts:159 ▸ getSubscriptions(): Promise<ActivitySubscriptionGetResponse>

​

戻り値

Promise<ActivitySubscriptionGetResponse>

​

定義場所

activity/client.ts:168

---

​

createSubscription

▸ createSubscription(options): Promise<Response> Create X activity subscription Creates a subscription for an X activity event

​

パラメーター

​

戻り値

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

​

定義場所

activity/client.ts:237 ▸ createSubscription(options?): Promise<ActivitySubscriptionCreateResponse>

​

パラメーター

​

戻り値

Promise<ActivitySubscriptionCreateResponse>

​

定義場所

activity/client.ts:246

---

​

stream

▸ stream(options): Promise<Response> Activity Stream Stream of X Activities

​

パラメーター

​

戻り値

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

​

定義場所

activity/client.ts:332 ▸ stream(options?): Promise<ActivityStreamingResponse>

​

パラメーター

​

戻り値

Promise<ActivityStreamingResponse>

​

定義場所

activity/client.ts:341

---

​

updateSubscription

▸ updateSubscription(subscriptionId, options): Promise<Response> Update X activity subscription Updates a subscription for an X activity event

​

パラメーター

​

戻り値

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

​

定義場所

activity/client.ts:487 ▸ updateSubscription(subscriptionId, options?): Promise<ActivitySubscriptionUpdateResponse>

​

パラメーター

​

戻り値

Promise<ActivitySubscriptionUpdateResponse>

​

定義場所

activity/client.ts:500

---

​

deleteSubscription

▸ deleteSubscription(subscriptionId, options): Promise<Response> Deletes X activity subscription Deletes a subscription for an X activity event

​

パラメーター

​

戻り値

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

​

定義場所

activity/client.ts:602 ▸ deleteSubscription(subscriptionId): Promise<ActivitySubscriptionDeleteResponse>

​

パラメーター

​

戻り値

Promise<ActivitySubscriptionDeleteResponse>

​

定義場所

activity/client.ts:615