ActivityClient

Cliente para operaciones de actividad

Este cliente proporciona métodos para interactuar con los endpoints de actividad de la X API. Se encarga de 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 de ActivityClient.

​

Parámetros

Nombre	Tipo	Descripción
client	Client	La instancia principal de Client de X API

​

Devuelve

ActivityClient

​

Definido en

activity/client.ts:118

​

Métodos

​

getSubscriptions

▸ getSubscriptions(options): Promise<Response>

Obtener suscripciones de actividad de X
Obtener una lista de suscripciones activas para XAA

​

Parámetros

Nombre	type
options	Object
options.requestOptions	Object
options.requestOptions.raw	true

​

Devuelve

Promise<Response>

Promesa que se resuelve con la respuesta de la API, o el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

activity/client.ts:159

▸ getSubscriptions(): Promise<ActivitySubscriptionGetResponse>

​

Devuelve

Promise<ActivitySubscriptionGetResponse>

​

Definido en

activity/client.ts:168

---

​

createSubscription

▸ createSubscription(options): Promise<Response>

Crear suscripción de actividad en X Crea una suscripción para un evento de actividad en X

​

Parámetros

Nombre	type
options	CreateSubscriptionOptions & { requestOptions: { raw: true } }

​

Returns

Promise<Response>

Promise que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

activity/client.ts:237

▸ createSubscription(options?): Promise<ActivitySubscriptionCreateResponse>

​

Parámetros

Nombre	type
options?	CreateSubscriptionOptions

​

Devuelve

Promise<ActivitySubscriptionCreateResponse>

​

Definido en

activity/client.ts:246

---

​

stream

▸ stream(options): Promise<Response>

Activity Stream Flujo de actividades de X

​

Parámetros

Nombre	Type
options	StreamOptions & { requestOptions: { raw: true } }

​

Devuelve

Promise<Response>

Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

activity/client.ts:332

▸ stream(options?): Promise<ActivityStreamingResponse>

​

Parámetros

Nombre	Type
options?	StreamOptions

​

Devuelve

Promise<ActivityStreamingResponse>

​

Definido en

activity/client.ts:341

---

​

updateSubscription

▸ updateSubscription(subscriptionId, options): Promise<Response>

Actualizar una suscripción de actividad de X Actualiza una suscripción para un evento de actividad de X

​

Parámetros

Nombre	Tipo	Descripción
subscriptionId	string	El ID de la suscripción que se va a actualizar.
options	UpdateSubscriptionOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

Promesa que se resuelve en la respuesta de la API, o en el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

activity/client.ts:487

▸ updateSubscription(subscriptionId, options?): Promise<ActivitySubscriptionUpdateResponse>

​

Parámetros

Nombre	Tipo
subscriptionId	string
options?	UpdateSubscriptionOptions

​

Devuelve

Promise<ActivitySubscriptionUpdateResponse>

​

Definido en

activity/client.ts:500

---

​

deleteSubscription

▸ deleteSubscription(subscriptionId, options): Promise<Response>

Elimina una suscripción de actividad de X
Elimina una suscripción a un evento de actividad de X

​

Parámetros

Nombre	Tipo	Descripción
subscriptionId	string	El ID de la suscripción que se va a eliminar.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Devuelve

Promise<Response>

Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

activity/client.ts:602

▸ deleteSubscription(subscriptionId): Promise<ActivitySubscriptionDeleteResponse>

​

Parámetros

Nombre	Tipo
subscriptionId	string

​

Devuelve

Promise<ActivitySubscriptionDeleteResponse>

​

Definido en

activity/client.ts:615