Constructors
constructor
• new ActivityClient(client): ActivityClient
Creates a new activity client instance
Parameters
| Name | Type | Description | 
|---|---|---|
client | Client | The main X API client instance | 
Returns
ActivityClient
Defined in
activity/client.ts:86Methods
stream
▸ stream(options?): Promise<ActivityStreamingResponse>
Activity Stream
Stream of X Activities
Parameters
| Name | Type | 
|---|---|
options | StreamOptions | 
Returns
Promise<ActivityStreamingResponse>
Promise resolving to the API response
Defined in
activity/client.ts:99updateSubscription
▸ updateSubscription(subscriptionId, options?): Promise<ActivitySubscriptionUpdateResponse>
Update X activity subscription
Updates a subscription for an X activity event
Parameters
| Name | Type | Description | 
|---|---|---|
subscriptionId | string | The ID of the subscription to update. | 
options | UpdateSubscriptionOptions | - | 
Returns
Promise<ActivitySubscriptionUpdateResponse>
Promise resolving to the API response
Defined in
activity/client.ts:156deleteSubscription
▸ deleteSubscription(subscriptionId): Promise<ActivitySubscriptionDeleteResponse>
Deletes X activity subscription
Deletes a subscription for an X activity event
Parameters
| Name | Type | Description | 
|---|---|---|
subscriptionId | string | The ID of the subscription to delete. | 
Returns
Promise<ActivitySubscriptionDeleteResponse>
Promise resolving to the API response
Defined in
activity/client.ts:207getSubscriptions
▸ getSubscriptions():Promise<ActivitySubscriptionGetResponse>
Get X activity subscriptions
Get a list of active subscriptions for XAA
Returns
Promise<ActivitySubscriptionGetResponse>
Promise resolving to the API response
Defined in
activity/client.ts:246createSubscription
▸ createSubscription(options?): Promise<ActivitySubscriptionCreateResponse>
Create X activity subscription
Creates a subscription for an X activity event
Parameters
| Name | Type | 
|---|---|
options | CreateSubscriptionOptions | 
Returns
Promise<ActivitySubscriptionCreateResponse>
Promise resolving to the API response