Documentation Index
Fetch the complete documentation index at: https://generaltranslation.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
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.
• new ActivityClient(client): ActivityClient
Crea una nueva instancia de ActivityClient.
| Nombre | Tipo | Descripción |
|---|
client | Client | La instancia principal de Client de X API |
ActivityClient
activity/client.ts:118
▸ getSubscriptions(options): Promise<Response>
Obtener suscripciones de actividad de X
Obtener una lista de suscripciones activas para XAA
| Nombre | type |
|---|
options | Object |
options.requestOptions | Object |
options.requestOptions.raw | true |
Promise<Response>
Promesa que se resuelve con la respuesta de la API, o el objeto Response sin procesar si requestOptions.raw es true
activity/client.ts:159
▸ getSubscriptions(): Promise<ActivitySubscriptionGetResponse>
Promise<ActivitySubscriptionGetResponse>
activity/client.ts:168
▸ createSubscription(options): Promise<Response>
Crear suscripción de actividad en X
Crea una suscripción para un evento de actividad en X
| 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
activity/client.ts:237
▸ createSubscription(options?): Promise<ActivitySubscriptionCreateResponse>
| Nombre | type |
|---|
options? | CreateSubscriptionOptions |
Promise<ActivitySubscriptionCreateResponse>
activity/client.ts:246
▸ stream(options): Promise<Response>
Activity Stream
Flujo de actividades de X
| Nombre | Type |
|---|
options | StreamOptions & { requestOptions: { raw: true } } |
Promise<Response>
Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true
activity/client.ts:332
▸ stream(options?): Promise<ActivityStreamingResponse>
| Nombre | Type |
|---|
options? | StreamOptions |
Promise<ActivityStreamingResponse>
activity/client.ts:341
▸ updateSubscription(subscriptionId, options): Promise<Response>
Actualizar una suscripción de actividad de X
Actualiza una suscripción para un evento de actividad de X
| Nombre | Tipo | Descripción |
|---|
subscriptionId | string | El ID de la suscripción que se va a actualizar. |
options | UpdateSubscriptionOptions & { requestOptions: { raw: true } } | - |
Promise<Response>
Promesa que se resuelve en la respuesta de la API, o en el objeto Response sin procesar si requestOptions.raw es true
activity/client.ts:487
▸ updateSubscription(subscriptionId, options?): Promise<ActivitySubscriptionUpdateResponse>
| Nombre | Tipo |
|---|
subscriptionId | string |
options? | UpdateSubscriptionOptions |
Promise<ActivitySubscriptionUpdateResponse>
activity/client.ts:500
▸ deleteSubscription(subscriptionId, options): Promise<Response>
Elimina una suscripción de actividad de X
Elimina una suscripción a un evento de actividad de X
| 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 | - |
Promise<Response>
Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true
activity/client.ts:602
▸ deleteSubscription(subscriptionId): Promise<ActivitySubscriptionDeleteResponse>
| Nombre | Tipo |
|---|
subscriptionId | string |
Promise<ActivitySubscriptionDeleteResponse>
activity/client.ts:615
