UsersClient

Client pour les opérations sur les utilisateurs

Ce client fournit des méthodes pour interagir avec les endpoints utilisateurs de la X API. Il gère l’authentification, le formatage des requêtes et l’analyse des réponses pour toutes les opérations liées aux utilisateurs.

​

Constructeurs

​

constructor

• new UsersClient(client): UsersClient

Crée une nouvelle instance de UsersClient

​

Paramètres

Nom	Type	Description
client	Client	L’instance principale de Client pour la X API

​

Renvoie

UsersClient

​

Défini dans

users/client.ts:1234

​

Méthodes

​

getByUsernames

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

Obtenir des utilisateurs par noms d’utilisateur
Récupère les détails de plusieurs utilisateurs à partir de leurs noms d’utilisateur.

​

Paramètres

Nom	Type	Description
usernames	any[]	Une liste de noms d’utilisateur, séparés par des virgules.
options	GetByUsernamesOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise résolue avec la réponse de l’API, ou Response brute si requestOptions.raw est à true

​

Défini dans

users/client.ts:1279

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

​

Paramètres

Nom	Type
usernames	any[]
options?	GetByUsernamesOptions

​

Renvoie

Promise<Get2UsersByResponse>

​

Défini dans

users/client.ts:1292

---

​

getRepostsOfMe

▸ getRepostsOfMe(options): Promise<Response>

Récupérer les Reposts me concernant Renvoie une liste de Publications qui font un Repost du contenu de l’utilisateur authentifié.

​

Paramètres

Nom	Type
options	GetRepostsOfMeOptions & { requestOptions: { raw: true } }

​

Renvoie

Promise<Response>

Promise se résolvant avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true

​

Défini dans

users/client.ts:1471

▸ getRepostsOfMe(options?): Promise<Get2UsersRepostsOfMeResponse>

​

Paramètres

Nom	Type
options?	GetRepostsOfMeOptions

​

Renvoie

Promise<Get2UsersRepostsOfMeResponse>

​

Défini dans

users/client.ts:1480

---

​

unlikePost

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

Retirer l’appréciation d’une Publication Fait en sorte que l’utilisateur authentifié retire son appréciation d’une Publication spécifique à partir de son identifiant.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’Utilisateur source authentifié qui demande à retirer son J’aime de la Publication.
tweetId	string	L’identifiant de la Publication pour laquelle l’Utilisateur demande à retirer son J’aime.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Renvoie

Promise<Response>

Promise se résolvant avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est à true

​

Défini dans

users/client.ts:1741

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

​

Paramètres

Nom	Type
id	string
tweetId	string

​

Renvoie

Promise<UsersLikesDeleteResponse>

​

Défini dans

users/client.ts:1758

---

​

getBookmarks

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

Récupérer les signets
Récupère une liste de Publications mises en signet par l’utilisateur authentifié.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’utilisateur source authentifié pour lequel il faut renvoyer les résultats.
options	GetBookmarksOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou avec la Response brute si requestOptions.raw vaut true

​

Défini dans

users/client.ts:1861

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

​

Paramètres

Nom	Type
id	string
options?	GetBookmarksOptions

​

Renvoie

Promise<Get2UsersIdBookmarksResponse>

​

Défini dans

users/client.ts:1874

---

​

createBookmark

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

Créer un signet Ajoute une Publication aux signets de l’utilisateur authentifié.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’utilisateur source authentifié pour lequel des favoris doivent être ajoutés.
body	BookmarkAddRequest	Corps de requête
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Renvoie

Promise<Response>

Promise résolue avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true

​

Défini dans

users/client.ts:2139

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

​

Paramètres

Nom	Type
id	string
body	BookmarkAddRequest

​

Renvoie

Promise<BookmarkMutationResponse>

​

Défini dans

users/client.ts:2154

---

​

getFollowers

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

Obtenir les abonnés Récupère la liste des utilisateurs qui suivent un utilisateur spécifique, identifié par son id.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’utilisateur à rechercher.
options	GetFollowersOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true

​

Défini dans

users/client.ts:2245

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

​

Paramètres

Nom	Type
id	string
options?	GetFollowersOptions

​

Renvoie

Promise<Get2UsersIdFollowersResponse>

​

Défini dans

users/client.ts:2258

---

​

unpinList

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

Retirer l’épinglage d’une Liste Permet à l’utilisateur authentifié de retirer l’épinglage d’une Liste spécifique par son id.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’utilisateur source authentifié pour lequel renvoyer les résultats.
listId	string	L’identifiant de la Liste à désépingler.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Renvoie

Promise<Response>

Promesse se résolvant avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true

​

Défini dans

users/client.ts:2474

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

​

Paramètres

Nom	Type
id	string
listId	string

​

Renvoie

Promise<ListUnpinResponse>

​

Défini dans

users/client.ts:2491

---

​

getById

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

Obtenir un utilisateur par son identifiant
Récupère les détails d’un utilisateur spécifique par son identifiant.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’utilisateur à récupérer.
options	GetByIdOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise résolue avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est true

​

Défini dans

users/client.ts:2594

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

​

Paramètres

Nom	Type
id	string
options?	GetByIdOptions

​

Renvoie

Promise<Get2UsersIdResponse>

​

Défini dans

users/client.ts:2607

---

​

getMentions

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

Obtenir les mentions Récupère une liste de Publications qui mentionnent un utilisateur spécifique par son id.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’utilisateur à rechercher.
options	GetMentionsOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true

​

Défini dans

users/client.ts:2781

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

​

Paramètres

Nom	Type
id	string
options?	GetMentionsOptions

​

Renvoie

Promise<Get2UsersIdMentionsResponse>

​

Défini dans

users/client.ts:2794

---

​

unrepostPost

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

Annuler le repost d’une Publication Fait en sorte que l’utilisateur authentifié annule le repost d’une Publication spécifique, identifiée par son identifiant.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’Utilisateur source authentifié qui demande de repartager la Publication.
sourceTweetId	string	L’identifiant de la Publication pour laquelle l’Utilisateur demande d’annuler le repartage.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true

​

Défini dans

users/client.ts:3149

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

​

Paramètres

Nom	Type
id	string
sourceTweetId	string

​

Renvoie

Promise<UsersRetweetsDeleteResponse>

​

Définie dans

users/client.ts:3166

---

​

deleteBookmark

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

Supprimer un signet Supprime une publication des signets de l’utilisateur authentifié par son identifiant.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’Utilisateur source authentifié dont le signet doit être supprimé.
tweetId	string	L’identifiant de la Publication que l’Utilisateur source supprime de ses signets.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true

​

Défini dans

users/client.ts:3273

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

​

Paramètres

Nom	Type
id	string
tweetId	string

​

Renvoie

Promise<BookmarkMutationResponse>

​

Défini dans

users/client.ts:3290

---

​

unfollowList

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

Se désabonner d’une Liste Permet à l’utilisateur authentifié de se désabonner d’une Liste spécifique par son identifiant.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’utilisateur source authentifié qui se désabonnera de la Liste.
listId	string	L’identifiant de la Liste dont il faut se désabonner.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou une Response brute si requestOptions.raw vaut true

​

Défini dans

users/client.ts:3391

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

​

Paramètres

Nom	Type
id	string
listId	string

​

Renvoie

Promise<ListFollowedResponse>

​

Défini dans

users/client.ts:3408

---

​

unmuteUser

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

Réactiver un utilisateur Permet à l’utilisateur authentifié de réactiver un utilisateur spécifique à partir de son identifiant.

​

Paramètres

Nom	Type	Description
sourceUserId	string	L’identifiant de l’Utilisateur source authentifié qui demande d’annuler la mise en sourdine de l’Utilisateur cible.
targetUserId	string	L’identifiant de l’Utilisateur pour lequel l’Utilisateur source demande d’annuler la mise en sourdine.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Renvoie

Promise<Response>

Promise qui se résout en la réponse de l’API, ou en un Response brut si requestOptions.raw vaut true

​

Défini dans

users/client.ts:3515

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

​

Paramètres

Nom	Type
sourceUserId	string
targetUserId	string

​

Renvoie

Promise<MuteUserMutationResponse>

​

Défini dans

users/client.ts:3532

---

​

getMe

▸ getMe(options): Promise<Response>

Récupérer mon utilisateur
Récupère les détails de l’utilisateur authentifié.

​

Paramètres

Nom	Type
options	GetMeOptions & { requestOptions: { raw: true } }

​

Renvoie

Promise<Response>

Promise résolue avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true

​

Défini dans

users/client.ts:3631

▸ getMe(options?): Promise<Get2UsersMeResponse>

​

Paramètres

Nom	Type
options?	GetMeOptions

​

Renvoie

Promise<Get2UsersMeResponse>

​

Défini dans

users/client.ts:3640

---

​

getMuting

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

Obtenir les comptes masqués
Renvoie une liste de comptes masqués par l’utilisateur authentifié.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’utilisateur source authentifié pour lequel les résultats doivent être renvoyés.
options	GetMutingOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise résolue avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est défini sur true

​

Défini dans

users/client.ts:3796

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

​

Paramètres

Nom	Type
id	string
options?	GetMutingOptions

​

Renvoie

Promise<Get2UsersIdMutingResponse>

​

Défini dans

users/client.ts:3809

---

​

muteUser

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

Mettre un utilisateur en sourdine Permet à l’utilisateur authentifié de mettre en sourdine un utilisateur spécifique par son id.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’utilisateur source authentifié qui demande de masquer l’utilisateur cible.
options	MuteUserOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou avec l’objet Response brut si requestOptions.raw est égal à true

​

Défini dans

users/client.ts:4015

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

​

Paramètres

Nom	Type
id	string
options?	MuteUserOptions

​

Renvoie

Promise<MuteUserMutationResponse>

​

Défini dans

users/client.ts:4028

---

​

search

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

Rechercher des utilisateurs Renvoie une liste d’utilisateurs correspondant à une requête de recherche.

​

Parameters

Name	Type	Description
query	string	La chaîne de requête permettant de rechercher des utilisateurs.
options	SearchOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est true

​

Défini dans

users/client.ts:4136

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

​

Paramètres

Nom	Type
query	string
options?	SearchOptions

​

Renvoie

Promise<Get2UsersSearchResponse>

​

Défini dans

users/client.ts:4149

---

​

getBlocking

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

Obtenir les comptes bloqués Récupère une liste d’utilisateurs bloqués par l’identifiant d’utilisateur spécifié.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’Utilisateur source authentifié pour lequel retourner les résultats.
options	GetBlockingOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est true

​

Défini dans

users/client.ts:4362

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

​

Paramètres

Nom	Type
id	string
options?	GetBlockingOptions

​

Renvoie

Promise<Get2UsersIdBlockingResponse>

​

Défini dans

users/client.ts:4375

---

​

getByIds

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

Obtenir des utilisateurs par leurs id Récupère les détails de plusieurs utilisateurs à partir de leurs id.

​

Paramètres

Nom	Type	Description
ids	any[]	Une liste d’identifiants d’utilisateurs, séparés par des virgules. Vous pouvez spécifier jusqu’à 100 identifiants.
options	GetByIdsOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou avec l’objet Response brut si requestOptions.raw est à true

​

Défini dans

users/client.ts:4581

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

​

Paramètres

Nom	Type
ids	any[]
options?	GetByIdsOptions

​

Renvoie

Promise<Get2UsersResponse>

​

Défini dans

users/client.ts:4594

---

​

getFollowing

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

Obtenir les comptes suivis Récupère une liste d’utilisateurs suivis par un utilisateur donné, à partir de son id.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’utilisateur à récupérer.
options	GetFollowingOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise qui se résout en la réponse de l’API, ou en l’objet Response brut si requestOptions.raw est à true

​

Définie dans

users/client.ts:4777

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

​

Paramètres

Nom	Type
id	string
options?	GetFollowingOptions

​

Renvoie

Promise<Get2UsersIdFollowingResponse>

​

Défini dans

users/client.ts:4790

---

​

followUser

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

Suivre un utilisateur
Permet à l’utilisateur authentifié de suivre un utilisateur spécifique à l’aide de son id.

​

Parameters

Name	Type	Description
id	string	L’identifiant de l’utilisateur source authentifié qui demande à suivre l’utilisateur cible.
options	FollowUserOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est à true

​

Défini dans

users/client.ts:5002

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

​

Paramètres

Nom	Type
id	string
options?	FollowUserOptions

​

Renvoie

Promise<UsersFollowingCreateResponse>

​

Définie dans

users/client.ts:5015

---

​

likePost

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

Aimer une Publication Permet à l’utilisateur authentifié d’ajouter un J’aime à une Publication spécifique par son id.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’utilisateur source authentifié qui demande à ajouter une mention J’aime à la Publication.
options	LikePostOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise qui se résout en la réponse de l’API, ou en l’objet Response brut si requestOptions.raw vaut true

​

Défini dans

users/client.ts:5123

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

​

Paramètres

Nom	Type
id	string
options?	LikePostOptions

​

Renvoie

Promise<UsersLikesCreateResponse>

​

Défini dans

users/client.ts:5136

---

​

getLikedPosts

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

Obtenir les publications aimées
Récupère une liste de publications aimées par un utilisateur spécifique via son identifiant.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’utilisateur à rechercher.
options	GetLikedPostsOptions & { requestOptions: { raw: true } }	-

​

Retour

Promise<Response>

Promise résolue avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true

​

Défini dans

users/client.ts:5244

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

​

Paramètres

Nom	Type
id	string
options?	GetLikedPostsOptions

​

Renvoie

Promise<Get2UsersIdLikedTweetsResponse>

​

Défini dans

users/client.ts:5257

---

​

getPosts

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

Obtenir des publications Récupère une liste de publications créées par un utilisateur spécifique, identifié par son id.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’utilisateur à rechercher.
options	GetPostsOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise résolue avec la réponse de l’API, ou une Response brute si requestOptions.raw vaut true

​

Défini dans

users/client.ts:5526

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

​

Paramètres

Nom	Type
id	string
options?	GetPostsOptions

​

Renvoie

Promise<Get2UsersIdTweetsResponse>

​

Défini dans

users/client.ts:5539

---

​

blockDms

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

Bloquer les messages privés Bloque les messages privés vers ou depuis un utilisateur spécifique, identifié par son id, pour l’utilisateur authentifié.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’utilisateur cible pour lequel l’utilisateur authentifié demande de bloquer les Messages Privés.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est à true

​

Défini dans

users/client.ts:5909

▸ blockDms(id): Promise<UsersDMBlockCreateResponse>

​

Paramètres

Nom	Type
id	string

​

Renvoie

Promise<UsersDMBlockCreateResponse>

​

Défini dans

users/client.ts:5922

---

​

getListMemberships

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

Obtenir les appartenances à des Listes Récupère les Listes dont un utilisateur spécifique est membre, à partir de son id.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’utilisateur à rechercher.
options	GetListMembershipsOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise qui se résout en la réponse de l’API, ou en l’objet Response brut si requestOptions.raw vaut true

​

Défini dans

users/client.ts:6013

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

​

Paramètres

Nom	Type
id	string
options?	GetListMembershipsOptions

​

Renvoie

Promise<Get2UsersIdListMembershipsResponse>

​

Défini dans

users/client.ts:6026

---

​

getPinnedLists

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

Obtenir les Listes épinglées Récupère l’ensemble des Listes épinglées par l’utilisateur authentifié.

​

Paramètres

Name	Type	Description
id	string	L’identifiant de l’Utilisateur source authentifié pour lequel retourner les résultats.
options	GetPinnedListsOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou avec l’objet Response brut si requestOptions.raw vaut true

​

Défini dans

users/client.ts:6238

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

​

Paramètres

Nom	Type
id	string
options?	GetPinnedListsOptions

​

Renvoie

Promise<Get2UsersIdPinnedListsResponse>

​

Défini dans

users/client.ts:6251

---

​

pinList

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

Épingler une Liste Permet à l’utilisateur authentifié d’épingler une Liste spécifique par son identifiant.

​

Paramètres

Name	Type	Description
id	string	L’identifiant de l’utilisateur source authentifié qui épinglera la Liste.
body	ListPinnedRequest	Corps de la requête
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Renvoie

Promise<Response>

Promise résolue avec la réponse de l’API, ou objet Response brut si requestOptions.raw est à true

​

Défini dans

users/client.ts:6421

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

​

Paramètres

Nom	Type
id	string
body	ListPinnedRequest

​

Renvoie

Promise<ListPinnedResponse>

​

Défini dans

users/client.ts:6436

---

​

getByUsername

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

Obtenir un utilisateur par son nom d’utilisateur Récupère les détails d’un utilisateur spécifique à partir de son nom d’utilisateur.

​

Paramètres

Nom	Type	Description
username	string	Un nom d’utilisateur.
options	GetByUsernameOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise résolue avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true

​

Défini dans

users/client.ts:6533

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

​

Paramètres

Nom	Type
username	string
options?	GetByUsernameOptions

​

Renvoie

Promise<Get2UsersByUsernameUsernameResponse>

​

Défini dans

users/client.ts:6546

---

​

unfollowUser

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

Ne plus suivre un utilisateur Permet à l’utilisateur authentifié de ne plus suivre un utilisateur spécifique à l’aide de son identifiant.

​

Paramètres

Nom	Type	Description
sourceUserId	string	L’identifiant du User source authentifié qui demande à se désabonner du User cible.
targetUserId	string	L’identifiant du User dont le User source demande à se désabonner.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Renvoie

Promise<Response>

Promise résolue avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est à true

​

Défini dans

users/client.ts:6724

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

​

Paramètres

Nom	Type
sourceUserId	string
targetUserId	string

​

Renvoie

Promise<UsersFollowingDeleteResponse>

​

Défini dans

users/client.ts:6741

---

​

getTimeline

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

Obtenir le fil d’actualité Récupère une liste de Publications par ordre antéchronologique dans le fil d’actualité de l’utilisateur authentifié.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant (id) de l’Utilisateur source authentifié dont il faut lister les Publications de la Timeline antéchronologique.
options	GetTimelineOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est défini sur true

​

Défini dans

users/client.ts:6844

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

​

Paramètres

Nom	Type
id	string
options?	GetTimelineOptions

​

Renvoie

Promise<Get2UsersIdTimelinesReverseChronologicalResponse>

​

Défini dans

users/client.ts:6857

---

​

getFollowedLists

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

Obtenir les Listes suivies
Récupère les Listes suivies par un utilisateur spécifique à partir de son id.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’utilisateur à rechercher.
options	GetFollowedListsOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise résolue avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est à true

​

Défini dans

users/client.ts:7221

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

​

Paramètres

Nom	Type
id	string
options?	GetFollowedListsOptions

​

Renvoie

Promise<Get2UsersIdFollowedListsResponse>

​

Définie dans

users/client.ts:7234

---

​

followList

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

Suivre une liste
Fait en sorte que l’utilisateur authentifié suive une liste spécifique à partir de son identifiant.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’utilisateur source authentifié qui suivra la Liste.
options	FollowListOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est true

​

Défini dans

users/client.ts:7446

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

​

Paramètres

Nom	Type
id	string
options?	FollowListOptions

​

Retourne

Promise<ListFollowedResponse>

​

Défini dans

users/client.ts:7459

---

​

unblockDms

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

Débloquer les messages privés Débloque les messages privés à destination ou en provenance d’un utilisateur spécifique, identifié par son id, pour l’utilisateur authentifié.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’utilisateur cible pour lequel l’utilisateur authentifié demande le déblocage des messages privés (DM).
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Renvoie

Promise<Response>

Promesse résolue avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true

​

Défini dans

users/client.ts:7567

▸ unblockDms(id): Promise<UsersDMUnBlockCreateResponse>

​

Paramètres

Nom	Type
id	string

​

Renvoie

Promise<UsersDMUnBlockCreateResponse>

​

Définition dans

users/client.ts:7580

---

​

repostPost

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

Reposter une Publication Permet à l’utilisateur authentifié de reposter une Publication spécifique par son identifiant.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’utilisateur source authentifié qui demande à reposter la Publication.
options	RepostPostOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise qui se résout en la réponse de l’API, ou en un objet Response brut si requestOptions.raw vaut true

​

Défini dans

users/client.ts:7671

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

​

Paramètres

Nom	Type
id	string
options?	RepostPostOptions

​

Renvoie

Promise<UsersRetweetsCreateResponse>

​

Définie dans

users/client.ts:7684

---

​

getBookmarkFolders

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

Récupérer les dossiers de signets Renvoie une liste de dossiers de signets créés par l’utilisateur authentifié.

​

Paramètres

Nom	Type	Description
id	string	L’id de l’utilisateur source authentifié pour lequel récupérer les résultats.
options	GetBookmarkFoldersOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise qui se résout en la réponse de l’API, ou en Response brut si requestOptions.raw vaut true

​

Défini dans

users/client.ts:7792

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

​

Paramètres

Nom	Type
id	string
options?	GetBookmarkFoldersOptions

​

Renvoie

Promise<BookmarkFoldersResponse>

​

Défini dans

users/client.ts:7805

---

​

getOwnedLists

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

Obtenir les Listes dont l’Utilisateur est propriétaire Récupère les Listes appartenant à un Utilisateur spécifique à partir de son id.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’utilisateur à rechercher.
options	GetOwnedListsOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true

​

Défini dans

users/client.ts:7944

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

​

Paramètres

Nom	Type
id	string
options?	GetOwnedListsOptions

​

Renvoie

Promise<Get2UsersIdOwnedListsResponse>

​

Défini dans

users/client.ts:7957

---

​

getBookmarksByFolderId

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

Obtenir les signets par identifiant de dossier Récupère, pour l’utilisateur authentifié, les Publications d’un dossier de signets spécifique à partir de son identifiant.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’Utilisateur source authentifié pour lequel retourner les résultats.
folderId	string	L’identifiant du dossier de marque-pages pour lequel l’Utilisateur authentifié souhaite récupérer des Publications.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true

​

Défini dans

users/client.ts:8173

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

​

Paramètres

Nom	Type
id	string
folderId	string

​

Renvoie

Promise<BookmarkFolderPostsResponse>

​

Défini dans

users/client.ts:8190