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

Constructores

constructor

new PostsClient(client): PostsClient Crea una nueva instancia del cliente de Posts

Parámetros

NombreTipoDescripción
clientClientInstancia principal del cliente de la X API

Devuelve

PostsClient

Definido en

posts/client.ts:453

Métodos

getInsights28hr

getInsights28hr(tweetIds, granularity, requestedMetrics, options?): Promise<Get2Insights28hrResponse> Obtener insights de publicaciones en 28 horas Recupera métricas de interacción de las publicaciones especificadas durante las últimas 28 horas.

Parámetros

NombreTipoDescripción
tweetIdsany[]Lista de PostIds para métricas de 28 horas.
granularitystringGranularidad de la respuesta de métricas.
requestedMetricsany[]Métricas solicitadas para una consulta histórica.
optionsGetInsights28hrOptions-

Devuelve

Promise<Get2Insights28hrResponse> Promesa que se resuelve con la respuesta de la API

Definido en

posts/client.ts:478

searchRecent

searchRecent(query, options?): Promise<Get2TweetsSearchRecentResponse> Buscar Posts recientes Recupera Posts de los últimos 7 días que coinciden con una consulta de búsqueda.

Parámetros

NombreTipoDescripción
querystringUna consulta/regla/filtro para hacer coincidir Posts. Consulte https://t.co/rulelength para conocer la longitud máxima permitida de la consulta.
optionsSearchRecentOptions-

Devuelve

Promise<Get2TweetsSearchRecentResponse> Promesa que se resuelve con la respuesta de la API

Definido en

posts/client.ts:540

getRepostedBy

getRepostedBy(id, options?): Promise<Get2TweetsIdRetweetedByResponse> Obtener “Reposteado por” Recupera una lista de usuarios que reposteó un Post específico por su id.

Parámetros

NombreTipoDescripción
idstringUn único id de Post.
optionsGetRepostedByOptions-

Devuelve

Promise<Get2TweetsIdRetweetedByResponse> Promesa que se resuelve con la respuesta de la API

Definido en

posts/client.ts:670

getLikingUsers

getLikingUsers(id, options?): Promise<Get2TweetsIdLikingUsersResponse> Obtener usuarios a los que les gusta Recupera una lista de usuarios a los que les gustó una Post específica por su id.

Parámetros

NombreTipoDescripción
idstringUn único id de Post.
optionsGetLikingUsersOptions-

Devuelve

Promise<Get2TweetsIdLikingUsersResponse> Promesa que se resuelve con la respuesta de la API

Definido en

posts/client.ts:744

getInsightsHistorical

getInsightsHistorical(tweetIds, endTime, startTime, granularity, requestedMetrics, options?): Promise<Get2InsightsHistoricalResponse> Obtener insights históricos de Posts Recupera métricas históricas de interacción para los Posts especificados dentro de un intervalo de tiempo definido.

Parámetros

NombreTipoDescripción
tweetIdsany[]Lista de PostIds para métricas históricas.
endTimestringYYYY-MM-DDTHH:mm:ssZ. La marca de tiempo en UTC que representa el final del rango de tiempo.
startTimestringYYYY-MM-DDTHH:mm:ssZ. La marca de tiempo en UTC que representa el inicio del rango de tiempo.
granularitystringGranularidad de la respuesta de métricas.
requestedMetricsany[]Métricas solicitadas para la consulta histórica.
optionsGetInsightsHistoricalOptions-

Devuelve

Promise<Get2InsightsHistoricalResponse> Promesa que se resuelve con la respuesta de la API

Definido en

posts/client.ts:834

getReposts

getReposts(id, options?): Promise<Get2TweetsIdRetweetsResponse> Obtener Reposts Recupera una lista de Posts que hacen repost de un Post específico por su id.

Parámetros

NombreTipoDescripción
idstringUn ID de Post único.
optionsGetRepostsOptions-

Devuelve

Promise<Get2TweetsIdRetweetsResponse> Promesa que se resuelve con la respuesta de la API

Definido en

posts/client.ts:906

hideReply

hideReply(tweetId, options?): Promise<TweetHideResponse> Ocultar respuesta Oculta o deja de ocultar una respuesta en una conversación cuyo propietario es el usuario autenticado.

Parámetros

NombreTipoDescripción
tweetIdstringEl id de la respuesta que desea ocultar o volver a mostrar.
optionsHideReplyOptions-

Devuelve

Promise<TweetHideResponse> Promesa que se resuelve con la respuesta de la API

Definido en

posts/client.ts:998

getCountsRecent

getCountsRecent(query, options?): Promise<Get2TweetsCountsRecentResponse> Obtiene el recuento de Posts recientes Recupera el recuento de Posts de los últimos 7 días que coinciden con una consulta de búsqueda.

Parámetros

NombreTipoDescripción
querystringUna consulta/regla/filtro para coincidir con Posts. Consulta https://t.co/rulelength para identificar la longitud máxima de la consulta.
optionsGetCountsRecentOptions-

Devuelve

Promise<Get2TweetsCountsRecentResponse> Promesa que se resuelve con la respuesta de la API

Definido en

posts/client.ts:1046

getByIds

getByIds(ids, options?): Promise<Get2TweetsResponse> Obtener Posts por id Recupera los detalles de varios Posts por su id.

Parámetros

NombreTipoDescripción
idsany[]Una lista de id de Post separada por comas. Se permiten hasta 100 en una sola solicitud.
optionsGetByIdsOptions-

Devuelve

Promise<Get2TweetsResponse> Promesa que se resuelve con la respuesta de la API

Definido en

posts/client.ts:1140

create

create(body): Promise<TweetCreateResponse> Crear o editar Post Crea un nuevo Post para el usuario autenticado o edita un Post existente cuando se proporcionan edit_options.

Parámetros

NombreTipoDescripción
bodyTweetCreateRequestCuerpo de la solicitud

Devuelve

Promise<TweetCreateResponse> Promesa que se resuelve con la respuesta de la API

Definido en

posts/client.ts:1220

getById

getById(id, options?): Promise<Get2TweetsIdResponse> Obtener Post por id Recupera los detalles de un Post específico por su id.

Parámetros

NombreTipoDescripción
idstringUn único id de Post.
optionsGetByIdOptions-

Devuelve

Promise<Get2TweetsIdResponse> Promesa que se resuelve con la respuesta de la API

Definido en

posts/client.ts:1258

delete

delete(id): Promise<TweetDeleteResponse> Eliminar Post Elimina un Post específico por su id, si es propiedad del usuario autenticado.

Parámetros

NombreTipoDescripción
idstringEl id del Post que se eliminará.

Devuelve

Promise<TweetDeleteResponse> Promesa que se resuelve con la respuesta de la API

Definido en

posts/client.ts:1338

getAnalytics

getAnalytics(ids, endTime, startTime, granularity, options?): Promise<Analytics> Obtener analíticas de Posts Recupera datos analíticos de los Posts especificados dentro de un rango de tiempo definido.

Parámetros

NombreTipoDescripción
idsany[]Una lista de IDs de Post separada por comas. Se permiten hasta 100 en una sola solicitud.
endTimestringYYYY-MM-DDTHH:mm:ssZ. La marca de tiempo en UTC que representa el final del intervalo.
startTimestringYYYY-MM-DDTHH:mm:ssZ. La marca de tiempo en UTC que representa el inicio del intervalo.
granularitystringLa granularidad de los resultados de recuento de búsquedas.
optionsGetAnalyticsOptions-

Devuelve

Promise<Analytics> Promesa que se resuelve con la respuesta de la API

Definido en

posts/client.ts:1388

getCountsAll

getCountsAll(query, options?): Promise<Get2TweetsCountsAllResponse> Obtener el recuento de todas las Publicaciones Recupera el recuento de Publicaciones que coinciden con una consulta de búsqueda en el archivo completo.

Parámetros

NombreTipoDescripción
querystringUna consulta/regla/filtro para hacer coincidir Posts. Consulta https://t.co/rulelength para ver la longitud máxima permitida de la consulta.
optionsGetCountsAllOptions-

Devuelve

Promise<Get2TweetsCountsAllResponse> Promesa que se resuelve con la respuesta de la API

Definido en

posts/client.ts:1455

getQuoted

getQuoted(id, options?): Promise<Get2TweetsIdQuoteTweetsResponse> Obtener Posts citados Recupera una lista de Posts que citan un Post específico por su id.

Parámetros

NombreTipoDescripción
idstringUn único id de Post.
optionsGetQuotedOptions-

Devuelve

Promise<Get2TweetsIdQuoteTweetsResponse> Promesa que se resuelve con la respuesta de la API

Definido en

posts/client.ts:1549

searchAll

searchAll(query, options?): Promise<Get2TweetsSearchAllResponse> Buscar en todos los Posts Recupera Posts del archivo completo que coinciden con una consulta de búsqueda.

Parámetros

NombreTipoDescripción
querystringUna consulta/regla/filtro para coincidir con Posts. Consulte https://t.co/rulelength para conocer la longitud máxima de la consulta.
optionsSearchAllOptions-

Devuelve

Promise<Get2TweetsSearchAllResponse> Promesa que se resuelve en la respuesta de la API

Definido en

posts/client.ts:1647