ActivityClient

用于处理活动操作的客户端

该客户端提供与 X API 的活动端点进行交互的方法。它负责处理与活动相关的所有操作的身份验证、请求格式化和响应解析。

​

构造器

​

构造函数

• new ActivityClient(client): ActivityClient

创建一个新的 Activity 客户端实例

​

参数

名称	类型	描述
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