ConnectionsClient

Client para operações de connections Este client fornece métodos para interagir com os endpoints connections da X API. Ele cuida da autenticação, formatação de requisição e análise de resposta para todas as operações relacionadas a connections.

​

Construtores

​

constructor

• new ConnectionsClient(client): ConnectionsClient Cria uma nova instância do client connections

​

Parâmetros

​

Retorna

ConnectionsClient

​

Definido em

connections/client.ts:88

​

Métodos

​

getConnectionHistory

▸ getConnectionHistory(options): Promise<Response> Get Connection History Returns active and historical streaming connections with disconnect reasons for the authenticated application.

​

Parâmetros

​

Retorna

Promise<Response> Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true

​

Definido em

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

​

Parâmetros

​

Retorna

Promise<Get2ConnectionsResponse>

​

Definido em

connections/client.ts:138

---

​

deleteAll

▸ deleteAll(options): Promise<Response> Terminate all connections Terminates all active streaming connections for the authenticated application.

​

Parâmetros

​

Retorna

Promise<Response> Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true

​

Definido em

connections/client.ts:318 ▸ deleteAll(): Promise<KillAllConnectionsResponse>

​

Retorna

Promise<KillAllConnectionsResponse>

​

Definido em

connections/client.ts:327