コンストラクタ
constructor
client): AccountActivityClient
新しい AccountActivityClient インスタンスを作成します
パラメーター
| 名前 | 型 | 説明 |
|---|---|---|
client | Client | X API のメイン Client インスタンス |
戻り値
AccountActivityClient
定義元
account_activity/client.ts:70メソッド
getSubscriptions
webhookId, options): Promise<Response>
サブスクリプションを取得します指定した webhook に対するすべての有効なサブスクリプションのリストを取得します。
パラメータ
| Name | Type | Description |
|---|---|---|
webhookId | string | サブスクリプションを取得する対象の webhook の ID。 |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
戻り値
Promise<Response>
API レスポンス、または requestOptions.raw が true の場合は生の Response に解決される Promise
定義場所
webhookId): Promise<SubscriptionsListGetResponse>
パラメータ
| 名前 | 型 |
|---|---|
webhookId | string |
戻り値
Promise<SubscriptionsListGetResponse>
定義元
account_activity/client.ts:128deleteSubscription
webhookId, userId, options): Promise<Response>
サブスクリプションを削除します指定された webhook とユーザーIDに対する Account Activity サブスクリプションを削除します。
パラメーター
| Name | Type | Description |
|---|---|---|
webhookId | string | サブスクリプション対象を確認するための webhook の ID。 |
userId | string | サブスクリプションを解除するユーザーの ID。 |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
戻り値
Promise<Response>
API レスポンス、または requestOptions.raw が true の場合は生の Response を返す Promise
定義元
account_activity/client.ts:217 ▸ deleteSubscription(webhookId, userId): Promise<SubscriptionsDeleteResponse>
パラメーター
| 名前 | 型 |
|---|---|
webhookId | string |
userId | string |
戻り値
Promise<SubscriptionsDeleteResponse>
定義元
account_activity/client.ts:234validateSubscription
webhookId, options): Promise<Response>
サブスクリプションを検証します指定された webhook に対するユーザーの Account Activity サブスクリプションが有効かどうかを確認します。
パラメーター
| Name | Type | Description |
|---|---|---|
webhookId | string | サブスクリプションを検証する対象の webhook の id。 |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
戻り値
Promise<Response>
API レスポンス (requestOptions.raw が true の場合は生の Response) に解決される Promise
定義場所
webhookId): Promise<SubscriptionsGetResponse>
パラメータ
| 名前 | 型 |
|---|---|
webhookId | string |
戻り値
Promise<SubscriptionsGetResponse>
定義場所
createSubscription
webhookId, options): Promise<Response>
サブスクリプションを作成しますユーザーと指定された webhook 向けの Account Activity サブスクリプションを作成します。
Parameters
| Name | Type | Description |
|---|---|---|
webhookId | string | サブスクリプションを確認する対象となる webhook ID。 |
options | CreateSubscriptionOptions & { requestOptions: { raw: true } } | - |
戻り値
Promise<Response>
API レスポンス、または requestOptions.raw が true の場合は生の Response へと resolve される Promise
定義元
account_activity/client.ts:435 ▸ createSubscription(webhookId, options?): Promise<SubscriptionsCreateResponse>
パラメーター
| 名前 | 型 |
|---|---|
webhookId | string |
options? | CreateSubscriptionOptions |
戻り値
Promise<SubscriptionsCreateResponse>
定義元
account_activity/client.ts:448createReplayJob
webhookId, fromDate, toDate, options): Promise<Response>
リプレイジョブを作成します
指定された webhook に関連付けられているすべてのサブスクリプションに対して、最大過去 5 日間のアクティビティを取得するリプレイジョブを作成します。
パラメーター
| Name | Type | Description |
|---|---|---|
webhookId | string | webhook 設定の一意の識別子。 |
fromDate | string | イベントが提供される開始時点を表す最も古い UTC タイムスタンプ (含む) 。yyyymmddhhmm 形式。 |
toDate | string | イベントが提供される終了時点を表す最新の UTC タイムスタンプ (含まない) 。yyyymmddhhmm 形式。 |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
戻り値
Promise<Response>
API レスポンスを返す Promise。requestOptions.raw が true の場合は、生の Response。
定義元
account_activity/client.ts:564 ▸ createReplayJob(webhookId, fromDate, toDate): Promise<ReplayJobCreateResponse>
パラメーター
| 名前 | 型 |
|---|---|
webhookId | string |
fromDate | string |
toDate | string |
戻り値
Promise<ReplayJobCreateResponse>
定義場所
getSubscriptionCount
options): Promise<Response>
サブスクリプション数の取得
現在アクティブな Account Activity サブスクリプション数を取得します。
パラメーター
| Name | Type |
|---|---|
options | Object |
options.requestOptions | Object |
options.requestOptions.raw | true |
Returns
Promise<Response>
API レスポンスで解決される Promise。requestOptions.raw が true の場合は生の Response
定義元
account_activity/client.ts:704 ▸ getSubscriptionCount():Promise<SubscriptionsCountGetResponse>
戻り値
Promise<SubscriptionsCountGetResponse>