CommunitiesClient

Client pour les opérations relatives aux communautés

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

Constructeurs

constructor

• new CommunitiesClient(client): CommunitiesClient

Crée une nouvelle instance de CommunitiesClient

Paramètres

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

Renvoie

CommunitiesClient

Défini dans

communities/client.ts:102

Méthodes

search

▸ search(query, options): Promise<Response>

Recherche de communautés Récupère une liste de communautés correspondant à la requête de recherche fournie.

Paramètres

Nom	Type	Description
query	string	Requête permettant de rechercher des communautés.
options	SearchOptions & { requestOptions: { raw: true } }	-

Renvoie

Promise<Response>

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

Défini dans

communities/client.ts:147

▸ search(query, options?): Promise<Get2CommunitiesSearchResponse>

Paramètres

Nom	Type
query	string
options?	SearchOptions

Renvoie

Promise<Get2CommunitiesSearchResponse>

Défini dans

communities/client.ts:160

---

getById

▸ getById(id, options): Promise<Response>

Récupérer une communauté par identifiant Récupère les détails d’une communauté spécifique à partir de son identifiant.

Paramètres

Nom	Type	Description
id	string	L’identifiant de la communauté.
options	GetByIdOptions & { requestOptions: { raw: true } }	-

Renvoie

Promise<Response>

Promise se résolvant en la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true

Défini dans

communities/client.ts:352

▸ getById(id, options?): Promise<Get2CommunitiesIdResponse>

Paramètres

Nom	Type
id	string
options?	GetByIdOptions

Renvoie

Promise<Get2CommunitiesIdResponse>

Défini dans

communities/client.ts:365