Методы объекта
Connect
Синтаксис:
Connect(<АдресСервера>, <Токен>, <Данные>, <Таймаут>)
Параметры:
<АдресСервера> (обязательный)
Тип: Строка
URL-адрес сервера в формате ws://host:port/connection/websocket или wss://host:port/connection/websocket
<Токен> (обязательный)
Тип: Строка
JWT для идентификации
<Данные> (необязательный)
Тип: Строка
Дополнительные данные в формате JSON
<Таймаут> (необязательный)
Тип: Число
Определяет время ожидания (в секундах)
Возвращаемое значение:
Ложь - если соединение не удалость установить; строка JSON - если соединение успешно установлено
Описание:
Устанавливает соединение с сервером.
Refresh
Синтаксис:
Refresh(<Токен>, <Таймаут>)
Параметры:
<Токен> (обязательный)
Тип: Строка
<Таймаут> (необязательный)
Тип: Число
Определяет время ожидания (в секундах)
Возвращаемое значение:
Ложь - если произошла ошибка; строка JSON - если команда успешно выполнена
Описание:
Обновление идентификации клиентского соединения. Может потребоваться в случае, если срок действия текущего токена истекает.
Disconnect
Синтаксис:
Disconnect()
Параметры: нет
Возвращаемое значение: нет
Описание:
Разрывает соединение с сервером.
Subscribe
Синтаксис:
Subscribe(<Канал>, <Таймаут>)
Параметры:
<Канал> (обязательный)
Тип: Строка
Имя канала
<Таймаут> (необязательный)
Тип: Число
Определяет время ожидания (в секундах)
Возвращаемое значение:
Ложь - если произошла ошибка; строка JSON - если команда успешно выполнена
Описание:
Включение подписки на указанный канал. Возвращает id команды.
Unsubscribe
Синтаксис:
Unsubscribe(<Канал>, <Таймаут>)
Параметры:
<Канал> (обязательный)
Тип: Строка
Имя канала
<Таймаут> (необязательный)
Тип: Число
Определяет время ожидания (в секундах)
Возвращаемое значение:
Ложь - если произошла ошибка; строка JSON - если команда успешно выполнена
Описание:
Отключение подписки на указанный канал.
Publish
Синтаксис:
Publish(<Канал>, <Данные>, <Таймаут>)
Параметры:
<Канал> (обязательный)
Тип: Строка
Имя канала <Данные> (необязательный)
Тип: Строка
Данные для публикации в формате JSON
<Таймаут> (необязательный)
Тип: Число
Определяет время ожидания (в секундах)
Возвращаемое значение:
Ложь - если произошла ошибка; строка JSON - если команда успешно выполнена
Описание:
Отправляет сообщение в указанный канал.
Presence
Синтаксис:
Presence(<Канал>, <Таймаут>)
Параметры:
<Канал> (обязательный)
Тип: Строка
Имя канала
<Таймаут> (необязательный)
Тип: Число
Определяет время ожидания (в секундах)
Возвращаемое значение:
Ложь - если произошла ошибка; строка JSON - если команда успешно выполнена
Описание:
Позволяет получить список клиентских соединений, подписанных на указанный канал.
History
Синтаксис:
History(<Канал>, <Таймаут>)
Параметры:
<Канал> (обязательный)
Тип: Строка
Имя канала
<Таймаут> (необязательный)
Тип: Число
Определяет время ожидания (в секундах)
Возвращаемое значение:
Ложь - если произошла ошибка; строка JSON - если команда успешно выполнена
Описание:
Позволяет получить историю действий в указанном канале.
Ping
Синтаксис:
Ping(<Таймаут>)
Параметры:
<Таймаут> (необязательный)
Тип: Число
Определяет время ожидания (в секундах)
Возвращаемое значение:
Ложь - если произошла ошибка; строка JSON - если команда успешно выполнена
Описание:
Позволяет отправить Ping-сообщение серверу.
ПолучитьСообщение(GetMessage)
Синтаксис:
ПолучитьСообщение(<Таймаут>)
Параметры:
<Имя> (необязательный)
Тип: Число
Определяет время ожидания (в секундах)
Возвращаемое значение:
Ложь - если произошла ошибка; строка JSON - если команда успешно выполнена
Описание:
Получает входящее сообщение от сервера.
ДобавитьHttpЗаголовок (AddHttpHeader)
Синтаксис:
ДобавитьHttpЗаголовок(<Имя>, <Значение>)
Параметры:
<Имя> (обязательный)
Тип: Строка
Имя заголовка
<Значение> (обязательный)
Тип: Строка
Значение заголовка
Возвращаемое значение:
Тип: Булево
Описание:
Позволяет добавлять дополнительные http-заголовоки, которые будут использоваться при установке соединения.
CreateToken
Синтаксис:
CreateToken(<SecretKey>, <Sub>, <Exp>, <Info>, <Channels>)
Параметры:
<SecretKey> (обязательный)
Тип: Строка
<Sub> (обязательный)
Идентификатор пользователя
Тип: Строка
<Exp> (необязательный)
Тип: Дата
Дата, до которой токен будет действителен (если не указывать, то срок годности токена не ограничен)
<Info> (необязательный)
Тип: Строка
Дополнительные данные, связанные с токеном
<Channels> (необязательный)
Тип: Строка
Список каналов (через запятую) на которые пользователь будет подписан автоматически (см. "server-side subscriptions", начиная с версии 2.4.0)
Возвращаемое значение:
Тип: Строка
Описание:
Возвращает JWT-токен, зашифрованный по алгоритму HS256.
ПолучитьОписаниеОшибки (GetLastError)
Синтаксис:
ПолучитьОписаниеОшибки()
Параметры:
нет
Возвращаемое значение:
Тип: Строка
Описание:
Возвращает описание ошибки.