Constructeurs
constructor
client): UsersClient
Crée une nouvelle instance de UsersClient
Paramètres
Renvoie
UsersClient
Défini dans
users/client.ts:1234Méthodes
getByUsernames
usernames, options): Promise<Response>
Obtenir des utilisateurs par noms d’utilisateurRécupère les détails de plusieurs utilisateurs à partir de leurs noms d’utilisateur.
Paramètres
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
Renvoie
Promise<Get2UsersByResponse>
Défini dans
users/client.ts:1292getRepostsOfMe
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
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
Renvoie
Promise<Get2UsersRepostsOfMeResponse>
Défini dans
users/client.ts:1480unlikePost
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
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
Renvoie
Promise<UsersLikesDeleteResponse>
Défini dans
users/client.ts:1758getBookmarks
id, options): Promise<Response>
Récupérer les signetsRécupère une liste de Publications mises en signet par l’utilisateur authentifié.
Paramètres
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
Renvoie
Promise<Get2UsersIdBookmarksResponse>
Défini dans
users/client.ts:1874createBookmark
id, body, options): Promise<Response>
Créer un signet
Ajoute une Publication aux signets de l’utilisateur authentifié.
Paramètres
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
Renvoie
Promise<BookmarkMutationResponse>
Défini dans
users/client.ts:2154getFollowers
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
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
Renvoie
Promise<Get2UsersIdFollowersResponse>
Défini dans
users/client.ts:2258unpinList
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
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
Renvoie
Promise<ListUnpinResponse>
Défini dans
users/client.ts:2491getById
id, options): Promise<Response>
Obtenir un utilisateur par son identifiantRécupère les détails d’un utilisateur spécifique par son identifiant.
Paramètres
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
Renvoie
Promise<Get2UsersIdResponse>
Défini dans
users/client.ts:2607getMentions
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
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
Renvoie
Promise<Get2UsersIdMentionsResponse>
Défini dans
users/client.ts:2794unrepostPost
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
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
Renvoie
Promise<UsersRetweetsDeleteResponse>
Définie dans
users/client.ts:3166deleteBookmark
id, tweetId, options): Promise<Response>
Supprimer un signet
Supprime une publication des signets de l’utilisateur authentifié par son identifiant.
Paramètres
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
Renvoie
Promise<BookmarkMutationResponse>
Défini dans
users/client.ts:3290unfollowList
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
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
Renvoie
Promise<ListFollowedResponse>
Défini dans
users/client.ts:3408unmuteUser
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
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
Renvoie
Promise<MuteUserMutationResponse>
Défini dans
users/client.ts:3532getMe
options): Promise<Response>
Récupérer mon utilisateurRécupère les détails de l’utilisateur authentifié.
Paramètres
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
Renvoie
Promise<Get2UsersMeResponse>
Défini dans
users/client.ts:3640getMuting
id, options): Promise<Response>
Obtenir les comptes masquésRenvoie une liste de comptes masqués par l’utilisateur authentifié.
Paramètres
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
Renvoie
Promise<Get2UsersIdMutingResponse>
Défini dans
users/client.ts:3809muteUser
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
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
Renvoie
Promise<MuteUserMutationResponse>
Défini dans
users/client.ts:4028search
query, options): Promise<Response>
Rechercher des utilisateurs
Renvoie une liste d’utilisateurs correspondant à une requête de recherche.
Parameters
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
Renvoie
Promise<Get2UsersSearchResponse>
Défini dans
users/client.ts:4149getBlocking
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
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
Renvoie
Promise<Get2UsersIdBlockingResponse>
Défini dans
users/client.ts:4375getByIds
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
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
Renvoie
Promise<Get2UsersResponse>
Défini dans
users/client.ts:4594getFollowing
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
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
Renvoie
Promise<Get2UsersIdFollowingResponse>
Défini dans
users/client.ts:4790followUser
id, options): Promise<Response>
Suivre un utilisateurPermet à l’utilisateur authentifié de suivre un utilisateur spécifique à l’aide de son id.
Parameters
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
Renvoie
Promise<UsersFollowingCreateResponse>
Définie dans
users/client.ts:5015likePost
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
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
Renvoie
Promise<UsersLikesCreateResponse>
Défini dans
users/client.ts:5136getLikedPosts
id, options): Promise<Response>
Obtenir les publications aiméesRécupère une liste de publications aimées par un utilisateur spécifique via son identifiant.
Paramètres
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
Renvoie
Promise<Get2UsersIdLikedTweetsResponse>
Défini dans
users/client.ts:5257getPosts
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
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
Renvoie
Promise<Get2UsersIdTweetsResponse>
Défini dans
users/client.ts:5539blockDms
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
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
Renvoie
Promise<UsersDMBlockCreateResponse>
Défini dans
users/client.ts:5922getListMemberships
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
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
Renvoie
Promise<Get2UsersIdListMembershipsResponse>
Défini dans
users/client.ts:6026getPinnedLists
id, options): Promise<Response>
Obtenir les Listes épinglées
Récupère l’ensemble des Listes épinglées par l’utilisateur authentifié.
Paramètres
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
Renvoie
Promise<Get2UsersIdPinnedListsResponse>
Défini dans
users/client.ts:6251pinList
id, body, options): Promise<Response>
Épingler une Liste
Permet à l’utilisateur authentifié d’épingler une Liste spécifique par son identifiant.
Paramètres
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
Renvoie
Promise<ListPinnedResponse>
Défini dans
users/client.ts:6436getByUsername
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
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
Renvoie
Promise<Get2UsersByUsernameUsernameResponse>
Défini dans
users/client.ts:6546unfollowUser
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
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
Renvoie
Promise<UsersFollowingDeleteResponse>
Défini dans
users/client.ts:6741getTimeline
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
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
Renvoie
Promise<Get2UsersIdTimelinesReverseChronologicalResponse>
Défini dans
users/client.ts:6857getFollowedLists
id, options): Promise<Response>
Obtenir les Listes suiviesRécupère les Listes suivies par un utilisateur spécifique à partir de son id.
Paramètres
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
Renvoie
Promise<Get2UsersIdFollowedListsResponse>
Définie dans
users/client.ts:7234followList
id, options): Promise<Response>
Suivre une listeFait en sorte que l’utilisateur authentifié suive une liste spécifique à partir de son identifiant.
Paramètres
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
Retourne
Promise<ListFollowedResponse>
Défini dans
users/client.ts:7459unblockDms
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
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
Renvoie
Promise<UsersDMUnBlockCreateResponse>
Définition dans
repostPost
id, options): Promise<Response>
Reposter une Publication
Permet à l’utilisateur authentifié de reposter une Publication spécifique par son identifiant.
Paramètres
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
Renvoie
Promise<UsersRetweetsCreateResponse>
Définie dans
users/client.ts:7684getBookmarkFolders
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
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
Renvoie
Promise<BookmarkFoldersResponse>
Défini dans
users/client.ts:7805getOwnedLists
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
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
Renvoie
Promise<Get2UsersIdOwnedListsResponse>
Défini dans
users/client.ts:7957getBookmarksByFolderId
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
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
Renvoie
Promise<BookmarkFolderPostsResponse>