构造器
构造函数
client): AccountActivityClient
创建新的 AccountActivityClient 实例
参数
| 名称 | 类型 | 描述 |
|---|---|---|
client | Client | X API 的主客户端实例 |
返回值
AccountActivityClient
定义位置
方法
getSubscriptions
webhookId): Promise<SubscriptionsListGetResponse>
获取订阅
返回指定 webhook 的所有有效订阅列表。
参数
| 名称 | 类型 | 描述 |
|---|---|---|
webhookId | string | 要拉取其订阅的 webhook id。 |
返回
Promise<SubscriptionsListGetResponse>
解析为 API 响应的 Promise
定义位置
createReplayJob
webhookId, fromDate, toDate): Promise<ReplayJobCreateResponse>
创建回放作业
创建一个回放作业，用于检索与指定 webhook 关联的所有订阅在过去最多 5 天内的活动。
参数
| 名称 | 类型 | 描述 |
|---|---|---|
webhookId | string | webhook 配置的唯一标识符。 |
fromDate | string | 提供事件的最早（起始）UTC 时间戳（含起点），格式为 yyyymmddhhmm。 |
toDate | string | 提供事件的最晚（结束）UTC 时间戳（不含终点），格式为 yyyymmddhhmm。 |
返回
Promise<ReplayJobCreateResponse>
解析为 API 响应的 Promise
定义位置
validateSubscription
webhookId): Promise<SubscriptionsGetResponse>
验证订阅
针对给定的 webhook，检查用户的 Account Activity 订阅。
参数
| 名称 | 类型 | 描述 |
|---|---|---|
webhookId | string | 用于进行订阅校验的 webhook id。 |
返回
Promise<SubscriptionsGetResponse>
解析为 API 响应的 Promise
定义位置
createSubscription
webhookId, options?): Promise<SubscriptionsCreateResponse>
创建订阅
为用户和指定的 webhook 创建一个 Account Activity 订阅。
参数
| 名称 | 类型 | 描述 |
|---|---|---|
webhookId | string | 用于检查订阅状态的 webhook id。 |
options | CreateSubscriptionOptions | - |
返回
Promise<SubscriptionsCreateResponse>
解析为 API 响应的 Promise
定义位置
deleteSubscription
webhookId, userId): Promise<SubscriptionsDeleteResponse>
删除订阅
为指定的 webhook 和用户 ID 删除一项 Account Activity 订阅。
参数
| 名称 | 类型 | 描述 |
|---|---|---|
webhookId | string | 用于检查订阅状态的 webhook id。 |
userId | string | 要取消订阅的用户 id。 |
返回
Promise<SubscriptionsDeleteResponse>
解析为 API 响应的 Promise
定义位置
getSubscriptionCount
Promise<SubscriptionsCountGetResponse>
获取订阅数量
返回当前有效的 Account Activity 订阅数量。
返回
Promise<SubscriptionsCountGetResponse>
解析为 API 响应的 Promise