Obtener mensajes

Recupera el historial de mensajes de una sala con opciones de cantidad y punto de inicio.

Descripción

La función getMessages() devuelve el historial de mensajes de una sala específica, en una cantidad definida y contada desde un cierto mensaje dentro de esa sala.

Parámetros

El argumento de la función getMessages() es un objeto con las siguientes claves:

• roomId: Clave obligatoria con un valor de Tipo de dato "string", que corresponde al ID de la sala de la cual se obtendrán los mensajes. El ID de la sala actual es una clave dentro del objeto room de widgetService, y se puede acceder de la siguiente manera: widgetService.room.id

• limit: Clave opcional de Tipo de dato "number", que define el número de mensajes a obtener. Si no se establece, por defecto se obtendrán 20 mensajes.

• id: Clave opcional de Tipo de dato "string" o "number", que indica el ID del mensaje desde el cual se empezarán a obtener los mensajes. Si no se establece, por defecto será null, y se obtendrán los últimos mensajes según el valor de "limit".

Ejemplo de uso

/**
* @param {GetMessages} [params]
* @returns {Promise<Message[]>}
**/

widgetInstance.getMessages ({
    roomId: "<someStringValue>",
    id?: "<someStringOrNumberValue>",
    limit?: <someNumberValue>,
  }
);