Constructores
constructor
client): UsersClient
Crea una nueva instancia del cliente de usuarios
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
client | Client | Instancia principal del cliente de la X API |
Devuelve
UsersClient
Definido en
Métodos
getMentions
id, options?): Promise<Get2UsersIdMentionsResponse>
Obtener menciones
Recupera una lista de Posts que mencionan a un usuario específico por su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del usuario que se desea consultar. |
options | GetMentionsOptions | - |
Devuelve
Promise<Get2UsersIdMentionsResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
getRepostsOfMe
options?): Promise<Get2UsersRepostsOfMeResponse>
Obtener mis Reposts
Recupera una lista de Posts que hacen repost de contenido del usuario autenticado.
Parámetros
| Nombre | Tipo |
|---|---|
options | GetRepostsOfMeOptions |
Devuelve
Promise<Get2UsersRepostsOfMeResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
getBookmarks
id, options?): Promise<Get2UsersIdBookmarksResponse>
Obtener marcadores
Recupera una lista de Posts guardados como marcadores por el usuario autenticado.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del usuario de origen autenticado para el que se devolverán los resultados. |
options | GetBookmarksOptions | - |
Devuelve
Promise<Get2UsersIdBookmarksResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
createBookmark
id, body): Promise<BookmarkMutationResponse>
Crear marcador
Añade un Post a los marcadores del usuario autenticado.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del usuario de origen autenticado para el que se agregarán marcadores. |
body | BookmarkAddRequest | Cuerpo de la solicitud |
Devuelve
Promise<BookmarkMutationResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
getBlocking
id, options?): Promise<Get2UsersIdBlockingResponse>
Obtener bloqueos
Recupera una lista de usuarios bloqueados por el id de usuario especificado.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del usuario de origen autenticado para el que se devolverán los resultados. |
options | GetBlockingOptions | - |
Devuelve
Promise<Get2UsersIdBlockingResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
getBookmarksByFolderId
id, folderId): Promise<BookmarkFolderPostsResponse>
Obtener marcadores por ID de carpeta
Recupera Posts en una carpeta de marcadores específica mediante su ID para el usuario autenticado.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del Usuario de origen autenticado para el que se deben devolver resultados. |
folderId | string | El id de la Carpeta de marcadores para la que el Usuario autenticado intenta obtener Posts. |
Devuelve
Promise<BookmarkFolderPostsResponse>
Una promesa que se resuelve con la respuesta de la API
Definido en
getById
id, options?): Promise<Get2UsersIdResponse>
Obtener usuario por id
Recupera los detalles de un usuario específico por su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del usuario que se desea consultar. |
options | GetByIdOptions | - |
Devuelve
Promise<Get2UsersIdResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
unrepostPost
id, sourceTweetId): Promise<UsersRetweetsDeleteResponse>
Quitar repost de un Post
Hace que el usuario autenticado quite el repost de un Post específico por su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del Usuario de origen autenticado que solicita volver a publicar el Post. |
sourceTweetId | string | El id del Post que el Usuario solicita deshacer el retuit. |
Devuelve
Promise<UsersRetweetsDeleteResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
getFollowers
id, options?): Promise<Get2UsersIdFollowersResponse>
Obtener seguidores
Recupera una lista de usuarios que siguen a un usuario específico por su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del usuario que se va a consultar. |
options | GetFollowersOptions | - |
Devuelve
Promise<Get2UsersIdFollowersResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
likePost
id, options?): Promise<UsersLikesCreateResponse>
Dar Me gusta a un Post
Hace que el usuario autenticado dé Me gusta a un Post específico por su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del Usuario de origen autenticado que solicita indicar que le gusta el Post. |
options | LikePostOptions | - |
Devuelve
Promise<UsersLikesCreateResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
unlikePost
id, tweetId): Promise<UsersLikesDeleteResponse>
Quitar el “Me gusta” de un Post
Hace que el usuario autenticado quite el “Me gusta” de un Post específico por su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del Usuario de origen autenticado que solicita quitar el Me gusta del Post. |
tweetId | string | El id del Post al que el Usuario solicita quitar el Me gusta. |
Devuelve
Promise<UsersLikesDeleteResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
unfollowList
id, listId): Promise<ListFollowedResponse>
Dejar de seguir la lista
Hace que el usuario autenticado deje de seguir una lista específica por su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del Usuario autenticado de origen que dejará de seguir la Lista. |
listId | string | El id de la Lista que se dejará de seguir. |
Devuelve
Promise<ListFollowedResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
getFollowing
id, options?): Promise<Get2UsersIdFollowingResponse>
Obtener cuentas que sigue
Recupera una lista de usuarios a los que sigue un usuario específico, identificado por su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del usuario que se desea consultar. |
options | GetFollowingOptions | - |
Devuelve
Promise<Get2UsersIdFollowingResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
followUser
id, options?): Promise<UsersFollowingCreateResponse>
Seguir a un usuario
Hace que el usuario autenticado siga a un usuario específico por su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del usuario de origen autenticado que solicita seguir al usuario de destino. |
options | FollowUserOptions | - |
Devuelve
Promise<UsersFollowingCreateResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
getLikedPosts
id, options?): Promise<Get2UsersIdLikedTweetsResponse>
Obtener Posts que te gustan
Recupera una lista de Posts que le han gustado a un usuario específico según su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del usuario que se va a consultar. |
options | GetLikedPostsOptions | - |
Devuelve
Promise<Get2UsersIdLikedTweetsResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
unfollowUser
sourceUserId, targetUserId): Promise<UsersFollowingDeleteResponse>
Dejar de seguir a un usuario
Hace que el usuario autenticado deje de seguir a un usuario específico por su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
sourceUserId | string | El id del Usuario de origen autenticado que solicita dejar de seguir al Usuario de destino. |
targetUserId | string | El id del Usuario al que el Usuario de origen solicita dejar de seguir. |
Devuelve
Promise<UsersFollowingDeleteResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
unpinList
id, listId): Promise<ListUnpinResponse>
Desfijar lista
Hace que el usuario autenticado desfije una lista específica por su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del usuario de origen autenticado para el que se devolverán resultados. |
listId | string | El id de la lista que se va a desafijar. |
Devoluciones
Promise<ListUnpinResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
repostPost
id, options?): Promise<UsersRetweetsCreateResponse>
Repostear un Post
Hace que el usuario autenticado republique un Post específico por su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del Usuario de origen autenticado que solicita volver a publicar el Post. |
options | RepostPostOptions | - |
Devuelve
Promise<UsersRetweetsCreateResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
getPinnedLists
id, options?): Promise<Get2UsersIdPinnedListsResponse>
Obtener listas ancladas
Recupera una lista de listas ancladas por el usuario autenticado.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del usuario de origen autenticado para el que se devolverán los resultados. |
options | GetPinnedListsOptions | - |
Devuelve
Promise<Get2UsersIdPinnedListsResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
pinList
id, body): Promise<ListPinnedResponse>
Anclar lista
Hace que el usuario autenticado ancle una Lista específica por su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del usuario de origen autenticado que fijará la lista. |
body | ListPinnedRequest | Cuerpo de la solicitud |
Devuelve
Promise<ListPinnedResponse>
Promesa que se resuelve en la respuesta de la API
Definido en
getListMemberships
id, options?): Promise<Get2UsersIdListMembershipsResponse>
Obtener membresías en Listas
Recupera las Listas de las que un usuario específico es miembro por su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del usuario que se va a consultar. |
options | GetListMembershipsOptions | - |
Devuelve
Promise<Get2UsersIdListMembershipsResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
unmuteUser
sourceUserId, targetUserId): Promise<MuteUserMutationResponse>
Reactivar sonido de usuario
Hace que el usuario autenticado deje de silenciar a un usuario específico por su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
sourceUserId | string | El id del Usuario de origen autenticado que solicita desactivar el silencio del Usuario de destino. |
targetUserId | string | El id del Usuario al que el Usuario de origen solicita desactivar el silencio. |
Devuelve
Promise<MuteUserMutationResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
blockDms
id): Promise<UsersDMBlockCreateResponse>
Bloquear MD
Bloquea los Mensajes Directos hacia o desde un usuario específico por su id para el usuario autenticado.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del usuario de destino para el que el usuario autenticado solicita bloquear los DMs. |
Devuelve
Promise<UsersDMBlockCreateResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
getFollowedLists
id, options?): Promise<Get2UsersIdFollowedListsResponse>
Obtener listas seguidas
Recupera una lista de listas que sigue un usuario específico por su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del usuario que se desea consultar. |
options | GetFollowedListsOptions | - |
Devuelve
Promise<Get2UsersIdFollowedListsResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
followList
id, options?): Promise<ListFollowedResponse>
Seguir una Lista
Hace que el usuario autenticado siga una Lista específica por su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del usuario de origen autenticado que seguirá la lista. |
options | FollowListOptions | - |
Devoluciones
Promise<ListFollowedResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
getByIds
ids, options?): Promise<Get2UsersResponse>
Obtener usuarios por id
Recupera los detalles de varios usuarios por su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
ids | any[] | Una lista de id de usuario, separada por comas. Puede especificar hasta 100 id. |
options | GetByIdsOptions | - |
Devuelve
Promise<Get2UsersResponse>
Promesa que se resuelve en la respuesta de la API
Definido en
getMe
options?): Promise<Get2UsersMeResponse>
Obtener mi usuario
Recupera los detalles del usuario autenticado.
Parámetros
| Nombre | Tipo |
|---|---|
options | GetMeOptions |
Devuelve
Promise<Get2UsersMeResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
unblockDms
id): Promise<UsersDMUnBlockCreateResponse>
Desbloquear MD
Desbloquea los mensajes directos hacia o desde un usuario específico por su id para el usuario autenticado.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del usuario de destino para el que el usuario autenticado solicita desbloquear los MD. |
Devuelve
Promise<UsersDMUnBlockCreateResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
getMuting
id, options?): Promise<Get2UsersIdMutingResponse>
Obtener silenciados
Recupera una lista de usuarios silenciados por el usuario autenticado.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del usuario de origen autenticado para el que se deben devolver los resultados. |
options | GetMutingOptions | - |
Devuelve
Promise<Get2UsersIdMutingResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
muteUser
id, options?): Promise<MuteUserMutationResponse>
Silenciar usuario
Hace que el usuario autenticado silencie a un usuario específico por su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del usuario de origen autenticado que solicita silenciar al usuario de destino. |
options | MuteUserOptions | - |
Devuelve
Promise<MuteUserMutationResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
getPosts
id, options?): Promise<Get2UsersIdTweetsResponse>
Obtener Posts
Recupera una lista de Posts publicados por un usuario específico mediante su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del usuario que se va a consultar. |
options | GetPostsOptions | - |
Devuelve
Promise<Get2UsersIdTweetsResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
deleteBookmark
id, tweetId): Promise<BookmarkMutationResponse>
Eliminar marcador
Elimina un Post de los Marcadores del usuario autenticado por su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del Usuario de origen autenticado cuyo marcador se va a quitar. |
tweetId | string | El id del Post que el Usuario de origen está quitando de los marcadores. |
Devuelve
Promise<BookmarkMutationResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
getByUsernames
usernames, options?): Promise<Get2UsersByResponse>
Obtener usuarios por nombre de usuario
Recupera los detalles de varios usuarios a partir de sus nombres de usuario.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
usernames | any[] | Lista de nombres de usuario, separados por comas. |
options | GetByUsernamesOptions | - |
Devuelve
Promise<Get2UsersByResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
getByUsername
username, options?): Promise<Get2UsersByUsernameUsernameResponse>
Obtener usuario por nombre de usuario
Recupera los detalles de un usuario específico por su nombre de usuario.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
username | string | Nombre de usuario. |
options | GetByUsernameOptions | - |
Retornos
Promise<Get2UsersByUsernameUsernameResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
getBookmarkFolders
id, options?): Promise<BookmarkFoldersResponse>
Obtener carpetas de marcadores
Devuelve una lista de carpetas de marcadores creadas por el usuario autenticado.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del usuario de origen autenticado para el que se devolverán resultados. |
options | GetBookmarkFoldersOptions | - |
Devuelve
Promise<BookmarkFoldersResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
search
query, options?): Promise<Get2UsersSearchResponse>
Buscar usuarios
Obtiene una lista de usuarios que coinciden con una consulta de búsqueda.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
query | any | La cadena de consulta con la que buscar usuarios. |
options | SearchOptions | - |
Devuelve
Promise<Get2UsersSearchResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
getTimeline
id, options?): Promise<Get2UsersIdTimelinesReverseChronologicalResponse>
Obtener timeline
Recupera una lista de Posts en orden cronológico inverso en el timeline del usuario autenticado.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del Usuario de origen autenticado para listar los Posts de su cronología en orden inverso (más recientes primero). |
options | GetTimelineOptions | - |
Devuelve
Promise<Get2UsersIdTimelinesReverseChronologicalResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
getOwnedLists
id, options?): Promise<Get2UsersIdOwnedListsResponse>
Obtener listas propias
Recupera un listado de listas pertenecientes a un Usuario específico por su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | string | El id del usuario que se desea consultar. |
options | GetOwnedListsOptions | - |
Devuelve
Promise<Get2UsersIdOwnedListsResponse>
Promesa que se resuelve con la respuesta de la API