DirectMessagesClient

Client pour les opérations de messages privés

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

​

Constructeurs

​

constructor

• new DirectMessagesClient(client): DirectMessagesClient

Crée une nouvelle instance de client de messages privés

​

Paramètres

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

​

Renvoie

DirectMessagesClient

​

Défini dans

direct_messages/client.ts:340

​

Méthodes

​

createByConversationId

▸ createByConversationId(dmConversationId, options): Promise<Response>

Créer un message privé par identifiant de conversation
Envoie un nouveau message privé dans une conversation spécifique à l’aide de son identifiant.

​

Paramètres

Nom	Type	Description
dmConversationId	string	L’identifiant de la conversation de DM.
options	CreateByConversationIdOptions & { 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

direct_messages/client.ts:385

▸ createByConversationId(dmConversationId, options?): Promise<CreateDmEventResponse>

​

Paramètres

Nom	Type
dmConversationId	string
options?	CreateByConversationIdOptions

​

Retourne

Promise<CreateDmEventResponse>

​

Défini dans

direct_messages/client.ts:398

---

​

getEventsByConversationId

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

Obtenir les événements de messages privés pour une conversation Récupère les événements de messages privés pour une conversation donnée.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de la conversation de messages privés (DM).
options	GetEventsByConversationIdOptions & { 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

direct_messages/client.ts:506

▸ getEventsByConversationId(id, options?): Promise<Get2DmConversationsIdDmEventsResponse>

​

Paramètres

Nom	Type
id	string
options?	GetEventsByConversationIdOptions

​

Renvoie

Promise<Get2DmConversationsIdDmEventsResponse>

​

Défini dans

direct_messages/client.ts:519

---

​

createConversation

▸ createConversation(options): Promise<Response>

Créer une conversation de messages privés Démarre une nouvelle conversation de messages privés avec les participants spécifiés.

​

Paramètres

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

direct_messages/client.ts:784

▸ createConversation(options?): Promise<CreateDmEventResponse>

​

Paramètres

Nom	Type
options?	CreateConversationOptions

​

Renvoie

Promise<CreateDmEventResponse>

​

Défini dans

direct_messages/client.ts:793

---

​

getEventsByParticipantId

▸ getEventsByParticipantId(participantId, options): Promise<Response>

Obtenir les événements de messages directs pour une conversation Récupère les événements de messages directs pour une conversation spécifique.

​

Paramètres

Nom	Type	Description
participantId	string	L’identifiant de l’utilisateur participant à la conversation de DM en tête-à-tête.
options	GetEventsByParticipantIdOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

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

​

Défini dans

direct_messages/client.ts:889

▸ getEventsByParticipantId(participantId, options?): Promise<Get2DmConversationsWithParticipantIdDmEventsResponse>

​

Paramètres

Nom	Type
participantId	string
options?	GetEventsByParticipantIdOptions

​

Renvoie

Promise<Get2DmConversationsWithParticipantIdDmEventsResponse>

​

Défini dans

direct_messages/client.ts:902

---

​

getEvents

▸ getEvents(options): Promise<Response>

Obtenir les événements de DM Récupère une liste des événements récents de messages privés (DM) sur l’ensemble des conversations.

​

Paramètres

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

​

Renvoie

Promise<Response>

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

​

Défini dans

direct_messages/client.ts:1167

▸ getEvents(options?): Promise<Get2DmEventsResponse>

​

Paramètres

Nom	Type
options?	GetEventsOptions

​

Renvoie

Promise<Get2DmEventsResponse>

​

Définie dans

direct_messages/client.ts:1176

---

​

getEventsById

▸ getEventsById(eventId, options): Promise<Response>

Obtenir un événement de message privé (DM) par identifiant Récupère les détails d’un événement de message privé (DM) spécifique à partir de son identifiant.

​

Paramètres

Nom	Type	Description
eventId	string	Identifiant de l’événement de DM.
options	GetEventsByIdOptions & { 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

direct_messages/client.ts:1433

▸ getEventsById(eventId, options?): Promise<Get2DmEventsEventIdResponse>

​

Paramètres

Nom	Type
eventId	string
options?	GetEventsByIdOptions

​

Renvoie

Promise<Get2DmEventsEventIdResponse>

​

Défini dans

direct_messages/client.ts:1446

---

​

deleteEvents

▸ deleteEvents(eventId, options): Promise<Response>

Supprimer un événement de DM Supprime un événement de message privé spécifique par son identifiant, s’il appartient à l’utilisateur authentifié.

​

Paramètres

Nom	Type	Description
eventId	string	L’identifiant de l’événement de message privé à supprimer.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Renvoie

Promise<Response>

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

​

Défini dans

direct_messages/client.ts:1656

▸ deleteEvents(eventId): Promise<DeleteDmResponse>

​

Paramètres

Nom	Type
eventId	string

​

Renvoie

Promise<DeleteDmResponse>

​

Défini dans

direct_messages/client.ts:1669

---

​

createByParticipantId

▸ createByParticipantId(participantId, options): Promise<Response>

Créer un message privé (DM) à partir de l’id du participant
Envoie un nouveau message privé à un participant spécifique en utilisant son id.

​

Paramètres

Nom	Type	Description
participantId	string	L’identifiant de l’utilisateur destinataire qui recevra le DM.
options	CreateByParticipantIdOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

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

​

Défini dans

direct_messages/client.ts:1760

▸ createByParticipantId(participantId, options?): Promise<CreateDmEventResponse>

​

Paramètres

Nom	Type
participantId	string
options?	CreateByParticipantIdOptions

​

Renvoie

Promise<CreateDmEventResponse>

​

Défini dans

direct_messages/client.ts:1773