ListsClient

Client pour les opérations sur les listes

Ce client fournit des méthodes pour interagir avec les endpoints de listes 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 listes.

​

Constructeurs

​

constructeur

• new ListsClient(client): ListsClient

Crée une nouvelle instance de ListsClient.

​

Paramètres

Nom	Type	Description
client	Client	L’instance principale du Client X API

​

Retourne

ListsClient

​

Défini dans

lists/client.ts:294

​

Méthodes

​

getFollowers

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

Récupérer les abonnés de la Liste Récupère une liste d’utilisateurs qui suivent une Liste spécifique via son identifiant.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de la Liste.
options	GetFollowersOptions & { 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

lists/client.ts:339

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

​

Paramètres

Nom	Type
id	string
options?	GetFollowersOptions

​

Renvoie

Promise<Get2ListsIdFollowersResponse>

​

Défini dans

lists/client.ts:352

---

​

create

▸ create(options): Promise<Response>

Créer une Liste Crée une nouvelle Liste pour l’utilisateur authentifié.

​

Paramètres

Nom	Type
options	CreateOptions & { 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

lists/client.ts:560

▸ create(options?): Promise<ListCreateResponse>

​

Paramètres

Nom	Type
options?	CreateOptions

​

Renvoie

Promise<ListCreateResponse>

​

Défini dans

lists/client.ts:569

---

​

getMembers

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

Obtenir les membres d’une liste Récupère les utilisateurs qui sont membres d’une liste spécifique à partir de son id.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de la Liste.
options	GetMembersOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

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

​

Défini dans

lists/client.ts:665

▸ getMembers(id, options?): Promise<Get2ListsIdMembersResponse>

​

Paramètres

Nom	Type
id	string
options?	GetMembersOptions

​

Renvoie

Promise<Get2ListsIdMembersResponse>

​

Défini dans

lists/client.ts:678

---

​

addMember

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

Ajouter un membre à une Liste Ajoute un utilisateur à une Liste spécifique à l’aide de son identifiant.

​

Parameters

Name	Type	Description
id	string	L’identifiant de la liste à laquelle ajouter un membre.
options	AddMemberOptions & { requestOptions: { raw: true } }	-

​

Returns

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éfinie dans

lists/client.ts:890

▸ addMember(id, options?): Promise<ListMutateResponse>

​

Paramètres

Nom	Type
id	string
options?	AddMemberOptions

​

Renvoie

Promise<ListMutateResponse>

​

Défini dans

lists/client.ts:903

---

​

getPosts

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

Récupérer les publications d’une Liste
Récupère les publications associées à une Liste spécifique via son identifiant.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de la Liste.
options	GetPostsOptions & { requestOptions: { raw: true } }	-

​

Returns

Promise<Response>

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

​

Défini dans

lists/client.ts:1011

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

​

Paramètres

Nom	Type
id	string
options?	GetPostsOptions

​

Renvoie

Promise<Get2ListsIdTweetsResponse>

​

Défini dans

lists/client.ts:1024

---

​

removeMemberByUserId

▸ removeMemberByUserId(id, userId, options): Promise<Response>

Supprimer un membre d’une Liste Supprime un utilisateur d’une Liste spécifique à partir de l’identifiant de la Liste et de l’identifiant de l’utilisateur.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de la Liste dont un membre doit être supprimé.
userId	string	L’identifiant de l’utilisateur qui sera supprimé de la Liste.
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

lists/client.ts:1303

▸ removeMemberByUserId(id, userId): Promise<ListMutateResponse>

​

Paramètres

Nom	Type
id	string
userId	string

​

Renvoie

Promise<ListMutateResponse>

​

Défini dans

lists/client.ts:1320

---

​

getById

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

Obtenir une Liste par id
Récupère les détails d’une Liste spécifique à partir de son id.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de la Liste.
options	GetByIdOptions & { 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

lists/client.ts:1423

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

​

Paramètres

Nom	Type
id	string
options?	GetByIdOptions

​

Renvoie

Promise<Get2ListsIdResponse>

​

Défini dans

lists/client.ts:1436

---

​

update

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

Mettre à jour une liste
Met à jour les détails d’une liste spécifique appartenant à l’utilisateur authentifié, à partir de son identifiant (id).

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de la Liste à modifier.
options	UpdateOptions & { 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

lists/client.ts:1610

▸ update(id, options?): Promise<ListUpdateResponse>

​

Paramètres

Nom	Type
id	string
options?	UpdateOptions

​

Renvoie

Promise<ListUpdateResponse>

​

Défini dans

lists/client.ts:1623

---

​

delete

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

Supprimer une Liste Supprime une Liste spécifique appartenant à l’utilisateur authentifié via son id.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de la Liste à supprimer.
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

lists/client.ts:1731

▸ delete(id): Promise<ListDeleteResponse>

​

Paramètres

Nom	Type
id	string

​

Renvoie

Promise<ListDeleteResponse>

​

Défini dans

lists/client.ts:1744