Saltar al contenido principal
Cliente para operaciones de actividad Este cliente proporciona métodos para interactuar con los endpoints de actividad de la X API. Gestiona la autenticación, el formateo de las solicitudes y el procesamiento de las respuestas para todas las operaciones relacionadas con la actividad.

Constructores

constructor

new ActivityClient(client): ActivityClient Crea una nueva instancia del cliente de actividad

Parámetros

NombreTipoDescripción
clientClientLa instancia principal del cliente de la X API

Devuelve

ActivityClient

Definido en

activity/client.ts:86

Métodos

stream

stream(options?): Promise<ActivityStreamingResponse> Flujo de actividad Flujo de actividades de X

Parámetros

NombreTipo
optionsStreamOptions

Devuelve

Promise<ActivityStreamingResponse> Promesa que se resuelve con la respuesta de la API

Definido en

activity/client.ts:99

updateSubscription

updateSubscription(subscriptionId, options?): Promise<ActivitySubscriptionUpdateResponse> Actualizar la suscripción de actividad de X Actualiza una suscripción a un evento de actividad de X

Parámetros

NombreTipoDescripción
subscriptionIdstringEl id de la suscripción que se va a actualizar.
optionsUpdateSubscriptionOptions-

Devuelve

Promise<ActivitySubscriptionUpdateResponse> Promesa que se resuelve con la respuesta de la API

Definido en

activity/client.ts:156

deleteSubscription

deleteSubscription(subscriptionId): Promise<ActivitySubscriptionDeleteResponse> Elimina la suscripción de actividad de X Elimina una suscripción a un evento de actividad de X

Parámetros

NombreTipoDescripción
subscriptionIdstringEl id de la suscripción que se eliminará.

Devuelve

Promise<ActivitySubscriptionDeleteResponse> Promesa que se resuelve con la respuesta de la API

Definido en

activity/client.ts:207

getSubscriptions

getSubscriptions(): Promise<ActivitySubscriptionGetResponse> Obtener suscripciones de actividad de X Obtener la lista de suscripciones activas para XAA

Devuelve

Promise<ActivitySubscriptionGetResponse> Promesa que se resuelve con la respuesta de la API

Definido en

activity/client.ts:246

createSubscription

createSubscription(options?): Promise<ActivitySubscriptionCreateResponse> Crear una suscripción de actividad en X Crea una suscripción para un evento de actividad en X

Parámetros

NombreTipo
optionsCreateSubscriptionOptions

Devuelve

Promise<ActivitySubscriptionCreateResponse> Promesa que se resuelve con la respuesta de la API

Definido en

activity/client.ts:278