UsersClient

Cliente para operaciones con usuarios

Este cliente proporciona métodos para interactuar con los endpoints de usuarios 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 usuarios.

​

Constructores

​

constructor

• new UsersClient(client): UsersClient

Crea una nueva instancia de UsersClient

​

Parámetros

Nombre	Tipo	Descripción
client	Client	La instancia principal de Client de X API

​

Devuelve

UsersClient

​

Definido en

users/client.ts:1234

​

Métodos

​

getByUsernames

▸ getByUsernames(usernames, options): Promise<Response>

Obtener Usuarios por nombres de usuario
Obtiene los detalles de varios Usuarios a partir de sus nombres de usuario.

​

Parámetros

Nombre	Tipo	Descripción
usernames	any[]	Una lista de nombres de usuario separados por comas.
options	GetByUsernamesOptions & { 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

users/client.ts:1279

▸ getByUsernames(usernames, options?): Promise<Get2UsersByResponse>

​

Parámetros

Nombre	Tipo
usernames	any[]
options?	GetByUsernamesOptions

​

Devuelve

Promise<Get2UsersByResponse>

​

Definido en

users/client.ts:1292

---

​

getRepostsOfMe

▸ getRepostsOfMe(options): Promise<Response>

Obtener republicaciones de mi contenido
Obtiene una lista de Publicaciones que republican contenido del usuario autenticado.

​

Parámetros

Nombre	Type
options	GetRepostsOfMeOptions & { 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

users/client.ts:1471

▸ getRepostsOfMe(options?): Promise<Get2UsersRepostsOfMeResponse>

​

Parámetros

Nombre	Tipo
options?	GetRepostsOfMeOptions

​

Devuelve

Promise<Get2UsersRepostsOfMeResponse>

​

Definido en

users/client.ts:1480

---

​

unlikePost

▸ unlikePost(id, tweetId, options): Promise<Response>

Quitar el Me gusta de una Publicación
Hace que el usuario autenticado quite el Me gusta de una Publicación específica por su id.

​

Parámetros

Name	Type	Description
id	string	El id del usuario de origen autenticado que solicita quitar el Me gusta de la Publicación.
tweetId	string	El id de la Publicación de la que el usuario solicita quitar el Me gusta.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Devuelve

Promise<Response>

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

​

Definido en

users/client.ts:1741

▸ unlikePost(id, tweetId): Promise<UsersLikesDeleteResponse>

​

Parámetros

Nombre	Tipo
id	string
tweetId	string

​

Devuelve

Promise<UsersLikesDeleteResponse>

​

Definido en

users/client.ts:1758

---

​

getBookmarks

▸ getBookmarks(id, options): Promise<Response>

Obtener marcadores Obtiene una lista de Publicaciones guardadas en marcadores por el usuario autenticado.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador (id) del Usuario de origen autenticado para el cual se deben devolver los resultados.
options	GetBookmarksOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

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

​

Definido en

users/client.ts:1861

▸ getBookmarks(id, options?): Promise<Get2UsersIdBookmarksResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	GetBookmarksOptions

​

Devuelve

Promise<Get2UsersIdBookmarksResponse>

​

Definido en

users/client.ts:1874

---

​

createBookmark

▸ createBookmark(id, body, options): Promise<Response>

Crear marcador Agrega una Publicación a los marcadores del usuario autenticado.

​

Parámetros

Name	Type	Description
id	string	El ID del Usuario de origen autenticado al que se le deben añadir marcadores.
body	BookmarkAddRequest	Cuerpo de la solicitud
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Devuelve

Promise<Response>

Promesa que se resuelve con la respuesta de la API, o con el objeto Response en bruto si requestOptions.raw es true

​

Definido en

users/client.ts:2139

▸ createBookmark(id, body): Promise<BookmarkMutationResponse>

​

Parámetros

Nombre	Tipo
id	string
body	BookmarkAddRequest

​

Devuelve

Promise<BookmarkMutationResponse>

​

Definido en

users/client.ts:2154

---

​

getFollowers

▸ getFollowers(id, options): Promise<Response>

Obtener seguidores Obtiene una lista de usuarios que siguen a un usuario específico mediante su id.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador del usuario que se va a buscar.
options	GetFollowersOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

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

​

Definido en

users/client.ts:2245

▸ getFollowers(id, options?): Promise<Get2UsersIdFollowersResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	GetFollowersOptions

​

Devuelve

Promise<Get2UsersIdFollowersResponse>

​

Definido en

users/client.ts:2258

---

​

unpinList

▸ unpinList(id, listId, options): Promise<Response>

Desanclar una Lista Permite que el usuario autenticado desanclé una Lista específica por su id.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El ID del usuario de origen autenticado para el cual se devolverán los resultados.
listId	string	El ID de la Lista que se va a desanclar.
options	Object	-
options.requestOptions	Object	-
options.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

users/client.ts:2474

▸ unpinList(id, listId): Promise<ListUnpinResponse>

​

Parámetros

Nombre	Tipo
id	string
listId	string

​

Devuelve

Promise<ListUnpinResponse>

​

Definido en

users/client.ts:2491

---

​

getById

▸ getById(id, options): Promise<Response>

Obtener usuario por id
Recupera los detalles de un usuario específico por su identificador (id).

​

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador del Usuario que se va a consultar.
options	GetByIdOptions & { 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

users/client.ts:2594

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

​

Parámetros

Nombre	Tipo
id	string
options?	GetByIdOptions

​

Devuelve

Promise<Get2UsersIdResponse>

​

Definido en

users/client.ts:2607

---

​

getMentions

▸ getMentions(id, options): Promise<Response>

Obtener menciones Obtiene una lista de Publicaciones que mencionan a un usuario específico por su id.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador del usuario que se va a buscar.
options	GetMentionsOptions & { 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

users/client.ts:2781

▸ getMentions(id, options?): Promise<Get2UsersIdMentionsResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	GetMentionsOptions

​

Devuelve

Promise<Get2UsersIdMentionsResponse>

​

Definido en

users/client.ts:2794

---

​

unrepostPost

▸ unrepostPost(id, sourceTweetId, options): Promise<Response>

Anular la republicación de una Publicación
Hace que el usuario autenticado deje de republicar una Publicación específica por su identificador.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El ID del Usuario de origen autenticado que solicita volver a publicar la Publicación.
sourceTweetId	string	El ID de la Publicación para la que el Usuario solicita deshacer el repost.
options	Object	-
options.requestOptions	Object	-
options.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

users/client.ts:3149

▸ unrepostPost(id, sourceTweetId): Promise<UsersRetweetsDeleteResponse>

​

Parámetros

Nombre	Tipo
id	string
sourceTweetId	string

​

Devuelve

Promise<UsersRetweetsDeleteResponse>

​

Definido en

users/client.ts:3166

---

​

deleteBookmark

▸ deleteBookmark(id, tweetId, options): Promise<Response>

Eliminar Marcador Elimina una Publicación de los Marcadores del usuario autenticado por su identificador.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador del Usuario de origen autenticado cuyo marcador se va a eliminar.
tweetId	string	El identificador de la Publicación que el Usuario de origen está eliminando de los marcadores.
options	Object	-
options.requestOptions	Object	-
options.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

users/client.ts:3273

▸ deleteBookmark(id, tweetId): Promise<BookmarkMutationResponse>

​

Parámetros

Nombre	Tipo
id	string
tweetId	string

​

Devuelve

Promise<BookmarkMutationResponse>

​

Definido en

users/client.ts:3290

---

​

unfollowList

▸ unfollowList(id, listId, options): Promise<Response>

Dejar de seguir una Lista
Hace que el usuario autenticado deje de seguir una Lista específica identificada por su id.

​

Parámetros

Nombre	Type	Descripción
id	string	El identificador del usuario de origen autenticado que dejará de seguir la Lista.
listId	string	El identificador de la Lista que se dejará de seguir.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Devuelve

Promise<Response>

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

​

Definido en

users/client.ts:3391

▸ unfollowList(id, listId): Promise<ListFollowedResponse>

​

Parámetros

Nombre	Tipo
id	string
listId	string

​

Devuelve

Promise<ListFollowedResponse>

​

Definido en

users/client.ts:3408

---

​

unmuteUser

▸ unmuteUser(sourceUserId, targetUserId, options): Promise<Response>

Unmute User Hace que el usuario autenticado deje de silenciar a un usuario específico por su identificador.

​

Parámetros

Name	Type	Description
sourceUserId	string	El identificador del usuario de origen autenticado que solicita quitar el silencio del usuario de destino.
targetUserId	string	El identificador del usuario sobre el que el usuario de origen solicita quitar el silencio.
options	Object	-
options.requestOptions	Object	-
options.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

users/client.ts:3515

▸ unmuteUser(sourceUserId, targetUserId): Promise<MuteUserMutationResponse>

​

Parámetros

Nombre	Tipo
sourceUserId	string
targetUserId	string

​

Devuelve

Promise<MuteUserMutationResponse>

​

Definido en

users/client.ts:3532

---

​

getMe

▸ getMe(options): Promise<Response>

Obtener mi usuario
Obtiene los detalles del usuario autenticado.

​

Parámetros

Nombre	type
options	GetMeOptions & { 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

users/client.ts:3631

▸ getMe(options?): Promise<Get2UsersMeResponse>

​

Parámetros

Nombre	Tipo
options?	GetMeOptions

​

Devuelve

Promise<Get2UsersMeResponse>

​

Definido en

users/client.ts:3640

---

​

getMuting

▸ getMuting(id, options): Promise<Response>

Obtener usuarios silenciados Devuelve 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 resultados.
options	GetMutingOptions & { 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

users/client.ts:3796

▸ getMuting(id, options?): Promise<Get2UsersIdMutingResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	GetMutingOptions

​

Devuelve

Promise<Get2UsersIdMutingResponse>

​

Definido en

users/client.ts:3809

---

​

muteUser

▸ muteUser(id, options): Promise<Response>

Silenciar a un usuario Hace que el usuario autenticado silencie a un usuario específico por su id.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador (id) del usuario de origen autenticado que solicita silenciar al usuario de destino.
options	MuteUserOptions & { 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

users/client.ts:4015

▸ muteUser(id, options?): Promise<MuteUserMutationResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	MuteUserOptions

​

Devuelve

Promise<MuteUserMutationResponse>

​

Definido en

users/client.ts:4028

---

​

search

▸ search(query, options): Promise<Response>

Buscar usuarios Devuelve una lista de usuarios que coinciden con una consulta de búsqueda.

​

Parámetros

Name	Type	Description
query	string	Cadena de consulta que se utilizará para buscar usuarios.
options	SearchOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

Promesa que se resuelve con la respuesta de la API, o con el objeto Response en bruto si requestOptions.raw es true

​

Definido en

users/client.ts:4136

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

​

Parámetros

Nombre	type
query	string
options?	SearchOptions

​

Devuelve

Promise<Get2UsersSearchResponse>

​

Definido en

users/client.ts:4149

---

​

getBlocking

▸ getBlocking(id, options): Promise<Response>

Obtener bloqueos Obtiene una lista de usuarios bloqueados por el ID de usuario especificado.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador del usuario de origen autenticado para el que se devolverán los resultados.
options	GetBlockingOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

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

​

Definido en

users/client.ts:4362

▸ getBlocking(id, options?): Promise<Get2UsersIdBlockingResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	GetBlockingOptions

​

Devuelve

Promise<Get2UsersIdBlockingResponse>

​

Definido en

users/client.ts:4375

---

​

getByIds

▸ getByIds(ids, options): Promise<Response>

Obtener usuarios por id
Recupera los detalles de varios usuarios a partir de sus id.

​

Parámetros

Nombre	Tipo	Descripción
ids	any[]	Una lista de ID de usuario, separados por comas. Puedes especificar hasta 100 ID.
options	GetByIdsOptions & { 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

users/client.ts:4581

▸ getByIds(ids, options?): Promise<Get2UsersResponse>

​

Parámetros

Nombre	Tipo
ids	any[]
options?	GetByIdsOptions

​

Devuelve

Promise<Get2UsersResponse>

​

Definido en

users/client.ts:4594

---

​

getFollowing

▸ getFollowing(id, options): Promise<Response>

Obtener cuentas seguidas
Obtiene una lista de usuarios seguidos por un usuario específico por su identificador (id).

​

Parámetros

Nombre	Tipo	Descripción
id	string	El ID del usuario que se va a consultar.
options	GetFollowingOptions & { 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

users/client.ts:4777

▸ getFollowing(id, options?): Promise<Get2UsersIdFollowingResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	GetFollowingOptions

​

Devuelve

Promise<Get2UsersIdFollowingResponse>

​

Definido en

users/client.ts:4790

---

​

followUser

▸ followUser(id, options): Promise<Response>

Seguir a un usuario Hace que el usuario autenticado comience a seguir 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 & { 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

users/client.ts:5002

▸ followUser(id, options?): Promise<UsersFollowingCreateResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	FollowUserOptions

​

Devuelve

Promise<UsersFollowingCreateResponse>

​

Definido en

users/client.ts:5015

---

​

likePost

▸ likePost(id, options): Promise<Response>

Indicar “Me gusta” en una Publicación
Hace que el usuario autenticado indique “Me gusta” en una Publicación específica identificada por su id.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador del Usuario de origen autenticado que solicita dar “Me gusta” a la Publicación.
options	LikePostOptions & { 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

users/client.ts:5123

▸ likePost(id, options?): Promise<UsersLikesCreateResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	LikePostOptions

​

Devuelve

Promise<UsersLikesCreateResponse>

​

Definido en

users/client.ts:5136

---

​

getLikedPosts

▸ getLikedPosts(id, options): Promise<Response>

Obtener Publicaciones con Me gusta Recupera una lista de Publicaciones a las que un Usuario específico ha dado Me gusta, por su id.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador del usuario que se va a buscar.
options	GetLikedPostsOptions & { 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

users/client.ts:5244

▸ getLikedPosts(id, options?): Promise<Get2UsersIdLikedTweetsResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	GetLikedPostsOptions

​

Devuelve

Promise<Get2UsersIdLikedTweetsResponse>

​

Definido en

users/client.ts:5257

---

​

getPosts

▸ getPosts(id, options): Promise<Response>

Obtener publicaciones Obtiene una lista de publicaciones creadas por un usuario específico identificado por su id.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador del usuario que se va a buscar.
options	GetPostsOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

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

​

Definido en

users/client.ts:5526

▸ getPosts(id, options?): Promise<Get2UsersIdTweetsResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	GetPostsOptions

​

Devuelve

Promise<Get2UsersIdTweetsResponse>

​

Definido en

users/client.ts:5539

---

​

blockDms

▸ blockDms(id, options): Promise<Response>

Bloquear MD Bloquea los mensajes directos de o hacia un usuario específico por su id para el usuario autenticado.

​

Parámetros

Nombre	Type	Descripción
id	string	El id del usuario de destino para el cual el usuario autenticado solicita bloquear los mensajes directos.
options	Object	-
options.requestOptions	Object	-
options.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

users/client.ts:5909

▸ blockDms(id): Promise<UsersDMBlockCreateResponse>

​

Parámetros

Nombre	Tipo
id	string

​

Devuelve

Promise<UsersDMBlockCreateResponse>

​

Definido en

users/client.ts:5922

---

​

getListMemberships

▸ getListMemberships(id, options): Promise<Response>

Obtener membresías de Listas
Obtiene una lista de Listas de las que un usuario específico es miembro según su identificador.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador del usuario que se va a buscar.
options	GetListMembershipsOptions & { 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

users/client.ts:6013

▸ getListMemberships(id, options?): Promise<Get2UsersIdListMembershipsResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	GetListMembershipsOptions

​

Devuelve

Promise<Get2UsersIdListMembershipsResponse>

​

Definido en

users/client.ts:6026

---

​

getPinnedLists

▸ getPinnedLists(id, options): Promise<Response>

Obtiene las Listas fijadas Devuelve una lista de Listas fijadas por el usuario autenticado.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador del usuario de origen autenticado para el que se devolverán resultados.
options	GetPinnedListsOptions & { 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

users/client.ts:6238

▸ getPinnedLists(id, options?): Promise<Get2UsersIdPinnedListsResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	GetPinnedListsOptions

​

Devuelve

Promise<Get2UsersIdPinnedListsResponse>

​

Definido en

users/client.ts:6251

---

​

pinList

▸ pinList(id, body, options): Promise<Response>

Anclar una Lista Hace que el usuario autenticado ancle una Lista específica por su id.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador del Usuario de origen autenticado que fijará la Lista.
body	ListPinnedRequest	Cuerpo de la solicitud
options	Object	-
options.requestOptions	Object	-
options.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

users/client.ts:6421

▸ pinList(id, body): Promise<ListPinnedResponse>

​

Parámetros

Nombre	Tipo
id	string
body	ListPinnedRequest

​

Devuelve

Promise<ListPinnedResponse>

​

Definido en

users/client.ts:6436

---

​

getByUsername

▸ getByUsername(username, options): Promise<Response>

Obtener un usuario por su nombre de usuario Recupera los detalles de un usuario específico por su nombre de usuario.

​

Parámetros

Nombre	Tipo	Descripción
username	string	Un nombre de usuario.
options	GetByUsernameOptions & { 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

users/client.ts:6533

▸ getByUsername(username, options?): Promise<Get2UsersByUsernameUsernameResponse>

​

Parámetros

Nombre	Tipo
username	string
options?	GetByUsernameOptions

​

Devuelve

Promise<Get2UsersByUsernameUsernameResponse>

​

Definido en

users/client.ts:6546

---

​

unfollowUser

▸ unfollowUser(sourceUserId, targetUserId, options): Promise<Response>

Dejar de seguir a un usuario
Hace que el usuario autenticado deje de seguir a un usuario específico identificado por su id.

​

Parámetros

Nombre	Type	Descripción
sourceUserId	string	El identificador del Usuario de origen autenticado que solicita dejar de seguir al Usuario de destino.
targetUserId	string	El identificador del Usuario al que el Usuario de origen solicita dejar de seguir.
options	Object	-
options.requestOptions	Object	-
options.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

users/client.ts:6724

▸ unfollowUser(sourceUserId, targetUserId): Promise<UsersFollowingDeleteResponse>

​

Parámetros

Nombre	Tipo
sourceUserId	string
targetUserId	string

​

Devuelve

Promise<UsersFollowingDeleteResponse>

​

Definido en

users/client.ts:6741

---

​

getTimeline

▸ getTimeline(id, options): Promise<Response>

Obtiene la Cronología Recupera una lista de Publicaciones en orden cronológico inverso en la Cronología del usuario autenticado.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador del Usuario de origen autenticado para listar las Publicaciones de la línea de tiempo en orden cronológico inverso.
options	GetTimelineOptions & { 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

users/client.ts:6844

▸ getTimeline(id, options?): Promise<Get2UsersIdTimelinesReverseChronologicalResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	GetTimelineOptions

​

Devuelve

Promise<Get2UsersIdTimelinesReverseChronologicalResponse>

​

Definido en

users/client.ts:6857

---

​

getFollowedLists

▸ getFollowedLists(id, options): Promise<Response>

Obtener las Listas seguidas Devuelve una lista de Listas seguidas por 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	GetFollowedListsOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

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

​

Definido en

users/client.ts:7221

▸ getFollowedLists(id, options?): Promise<Get2UsersIdFollowedListsResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	GetFollowedListsOptions

​

Devuelve

Promise<Get2UsersIdFollowedListsResponse>

​

Definido en

users/client.ts:7234

---

​

followList

▸ followList(id, options): Promise<Response>

Seguir lista
Hace que el usuario autenticado siga una lista específica por su id.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador del Usuario de origen autenticado que seguirá la Lista.
options	FollowListOptions & { 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

users/client.ts:7446

▸ followList(id, options?): Promise<ListFollowedResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	FollowListOptions

​

Devuelve

Promise<ListFollowedResponse>

​

Definido en

users/client.ts:7459

---

​

unblockDms

▸ unblockDms(id, options): Promise<Response>

Desbloquear MDs
Desbloquea los mensajes directos de o hacia un usuario específico mediante 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 quitar el bloqueo de los mensajes directos.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Devuelve

Promise<Response>

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

​

Definido en

users/client.ts:7567

▸ unblockDms(id): Promise<UsersDMUnBlockCreateResponse>

​

Parámetros

Nombre	Tipo
id	string

​

Devuelve

Promise<UsersDMUnBlockCreateResponse>

​

Definido en

users/client.ts:7580

---

​

repostPost

▸ repostPost(id, options): Promise<Response>

Volver a publicar una Publicación Hace que el usuario autenticado vuelva a publicar una Publicación específica por su ID.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El id del Usuario de origen autenticado que solicita republicar la Publicación.
options	RepostPostOptions & { 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

users/client.ts:7671

▸ repostPost(id, options?): Promise<UsersRetweetsCreateResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	RepostPostOptions

​

Devuelve

Promise<UsersRetweetsCreateResponse>

​

Definido en

users/client.ts:7684

---

​

getBookmarkFolders

▸ getBookmarkFolders(id, options): Promise<Response>

Obtener carpetas de marcadores Obtiene una lista de carpetas de marcadores creadas por el usuario autenticado.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador del Usuario de origen autenticado para el cual se devolverán los resultados.
options	GetBookmarkFoldersOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

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

​

Definido en

users/client.ts:7792

▸ getBookmarkFolders(id, options?): Promise<BookmarkFoldersResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	GetBookmarkFoldersOptions

​

Devuelve

Promise<BookmarkFoldersResponse>

​

Definido en

users/client.ts:7805

---

​

getOwnedLists

▸ getOwnedLists(id, options): Promise<Response>

Obtener listas propias Recupera una colección de Listas que son propiedad de un usuario específico mediante su id.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador del usuario que se va a consultar.
options	GetOwnedListsOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

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

​

Definido en

users/client.ts:7944

▸ getOwnedLists(id, options?): Promise<Get2UsersIdOwnedListsResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	GetOwnedListsOptions

​

Devuelve

Promise<Get2UsersIdOwnedListsResponse>

​

Definido en

users/client.ts:7957

---

​

getBookmarksByFolderId

▸ getBookmarksByFolderId(id, folderId, options): Promise<Response>

Obtiene marcadores por ID de carpeta
Obtiene Publicaciones en una carpeta de Marcadores específica por su ID para el usuario autenticado.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador del Usuario de origen autenticado para el que se devolverán los resultados.
folderId	string	El identificador de la Carpeta de marcadores para la que el Usuario autenticado intenta obtener Publicaciones.
options	Object	-
options.requestOptions	Object	-
options.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

users/client.ts:8173

▸ getBookmarksByFolderId(id, folderId): Promise<BookmarkFolderPostsResponse>

​

Parámetros

Nombre	Tipo
id	string
folderId	string

​

Devuelve

Promise<BookmarkFolderPostsResponse>

​

Definido en

users/client.ts:8190