Функции iOS

Далее идёт список функций, которые применяются при разработке на IDE Xcode под iOS.

initWithViewController

Функция инициализации объекта SDK.

Параметры:

• vc – используемый для инициализации вьюконтроллер (UIViewController);

• serverIP – сервер и порт, к которому нужно присоединиться в виде <server address>:<server port> (NSString);

• directConnection (опциональный) – использование прямого соединения (BOOL). По умолчанию YES.

start

Запуск SDK после инициализации.

startWithServersList

Запуск SDK после инициализации со списком серверов. Происходит перебор адресов из переданного списка и подключение к первому рабочему серверу.

Параметры:

• serversList – список адресов серверов, разделённых запятой (NSString).

isStarted

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

stop

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

loginAs

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

Параметры:

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

• pwd – пароль (строка);

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

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

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

logout

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

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

callTo

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

Параметры:

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

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

joinConf

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

Параметры:

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

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

hangup

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

Параметры:

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

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

acceptCall

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

Параметры:

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

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

parseProtocolLink

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

Параметры:

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

scheduleLoginAs

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

Параметры:

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

• pwd – пароль (строка);

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

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

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

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

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

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

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

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

muteMicrophone

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

Параметры:

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

muteCamera

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

Параметры:

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

getMyId

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

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

getMyName

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

Возвращаемое значение (строка) – имя текущего пользователя. Содержит Nil если пользователь не авторизован на сервере.

isConnectedToServer

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

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

isLoggedIn

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

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

isInConference

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

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

getUserStatus

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

Параметры:

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

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

microphoneMuted

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

Возвращаемое значение (булевое) – true, когда микрофон отключен, false – микрофон включен.

cameraMuted

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

Возвращаемое значение (булевое) – true, когда камера отключена, false – камера включена.

acceptRecord

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

Параметры:

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

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

sendChatMessage

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

Параметры:

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

• text – (строка) текст сообщения.

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

setInitViewController

Вызывается перед запуском интерфейса звонка. Позволяет переопределить базовый вьюконтроллер в SDK. Имеет приоритет перед вьюконтроллером заданным при инициализации SDK.

Параметры:

• aInitViewController – вьюконтроллер, который нужно использовать (UIViewController).

setNewExtraButtons

Добавить дополнительные кнопки в панель управления конференцией. Кнопки будут добавлены в список, который открывается по тапу на кнопку троеточия (правая кнопка в панели) в порядке расположения их в переданном массиве. Смотрите Пример 5.

Параметры:

• btns – массив из объектов типа UIAlertAction (NSArray).

orientationWillChangeTo

Должна вызываться при начале смены ориентации интерфейса. Ретрансляция события главного контроллера приложения.

Параметры:

• toOrientation – новая ориентация интерфейса (UIInterfaceOrientation).

orientationDidChangeTo

Должна вызываться при окончании смены ориентации интерфейса. Ретрансляция события главного контроллера приложения.

Параметры:

• toOrientation – новая ориентация интерфейса (UIInterfaceOrientation)

trueConfSDKLogEnable

Свойство типа BOOL, которое включает либо отключает расширенное логирование. По умолчанию NO.

getUserName

Функция возвращает отображаемое имя другого пользователя.

Параметры:

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

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