ConnectionsClient

Client for connections operations This client provides methods for interacting with the connections endpoints of the X API. It handles authentication, request formatting, and response parsing for all connections related operations.

​

Constructors

​

constructor

• new ConnectionsClient(client): ConnectionsClient Creates a new connections client instance

​

Parameters

​

Returns

ConnectionsClient

​

Defined in

connections/client.ts:88

​

Methods

​

getConnectionHistory

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

​

Parameters

​

Returns

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Defined in

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

​

Parameters

​

Returns

Promise<Get2ConnectionsResponse>

​

Defined in

connections/client.ts:138

---

​

deleteAll

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

​

Parameters

​

Returns

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Defined in

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

​

Returns

Promise<KillAllConnectionsResponse>

​

Defined in

connections/client.ts:327