ConnectionsClient

Cliente para operaciones de conexiones Este cliente proporciona métodos para interactuar con los endpoints de conexiones de la X API. Se encarga de la autenticación, el formateo de las solicitudes y el análisis de las respuestas para todas las operaciones relacionadas con las conexiones.

Constructores

constructor

• new ConnectionsClient(client): ConnectionsClient Crea una nueva instancia de ConnectionsClient

Parámetros

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

Devuelve

ConnectionsClient

Definido en

connections/client.ts:88

Métodos

getConnectionHistory

▸ getConnectionHistory(options): Promise<Response> Obtiene el historial de conexiones
Devuelve las conexiones de streaming activas y anteriores, junto con los motivos de desconexión de la aplicación autenticada.

Parámetros

Nombre	Tipo
`options`	`GetConnectionHistoryOptions` & { `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

connections/client.ts:129 ▸ getConnectionHistory(options?): Promise<Get2ConnectionsResponse>

Parámetros

Nombre	Type
`options?`	`GetConnectionHistoryOptions`

Devuelve

Promise<Get2ConnectionsResponse>

Definido en

connections/client.ts:138

deleteAll

▸ deleteAll(options): Promise<Response> Terminar todas las conexiones Termina todas las conexiones de streaming activas de la App autenticada.

Parámetros

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

Returns

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