Saltar al contenido principal
Cliente para operaciones con Spaces Este cliente proporciona métodos para interactuar con los endpoints de Spaces de la X API. Se encarga de la autenticación, el formateo de las solicitudes y el análisis de las respuestas para todas las operaciones relacionadas con Spaces.

Constructores

constructor

new SpacesClient(client): SpacesClient Crea una nueva instancia del cliente SpacesClient

Parámetros

NombreTypeDescripción
clientClientLa instancia principal de Client de la X API

Devuelve

SpacesClient

Definido en

spaces/client.ts:316

Métodos

getByIds

getByIds(ids, options): Promise<Response> Obtiene Spaces por ID Recupera los detalles de varios Spaces por sus IDs.

Parámetros

NombreTipoDescripción
idsany[]La lista de identificadores de Space que se devolverán.
optionsGetByIdsOptions & { requestOptions: { raw: true } }-

Devuelve

Promise<Response> Promesa que se resuelve en la respuesta de la API, o en el objeto Response sin procesar si requestOptions.raw es true

Definido en

spaces/client.ts:361 getByIds(ids, options?): Promise<Get2SpacesResponse>

Parámetros

NombreTipo
idsany[]
options?GetByIdsOptions

Devuelve

Promise<Get2SpacesResponse>

Definido en

spaces/client.ts:374

getPosts

getPosts(id, options): Promise<Response> Obtener publicaciones de un Space Recupera una lista de publicaciones compartidas en un Space específico por su id.

Parámetros

NombreTipoDescripción
idstringEl identificador del Space que se va a obtener.
optionsGetPostsOptions & { requestOptions: { raw: true } }-

Devuelve

Promise<Response> Promesa que se resuelve con la respuesta de la API, o el objeto Response sin procesar si requestOptions.raw es true

Definido en

spaces/client.ts:572 getPosts(id, options?): Promise<Get2SpacesIdTweetsResponse>

Parámetros

NombreTipo
idstring
options?GetPostsOptions

Devuelve

Promise<Get2SpacesIdTweetsResponse>

Definido en

spaces/client.ts:585
search(query, options): Promise<Response> Buscar Spaces Obtiene una lista de Spaces que coinciden con la consulta de búsqueda especificada.

Parámetros

NombretypeDescripción
querystringLa consulta de búsqueda.
optionsSearchOptions & { requestOptions: { raw: true } }-

Devuelve

Promise<Response> Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true

Definido en

spaces/client.ts:835 search(query, options?): Promise<Get2SpacesSearchResponse>

Parámetros

Nombretype
querystring
options?SearchOptions

Devuelve

Promise<Get2SpacesSearchResponse>

Definido en

spaces/client.ts:848

getBuyers

getBuyers(id, options): Promise<Response> Obtener compradores de entradas de un Space
Obtiene una lista de usuarios que compraron entradas para un Space específico por su id.

Parámetros

NombreTipoDescripción
idstringEl identificador del Space que se va a obtener.
optionsGetBuyersOptions & { requestOptions: { raw: true } }-

Devuelve

Promise<Response> Promesa que se resuelve en la respuesta de la API, o en el objeto Response sin procesar si requestOptions.raw es true

Definido en

spaces/client.ts:1080 getBuyers(id, options?): Promise<Get2SpacesIdBuyersResponse>

Parámetros

NombreTipo
idstring
options?GetBuyersOptions

Devuelve

Promise<Get2SpacesIdBuyersResponse>

Definido en

spaces/client.ts:1093

getById

getById(id, options): Promise<Response> Obtiene un Space por ID Recupera los detalles de un Space específico por su ID.

Parámetros

NombreTipoDescripción
idstringEl identificador del Space que se va a recuperar.
optionsGetByIdOptions & { requestOptions: { raw: true } }-

Devuelve

Promise<Response> Promise que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true

Definido en

spaces/client.ts:1293 getById(id, options?): Promise<Get2SpacesIdResponse>

Parámetros

NombreTipo
idstring
options?GetByIdOptions

Devuelve

Promise<Get2SpacesIdResponse>

Definido en

spaces/client.ts:1306

getByCreatorIds

getByCreatorIds(userIds, options): Promise<Response> Obtiene Spaces por IDs de creador
Obtiene detalles de los Spaces creados por las IDs de usuario especificadas.

Parámetros

NombreTipoDescripción
userIdsany[]Los identificadores de usuarios por los que se va a buscar.
optionsGetByCreatorIdsOptions & { requestOptions: { raw: true } }-

Devuelve

Promise<Response> Promise que se resuelve con la respuesta de la API, o el objeto Response sin procesar si requestOptions.raw es true

Definido en

spaces/client.ts:1495 getByCreatorIds(userIds, options?): Promise<Get2SpacesByCreatorIdsResponse>

Parámetros

NombreTipo
userIdsany[]
options?GetByCreatorIdsOptions

Devuelve

Promise<Get2SpacesByCreatorIdsResponse>

Definido en

spaces/client.ts:1508