ConnectionsClient

Client pour les opérations de connexion

Ce client fournit des méthodes pour interagir avec les endpoints de connexion de X API. Il gère l’authentification, le formatage des requêtes et le traitement des réponses pour toutes les opérations liées aux connexions.

​

Constructeurs

​

constructor

• new ConnectionsClient(client): ConnectionsClient

Crée une nouvelle instance de ConnectionsClient

​

Paramètres

Nom	Type	Description
client	Client	L’instance principale du Client de X API

​

Renvoie

ConnectionsClient

​

Défini dans

connections/client.ts:88

​

Méthodes

​

getConnectionHistory

▸ getConnectionHistory(options): Promise<Response>

Récupérer l’historique des connexions Renvoie les connexions de streaming actives et passées, avec les raisons de déconnexion, pour l’App authentifiée.

​

Paramètres

Nom	Type
options	GetConnectionHistoryOptions & { requestOptions: { raw: true } }

​

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est à true

​

Défini dans

connections/client.ts:129

▸ getConnectionHistory(options?): Promise<Get2ConnectionsResponse>

​

Paramètres

Nom	Type
options?	GetConnectionHistoryOptions

​

Renvoie

Promise<Get2ConnectionsResponse>

​

Défini dans

connections/client.ts:138

---

​

deleteAll

▸ deleteAll(options): Promise<Response>

Met fin à toutes les connexions Met fin à toutes les connexions de streaming actives pour l’App authentifiée.

​

Paramètres

Nom	Type
options	Object
options.requestOptions	Object
options.requestOptions.raw	true

​

Renvoie

Promise<Response>

Promise qui se résout vers la réponse de l’API, ou en un objet Response brut si requestOptions.raw est défini sur true

​

Définie dans

connections/client.ts:318

▸ deleteAll(): Promise<KillAllConnectionsResponse>

​

Renvoie

Promise<KillAllConnectionsResponse>

​

Défini dans

connections/client.ts:327