Функции .NET

Функции для .NET делятся на платформозависимые, которые доступны отдельно для каждой платформы (Android, iOS), а также на общие, которые идентичны для каждой платформы.

Функции для Android

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

Init

Функция инициализации объекта Android SDK с передачей платформозависимых параметров.

Параметры:

• activity – текущий Activity для инициализации всех активностей и сервисов (Activity).

AddCustomButtons

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

Параметры:

• extraButtons – массив кнопок типа TCExtraButton.

GetTrueConfAppContext

Получение контекста из Android SDK.

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

Функции для iOS

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

Init

Функция инициализации объекта iOS SDK с передачей платформозависимых параметров.

Параметры:

• uiApplication – текущий UIApplication для работы с контроллерами приложения.

AddCustomButtons

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

Параметры:

• extraButtons – массив кнопок типа TCSDKExtraButton.

PresentViewController

Отображение нового UIViewController поверх окна конференции.

Параметры:

• controller – контроллер для отображения поверх окна конференции (UIViewController);

• animated – анимация появления контроллера (bool);

• sender – родительский контроллер (NSObject);

• completionHandler – действие, которое будет выполнено после появления контроллера (Action).

Общие функции

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

Start

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

Параметры:

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

Stop

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

LoginAs

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

Параметры:

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

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

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

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

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

Logout

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

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

CallTo

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

Параметры:

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

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

JoinConf

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

Параметры:

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

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

Hangup

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

Параметры:

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

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

AcceptCall

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

Параметры:

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

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

ParseProtocolLink

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

Параметры:

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

ScheduleLoginAs

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

Параметры:

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

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

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

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

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

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

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

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

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

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

MuteMicrophone

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

Параметры:

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

MuteCamera

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

Параметры:

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

GetMyId

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

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

GetMyName

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

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

IsStarted

Проверка состояния работы экземпляра SDK (bool).

IsConnectedToServer

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

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

IsLoggedIn

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

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

IsInConference

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

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

GetUserStatus

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

Параметры:

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

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

IsMicrophoneMuted

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

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

IsCameraMuted

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

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

AcceptRecord

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

Параметры:

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

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

SendChatMessage

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

Параметры:

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

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

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