ActivityClient

アクティビティ操作用の Client

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

​

コンストラクタ

​

constructor

• new ActivityClient(client): ActivityClient

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

​

パラメーター

名前	型	説明
client	Client	X API のメイン Client インスタンス

​

戻り値

ActivityClient

​

定義場所

activity/client.ts:118

​

メソッド

​

getSubscriptions

▸ getSubscriptions(options): Promise<Response>

X のアクティビティサブスクリプションを取得します
XAA の有効なサブスクリプションの一覧を取得します

​

パラメーター

名前	type
options	Object
options.requestOptions	Object
options.requestOptions.raw	true

​

戻り値

Promise<Response>

API レスポンス、または requestOptions.raw が true の場合は生の Response オブジェクトで解決される Promise

​

定義場所

activity/client.ts:159

▸ getSubscriptions(): Promise<ActivitySubscriptionGetResponse>

​

戻り値

Promise<ActivitySubscriptionGetResponse>

​

定義元

activity/client.ts:168

---

​

createSubscription

▸ createSubscription(options): Promise<Response>

X アクティビティサブスクリプションを作成します
X アクティビティイベント向けのサブスクリプションを作成します

​

パラメーター

パラメーター名	type
options	CreateSubscriptionOptions & { requestOptions: { raw: true } }

​

Returns

Promise<Response>

API レスポンスを返す Promise、または requestOptions.raw が true の場合は生の Response

​

定義場所

activity/client.ts:237

▸ createSubscription(options?): Promise<ActivitySubscriptionCreateResponse>

​

パラメーター

名前	type
options?	CreateSubscriptionOptions

​

戻り値

Promise<ActivitySubscriptionCreateResponse>

​

定義元

activity/client.ts:246

---

​

stream

▸ stream(options): Promise<Response>

アクティビティストリーム X上のアクティビティストリーム

​

パラメーター

名前	type
options	StreamOptions & { requestOptions: { raw: true } }

​

戻り値

Promise<Response>

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

​

定義場所

activity/client.ts:332

▸ stream(options?): Promise<ActivityStreamingResponse>

​

パラメータ

名前	type
options?	StreamOptions

​

戻り値

Promise<ActivityStreamingResponse>

​

定義場所

activity/client.ts:341

---

​

updateSubscription

▸ updateSubscription(subscriptionId, options): Promise<Response>

X アクティビティのサブスクリプションを更新します
X アクティビティイベント用のサブスクリプションを更新します

​

パラメーター

Name	Type	Description
subscriptionId	string	更新するサブスクリプションのID
options	UpdateSubscriptionOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンスを返す Promise。requestOptions.raw が true の場合は生の Response を返す

​

定義場所

activity/client.ts:487

▸ updateSubscription(subscriptionId, options?): Promise<ActivitySubscriptionUpdateResponse>

​

パラメータ

名前	型
subscriptionId	string
options?	UpdateSubscriptionOptions

​

戻り値

Promise<ActivitySubscriptionUpdateResponse>

​

定義元

activity/client.ts:500

---

​

deleteSubscription

▸ deleteSubscription(subscriptionId, options): Promise<Response>

X アクティビティのサブスクリプションを削除します
X アクティビティイベント向けのサブスクリプションを削除します

​

パラメーター

名前	型	説明
subscriptionId	string	削除するサブスクリプションの ID
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Returns

Promise<Response>

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

​

定義場所

activity/client.ts:602

▸ deleteSubscription(subscriptionId): Promise<ActivitySubscriptionDeleteResponse>

​

パラメータ

名称	型
subscriptionId	string

​

戻り値

Promise<ActivitySubscriptionDeleteResponse>

​

定義元

activity/client.ts:615