Skip to end of metadata
Go to start of metadata

Свойства

ПассивныйРежим / PullMode

Свойство типа boolean переводит компоненту в пассивный режим. В этом режиме приходящие уведомления не отправляются в , а помещаются в очередь компоненты. Получить уведомления из очереди можно при помощи метода ПолучитьСледующееУведомление (PullNextNotification)

Пример:

Методы

Подключиться / Connect

Подключиться к серверу. Если при подключении к серверу произойдет ошибка, то дополнительно будет отправлено Внешнее событие.

Синтаксис:

Параметры:

  • url - URL или IP адрес сервера
  • login - логин пользователя
  • password - пароль пользователя

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

Исключения:

  • java.lang.SecurityException : User name [Иван Иванов] or password is invalid - логин не найден либо неверный пароль
  • Apache.NMS... - ошибка взаимодействия с сервером. Вариантов много, но все будут начинаться с Apache.NMS
  • com.orangeuce.pbx.api.exception.ApiConnectionLimitExceedException - на сервере кончились клиентские лицензии
  • com.orangeuce.pbx.api.exception.EmergencyPeriodExceededException - у экстренных лицензий истек срок

Доступность: 

Доступен с 1.24.

Пример:

Отключиться / Disconnect

Отключиться от сервера.

Синтаксис:

Параметры: нет

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

Исключения:

  • Apache.NMS... - соединение с сервером отсутствует.

Доступность:

Доступен с 1.24.

Пример:

ПроверитьПодключение / CheckConnection

Проверить подключение к серверу.

Синтаксис:

Параметры: нет

Возвращаемое значение: true или false. true, если подключение уже установлено.

Исключения: нет

Доступность:

Доступен с 1.25.

Пример:

ПолучитьСледующееУведомление / PullNextNotification

Получить следующее уведомление в пассивном режиме работы. Если очередь уведомлений пуста, то оба параметра будут пустыми строками. Переключение между активным и пассивным режимами работы производится при помощи свойства ПассивныйРежим (PullMode).

Синтаксис:

Параметры:

  • type - тип уведомления
  • message - уведомление

Возвращаемое значение: нет. Параметры являются исходящими, именно через них возвращается результат

Исключения: нет

Доступность:

Доступен с 1.22.

Пример:

ПолучитьОшибку / GetLastError

Получить последнее исключение.

Синтаксис:

Параметры:

  • type - тип исключение, возможные типы описаны в разделах Исключения
  • message - сообщение дополнительная информация об ошибке

Возвращаемое значение: нет. Параметры являются исходящими, именно через них возвращается результат

Исключения: нет

Доступность:

Доступен с 1.22.

Пример:

ПолучитьВремяСервера / GetServerUTCTime

Получает время сервера в формате UnixTime в часовом поясе UTC в микросекундах.

Синтаксис:

Параметры: нет

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

Исключения:

  • Apache.NMS... - ошибка взаимодействия с сервером. Вариантов много, но все будут начинаться с Apache.NMS

Доступность:

Доступен с 1.22.

Пример:

ПолучитьЛокальноеВремяСервера / GetServerLocalTime

Получает локальное время сервера в формате UnixTime в микросекундах.

Синтаксис:

Параметры: нет

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

Исключения:

  • Apache.NMS... - ошибка взаимодействия с сервером. Вариантов много, но все будут начинаться с Apache.NMS

Доступность:

Доступен с 1.22.

Пример:

ПолучитьЧасовойПояс / GetServerTimeZoneOffset

Получает смещение времени сервера относительно часового UTC в микросекундах.

Синтаксис:

Параметры: нет

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

Исключения:

  • Apache.NMS... - ошибка взаимодействия с сервером. Вариантов много, но все будут начинаться с Apache.NMS

Доступность:

Доступен с 1.22.

Пример:

ПолучитьВерсиюКомпоненты / GetComponentVersion

Получает версию используемой компоненты.

Синтаксис:

Параметры: нет

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

Версия используемого компонента.

Исключения: нет

Доступность:

Доступен с 1.24.

Пример:

ПолучитьВерсиюСервера / GetServerVersion

Получает версию сервера, к которому установлено подключение.

Синтаксис:

Параметры: нет

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

Версия сервера, к которому установлено подключение.

 Исключения:

  • Apache.NMS... - ошибка взаимодействия с сервером. Вариантов много, но все будут начинаться с Apache.NMS

Доступность:

Доступен с 1.24.

Пример:

События

Connection

Особое внутреннее событие, которое придет вне зависимости от настроек ПассивныйРежим или PullMode.

Сообщение:

  • Connected - соединение установлено
  • Disconnected - соединение разорвано
  • Failed - соединение не удалось восстановить

Доступность: 

Доступно с 1.22.

com.orangeuce.pbx.api.events.DisconnectEvent

Уведомление о том, что клиент был принудительно отключен от сервера. Попытки переподключения производиться не будут.

Сообщение:

Доступность: 

Доступно с 1.22.

  • No labels