ActivityClient

アクティビティ操作用クライアント

このクライアントは、X API のアクティビティエンドポイントとやり取りするための各種メソッドを提供します。アクティビティに関するあらゆる操作について、認証、リクエストの整形、レスポンスの解析を処理します。

​

コンストラクタ

​

constructor

• new ActivityClient(client): ActivityClient

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

​

パラメータ

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

​

戻り値

ActivityClient

​

定義場所

activity/client.ts:86

​

メソッド

​

stream

▸ stream(options?): Promise<ActivityStreamingResponse>

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

​

パラメータ

名称	型
options	StreamOptions

​

戻り値

Promise<ActivityStreamingResponse>

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

​

定義元

activity/client.ts:99

---

​

updateSubscription

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

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

​

パラメータ

名前	型	説明
subscriptionId	string	更新するサブスクリプションのid。
options	UpdateSubscriptionOptions	-

​

返り値

Promise<ActivitySubscriptionUpdateResponse>

API レスポンスに解決される Promise

​

定義場所

activity/client.ts:156

---

​

deleteSubscription

▸ deleteSubscription(subscriptionId): Promise<ActivitySubscriptionDeleteResponse>

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

​

パラメータ

名前	型	説明
subscriptionId	string	削除するサブスクリプションのid。

​

戻り値

Promise<ActivitySubscriptionDeleteResponse>

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

​

定義箇所

activity/client.ts:207

---

​

getSubscriptions

▸ getSubscriptions(): Promise<ActivitySubscriptionGetResponse>

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

​

返り値

Promise<ActivitySubscriptionGetResponse>

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

​

定義元

activity/client.ts:246

---

​

createSubscription

▸ createSubscription(options?): Promise<ActivitySubscriptionCreateResponse>

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

​

パラメーター

名前	型
options	CreateSubscriptionOptions

​

戻り値

Promise<ActivitySubscriptionCreateResponse>

API レスポンスに解決される Promise

​

定義元

activity/client.ts:278