Constructores
constructor
client): DirectMessagesClient
Crea una nueva instancia del cliente de Mensajes directos
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
client | Client | La instancia principal del cliente de la X API |
Devuelve
DirectMessagesClient
Definido en
Métodos
getEvents
options?): Promise<Get2DmEventsResponse>
Obtener eventos de MD
Obtiene una lista de eventos recientes de mensajes directos en todas las conversaciones.
Parámetros
| Nombre | Tipo |
|---|---|
options | GetEventsOptions |
Devuelve
Promise<Get2DmEventsResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
getEventsByParticipantId
participantId, options?): Promise<Get2DmConversationsWithParticipantIdDmEventsResponse>
Obtener eventos de MD de una conversación de MD
Recupera eventos de mensajes directos de una conversación específica.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
participantId | string | El id del usuario participante en la conversación de Mensajes Directos uno a uno. |
options | GetEventsByParticipantIdOptions | - |
Devuelve
Promise<Get2DmConversationsWithParticipantIdDmEventsResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
createByConversationId
dmConversationId, options?): Promise<CreateDmEventResponse>
Crear mensaje de MD 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 | - |
Devuelve
Promise<CreateDmEventResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
createByParticipantId
participantId, options?): Promise<CreateDmEventResponse>
Crear mensaje de MD por id de participante
Envía un nuevo mensaje directo a un participante específico por su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
participantId | string | El id del usuario destinatario que recibirá el DM. |
options | CreateByParticipantIdOptions | - |
Devuelve
Promise<CreateDmEventResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
getEventsByConversationId
id, options?): Promise<Get2DmConversationsIdDmEventsResponse>
Obtener eventos de MD de una conversación de MD
Recupera 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 DM. |
options | GetEventsByConversationIdOptions | - |
Devuelve
Promise<Get2DmConversationsIdDmEventsResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
getEventsById
eventId, options?): Promise<Get2DmEventsEventIdResponse>
Obtener evento de MD por id
Recupera los detalles de un evento específico de mensaje directo por su id.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
eventId | string | id del evento de DM. |
options | GetEventsByIdOptions | - |
Devuelve
Promise<Get2DmEventsEventIdResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
deleteEvents
eventId): Promise<DeleteDmResponse>
Eliminar evento de MD
Elimina un evento específico de mensaje directo por su id, si es propiedad del usuario autenticado.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
eventId | string | El id del evento de mensaje directo que se va a eliminar. |
Devuelve
Promise<DeleteDmResponse>
Promesa que se resuelve con la respuesta de la API
Definido en
createConversation
options?): Promise<CreateDmEventResponse>
Crear conversación de MD
Inicia una nueva conversación de mensajes directos con los participantes especificados.
Parámetros
| Nombre | Tipo |
|---|---|
options | CreateConversationOptions |
Devuelve
Promise<CreateDmEventResponse>
Promesa que se resuelve con la respuesta de la API