CommunitiesClient

Cliente para operaciones de comunidades

Este cliente proporciona métodos para interactuar con los endpoints de comunidades de la X API. Gestiona la autenticación, el formateo de las solicitudes y el análisis de las respuestas para todas las operaciones relacionadas con comunidades.

​

Constructores

​

constructor

• new CommunitiesClient(client): CommunitiesClient

Crea una nueva instancia del cliente CommunitiesClient

​

Parámetros

Nombre	Tipo	Descripción
client	Client	Instancia principal del cliente de la X API

​

Devuelve

CommunitiesClient

​

Definido en

communities/client.ts:68

​

Métodos

​

getById

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

Obtener comunidad por id Obtiene los detalles de una comunidad específica por su id.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El id de la comunidad.
options	GetByIdOptions	-

​

Devuelve

Promise<Get2CommunitiesIdResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

communities/client.ts:85

---

​

search

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

Buscar Communities Obtiene una lista de Communities que coinciden con la consulta de búsqueda especificada.

​

Parámetros

Nombre	Tipo	Descripción
query	string	Cadena de búsqueda para encontrar comunidades.
options	SearchOptions	-

​

Valores devueltos

Promise<Get2CommunitiesSearchResponse>

Promesa que se resuelve en la respuesta de la API

​

Definido en

communities/client.ts:135