Функции Cordova

Далее идёт список функций, которые применяются при разработке кросс-платформенных мобильных приложений под Cordova.

start

Запуск SDK после завершения начальной настройки.

Параметры:

• server (опциональный) – сервер, к которому нужно присоединиться (String).

stop

Остановка работы экземпляра SDK и освобождение ресурсов.

loginAs

Авторизация под определённым пользователем с указанными параметрами на сервере.

Параметры:

• user – идентификатор пользователя (String);

• password – пароль (String);

• encryptPassword – true, если пароль передается в открытом виде (и SDK требуется его зашифровать); false, если он уже в зашифрованном виде (Boolean);

• enableAutoLogin – нужно ли автоматически авторизовать пользователя этим идентификатором при повторном запуске (Boolean).

Возвращаемое значение (Boolean): true - запрос на авторизацию отправлен на сервер, false – авторизацию невозможно произвести.

logout

Деавторизация (выход из системы) аккаунта без отключения SDK от сервера видеосвязи.

Возвращаемое значение (Boolean): true - запрос на деавторизацию отправлен на сервер, false – деавторизацию невозможно произвести.

callTo

Звонок указанному абоненту.

Параметры:

• user – TrueConf ID вызываемого абонента (String).

Возвращаемое значение (Boolean): true - звонок отправлен на сервер, false – звонок невозможно произвести.

joinConf

Подключение к групповой конференции.

Параметры:

• conferenceId – идентификатор конференции (String).

Возвращаемое значение (Boolean): true звонок отправлен на сервер, false – звонок невозможно произвести.

hangup

Завершение текущего звонка или конференции.

Параметры:

• forAll – в случае конференции завершать ли её для всех участников при наличии полномочий (Boolean). По умолчанию true.

Возвращаемое значение (Boolean): true - звонок завершить возможно, false – звонок завершить невозможно (обычно по причине неверного состояния).

acceptCall

Ответ на входящий звонок.

Параметры:

• accept – принять или отклонить вызов (Boolean).

Возвращаемое значение (Boolean): true - ответ на запрос можно произвести, false – ответ невозможен.

parseProtocolLink

Функция получает в виде строки команду, содержащую указания, к какому серверу подключиться, каким аккаунтом авторизоваться и какой звонок осуществить. После чего автоматически выполняет все эти операции.

Параметры:

• cmd – обрабатываемая строка (String).

scheduleLoginAs

Получение списка операций, которые должны осуществиться последовательно, в том числе сервер для присоединения, идентификационные данные аккаунта и адресата звонка. Является эквивалентом функции ParseProtocolLink, в которой параметры передаются не в виде строки протокола, а по отдельности. Строковые параметры могут быть пустыми.

Параметры:

• login – идентификатор пользователя (String);

• pwd – пароль (String);

• encryptPassword – true, если пароль передается в открытом виде (и SDK требуется его зашифровать), false, если он уже в зашифрованном виде (Boolean);

• callToUser – идентификатор вызываемого абонента (String);

• autoClose – нужно ли закрывать сеанс работы с сервером после выполнения звонка или прерывания выполнения (Boolean);

• loginTemp – признак временного логина. Означает, что после звонка нужно деавторизовать клиент (Boolean);

• loginForce – принудительный логин. Авторизация будет произведена даже в том случае, если клиент уже авторизован на сервере (Boolean);

• domain – домен, в котором будет осуществляться автоматический поиск сервера (String);

• serversList – список серверов, к которым необходимо подключиться (String);

• isPublic – параметр, указывающий, что callToUser является именем конференции, а не именем пользователя. При неверном значении этого параметра звонок пользователю или подключение к конференции не выполнится (Boolean).

muteMicrophone

Изменение состояния микрофона.

Параметры:

• mute – состояние, в которое требуется перевести микрофон: true – выключен, false – включен (Boolean).

muteCamera

Изменение состояния камеры.

Параметры:

• mute – состояние, в которое требуется перевести камеру: true – выключена, false – включена (Boolean).

getMyId

Получение собственного идентификатора.

Возвращаемое значение (String): идентификатор текущего пользователя в системе.

getMyName

Получение собственного имени для показа в интерфейсе.

Возвращаемое значение (String): имя текущего пользователя.

isStarted

Проверка состояния работы экземпляра SDK, результат типа Boolean.

isConnectedToServer

Проверка соединения с сервером.

Возвращаемое значение (Boolean): true - есть соединение с сервером, false – соединение отсутствует.

isLoggedIn

Проверка состояния авторизации.

Возвращаемое значение (Boolean): true - пользователь авторизован на сервере, false – пользователь не авторизован.

isInConference

Проверка нахождения в конференции.

Возвращаемое значение (Boolean): true - клиент находится в конференции, false – клиент вне конференции.

getUserStatus

Получение статуса другого пользователя. Если статус известен, он возвращается немедленно. Если нет – статус запрашивается на сервере, а клиент подписывается на получение уведомлений о его изменении.

Параметры:

• user – TrueConf ID пользователя, статус которого запрашивается (String).

Возвращаемое значение (Number): текущий статус пользователя.

isMicrophoneMuted

Проверка состояния микрофона.

Возвращаемое значение (Boolean): true - отключен, false – включен.

isCameraMuted

Проверка состояния камеры.

Возвращаемое значение (Boolean): true - отключена, false – включена.

acceptRecord

Ответ на входящий запрос на видеозапись.

Параметры:

• accept – принять или отклонить запрос на видеозапись (Boolean);

• userID – TrueConf ID пользователя, которому даётся ответ на запрос (String).

sendChatMessage

Отправка текстового сообщения.

Параметры:

• userID – TrueConf ID пользователя, которому отправляется сообщение (рекомендуется использовать полный ID вида user@server.name) (String). Для отправки сообщения в чат текущей групповой конференции этот параметр должен быть пустым.

• message – текст сообщения (String).

Возвращаемое значение (Boolean): true - сообщение отправлено на сервер, false – сообщение отправить не удалось из-за отсутствия соединения с сервером.

showAlertPage

Функция для отображения другого окна поверх окна конференции.

Параметры:

• alertText – текст для отображения на другом окне (String).

addExtraButton

Функция добавления дополнительных кастомных кнопок в панель управления конференцией. Нажатие кнопки следует обрабатывать в событии onExtraButtonPressed.

Параметры:

• title – название кнопки (String).

getInstance

Функция получения экземпляра SDK.

Возвращаемое значение (Promise.<TrueConfSDK>): промис с экземпляром SDK, который будет вызван после запуска SDK.

addEventListener

Подключение слушателя для определённого события SDK.

Параметры:

• name – название события (String);

• callback – функция обработки события (Function).

removeEventListener

Удаление слушателя определённого события SDK.

Параметры:

• name – название события (String);

• callback – функция обработки события (Function).

clearEventListeners

Удаление всех слушателей или слушателя определённого события SDK.

Параметры:

• name (опциональный) – название события (String). Если параметр не указывать, то удалятся все слушатели.