ClientMessageBridge. Описание API

WebSocketMessageConfigs: Array

Коллекция конфигурационных объектов.

LocalStoreName: String

Название хранилища, в котором сохраняется история сообщений.

LocalStore: Terrasoft.LocalStore

Экземпляр класса, реализующий доступ к локальному хранилищу.

init()

Инициализирует значения по умолчанию.

getSandboxMessageListenerExists(sandboxMessageName)

Проверяет наличие слушателей сообщения с переданным именем.

Параметры:

sandboxMessageName: String — имя сообщения, с которым оно будет разослано внутри системы.

Возвращаемое значение:

Boolean — результат проверки наличия слушателя сообщения

publishMessageResult(sandboxMessageName, webSocketMessage)

Публикует сообщение внутри системы.

Параметры:

sandboxMessageName: String — имя сообщения, с которым оно будет разослано внутри системы.

webSocketMessage: Object — сообщение полученное по WebSocket.

Возвращаемое значение:

* — результат, полученный от обработчика сообщения.

beforePublishMessage(sandboxMessageName, webSocketBody, publishConfig)

Обработчик, вызываемый перед публикацией сообщения внутри системы.

Параметры:

sandboxMessageName: String — имя сообщения, с которым оно будет разослано внутри системы.

webSocketBody: Object — сообщение, полученное по WebSocket.

publishConfig: Object — конфигурационный объект рассылки сообщения.

afterPublishMessage(sandboxMessageName, webSocketBody, result, publishConfig)

Обработчик, вызываемый после публикации сообщения внутри системы.

Параметры:

sandboxMessageName: String — имя сообщения, с которым оно будет разослано внутри системы.

webSocketBody: Object — сообщение, полученное по WebSocket. result: * — результат выполнения публикации сообщения внутри системы.

publishConfig: Object — конфигурационный объект рассылки сообщения.

addMessageConfig(config)

Добавляет новый конфигурационный объект в коллекцию конфигурационных объектов.

Параметры:

config: Object — конфигурационный объект.

Пример конфигурационного объекта:

{
    "sender": "webSocket sender key 1",
    "messageName": "sandbox message name 1",
    "isSaveHistory": true
}

Здесь:

• sender: String — имя сообщения, которое ожидается получить по WebSocket.
• messageName: String — имя сообщения, с которым оно будет разослано внутри системы.
• isSaveHistory: Boolean — признак, отвечающий за необходимость сохранения истории сообщений.

saveMessageToHistory(sandboxMessageName, webSocketBody)

Сохраняет сообщение в хранилище, если подписчик отсутствует, а в конфигурационном объекте указан признак необходимости сохранения.

Параметры:

sandboxMessageName: String — имя сообщения, с которым оно будет разослано внутри системы.

webSocketBody: Object — сообщение, полученное по WebSocket.

getMessagesFromHistory(sandboxMessageName)

Возвращает массив сохраненных сообщений из хранилища.

Параметры:

sandboxMessageName: String — имя сообщения, с которым оно будет разослано внутри системы.

deleteSavedMessages(sandboxMessageName)

Удаляет из хранилища сохраненные сообщения.

Параметры:

sandboxMessageName: String — имя сообщения, с которым оно будет разослано внутри системы.