Skip to main content
Client for activity operations This client provides methods for interacting with the activity endpoints of the X API. It handles authentication, request formatting, and response parsing for all activity related operations.

Constructors

constructor

new ActivityClient(client): ActivityClient Creates a new activity client instance

Parameters

NameTypeDescription
clientClientThe main X API client instance

Returns

ActivityClient

Defined in

activity/client.ts:86

Methods

stream

stream(options?): Promise<ActivityStreamingResponse> Activity Stream Stream of X Activities

Parameters

NameType
optionsStreamOptions

Returns

Promise<ActivityStreamingResponse> Promise resolving to the API response

Defined in

activity/client.ts:99

updateSubscription

updateSubscription(subscriptionId, options?): Promise<ActivitySubscriptionUpdateResponse> Update X activity subscription Updates a subscription for an X activity event

Parameters

NameTypeDescription
subscriptionIdstringThe ID of the subscription to update.
optionsUpdateSubscriptionOptions-

Returns

Promise<ActivitySubscriptionUpdateResponse> Promise resolving to the API response

Defined in

activity/client.ts:156

deleteSubscription

deleteSubscription(subscriptionId): Promise<ActivitySubscriptionDeleteResponse> Deletes X activity subscription Deletes a subscription for an X activity event

Parameters

NameTypeDescription
subscriptionIdstringThe ID of the subscription to delete.

Returns

Promise<ActivitySubscriptionDeleteResponse> Promise resolving to the API response

Defined in

activity/client.ts:207

getSubscriptions

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:246

createSubscription

createSubscription(options?): Promise<ActivitySubscriptionCreateResponse> Create X activity subscription Creates a subscription for an X activity event

Parameters

NameType
optionsCreateSubscriptionOptions

Returns

Promise<ActivitySubscriptionCreateResponse> Promise resolving to the API response

Defined in

activity/client.ts:278