Skip to main content
Cliente para operaciones de communities This client provides methods for interacting with the communities endpoints of the X API. It handles authentication, request formatting, and response parsing for all communities related operations.

Constructores

constructor

new CommunitiesClient(client): CommunitiesClient Creates a new communities client instance

Parámetros

Devuelve

CommunitiesClient

Definido en

communities/client.ts:102

Métodos

search(query, options): Promise<Response> Search Communities Retrieves a list of Communities matching the specified search query.

Parámetros

Devuelve

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

Definido en

communities/client.ts:147 search(query, options?): Promise<Get2CommunitiesSearchResponse>

Parámetros

Devuelve

Promise<Get2CommunitiesSearchResponse>

Definido en

communities/client.ts:160

getById

getById(id, options): Promise<Response> Get Community by ID Retrieves details of a specific Community by its ID.

Parámetros

Devuelve

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

Definido en

communities/client.ts:352 getById(id, options?): Promise<Get2CommunitiesIdResponse>

Parámetros

Devuelve

Promise<Get2CommunitiesIdResponse>

Definido en

communities/client.ts:365