DirectMessagesClient

Cliente para operaciones con mensajes directos

Este cliente proporciona métodos para interactuar con los endpoints de mensajes directos de la X API. Se encarga de la autenticación, el formato de las solicitudes y el procesamiento de las respuestas para todas las operaciones relacionadas con mensajes directos.

​

Constructores

​

constructor

• new DirectMessagesClient(client): DirectMessagesClient

Crea una nueva instancia del cliente de mensajes directos

​

Parámetros

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

​

Devuelve

DirectMessagesClient

​

Definido en

direct_messages/client.ts:340

​

Métodos

​

createByConversationId

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

Crear un mensaje directo por ID de conversación
Envía un nuevo mensaje directo a una conversación específica mediante su ID.

​

Parámetros

Nombre	Tipo	Descripción
dmConversationId	string	El id de la conversación de MD.
options	CreateByConversationIdOptions & { 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

direct_messages/client.ts:385

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

​

Parámetros

Nombre	Tipo
dmConversationId	string
options?	CreateByConversationIdOptions

​

Devuelve

Promise<CreateDmEventResponse>

​

Definido en

direct_messages/client.ts:398

---

​

getEventsByConversationId

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

Obtiene los eventos de MD de una conversación de mensajes directos
Recupera los eventos de mensajes directos de una conversación específica.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El id de la conversación de Mensajes Directos (DM).
options	GetEventsByConversationIdOptions & { 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

direct_messages/client.ts:506

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

​

Parámetros

Nombre	Tipo
id	string
options?	GetEventsByConversationIdOptions

​

Devuelve

Promise<Get2DmConversationsIdDmEventsResponse>

​

Definido en

direct_messages/client.ts:519

---

​

createConversation

▸ createConversation(options): Promise<Response>

Crear una conversación de MD Inicia una nueva conversación de mensaje directo con los participantes especificados.

​

Parámetros

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

direct_messages/client.ts:784

▸ createConversation(options?): Promise<CreateDmEventResponse>

​

Parámetros

Nombre	Type
options?	CreateConversationOptions

​

Devuelve

Promise<CreateDmEventResponse>

​

Definido en

direct_messages/client.ts:793

---

​

getEventsByParticipantId

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

Obtener eventos de mensajes directos de una conversación Recupera los eventos de mensajes directos para una conversación específica.

​

Parámetros

Nombre	Tipo	Descripción
participantId	string	El identificador del usuario participante en la conversación de MD uno a uno.
options	GetEventsByParticipantIdOptions & { 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

direct_messages/client.ts:889

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

​

Parámetros

Nombre	Tipo
participantId	string
options?	GetEventsByParticipantIdOptions

​

Devuelve

Promise<Get2DmConversationsWithParticipantIdDmEventsResponse>

​

Definido en

direct_messages/client.ts:902

---

​

getEvents

▸ getEvents(options): Promise<Response>

Obtener eventos de MD Obtiene una lista de eventos recientes de mensajes directos de todas las conversaciones.

​

Parámetros

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

direct_messages/client.ts:1167

▸ getEvents(options?): Promise<Get2DmEventsResponse>

​

Parámetros

Nombre	Tipo
options?	GetEventsOptions

​

Devuelve

Promise<Get2DmEventsResponse>

​

Definido en

direct_messages/client.ts:1176

---

​

getEventsById

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

Obtener evento de MD por ID
Obtiene los detalles de un evento de mensaje directo específico por su ID.

​

Parámetros

Nombre	Tipo	Descripción
eventId	string	id del evento de DM.
options	GetEventsByIdOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

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

​

Definido en

direct_messages/client.ts:1433

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

​

Parámetros

Nombre	Tipo
eventId	string
options?	GetEventsByIdOptions

​

Devuelve

Promise<Get2DmEventsEventIdResponse>

​

Definido en

direct_messages/client.ts:1446

---

​

deleteEvents

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

Eliminar evento de MD
Elimina un evento de mensaje directo específico por su id, si pertenece al usuario autenticado.

​

Parámetros

Nombre	Tipo	Descripción
eventId	string	La ID del evento de mensaje directo que se va a eliminar.
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

direct_messages/client.ts:1656

▸ deleteEvents(eventId): Promise<DeleteDmResponse>

​

Parámetros

Nombre	Tipo
eventId	string

​

Devuelve

Promise<DeleteDmResponse>

​

Definido en

direct_messages/client.ts:1669

---

​

createByParticipantId

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

Crear un mensaje directo por identificador de participante Envía un nuevo mensaje directo a un participante específico mediante su identificador.

​

Parámetros

Name	Type	Description
participantId	string	El id del usuario destinatario que recibirá el DM.
options	CreateByParticipantIdOptions & { 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

direct_messages/client.ts:1760

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

​

Parámetros

Nombre	Tipo
participantId	string
options?	CreateByParticipantIdOptions

​

Devuelve

Promise<CreateDmEventResponse>

​

Definido en

direct_messages/client.ts:1773