Class EntryPoint

Точка входа

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

const videoEntryPoint =
    ConferenceDataService.newEntryPoint()
        .setEntryPointType(ConferenceDataService.EntryPointType.VIDEO)
        .setUri('https://example.com/myroom')
        .setPasscode('12345');

const phoneEntryPoint =
    ConferenceDataService.newEntryPoint()
        .setEntryPointType(ConferenceDataService.EntryPointType.PHONE)
        .setUri('tel:+11234567890,,,112233445;9687')
        .addFeature(ConferenceDataService.EntryPointFeature.TOLL)
        .setPin('9687');

const sipEntryPoint =
    ConferenceDataService.newEntryPoint()
        .setEntryPointType(ConferenceDataService.EntryPointType.SIP)
        .setUri('sip:joe@example.com')
        .setAccessCode('1234567');

const moreEntryPoint =
    ConferenceDataService.newEntryPoint()
        .setEntryPointType(ConferenceDataService.EntryPointType.MORE)
        .setUri('https://example.com/moreJoiningInfo');

Методы

Метод Тип возвращаемого значения Краткое описание
add Feature(feature) Entry Point Добавляет возможность выбора точки въезда, например, платная или бесплатная.
set Access Code(accessCode) Entry Point Код доступа для участия в конференции.
set Entry Point Type(entryPointType) Entry Point Задает тип этой точки входа.
set Meeting Code(meetingCode) Entry Point Код доступа к конференции.
set Passcode(passcode) Entry Point Код доступа для участия в конференции.
set Password(password) Entry Point Код доступа к конференции.
set Pin(pin) Entry Point ПИН-код для доступа к конференции.
set Region Code(regionCode) Entry Point Региональный код CLDR/ISO 3166 для страны, связанной с данной точкой входа.
set Uri(uri) Entry Point Задает URI для присоединения к конференции через эту точку входа.

Подробная документация

addFeature(feature)

Добавляет возможность выбора точки въезда, например, платная или бесплатная.

Параметры

Имя Тип Описание
feature Entry Point Feature Функция, которую нужно настроить.

Возвращаться

EntryPoint — этот объект используется для создания цепочек вызовов.

Броски

Error — если данная функция неприменима к этой точке входа.

setAccessCode(accessCode)

Код доступа для участия в конференции. Максимальная длина 128 символов. Необязательно.

Параметры

Имя Тип Описание
access Code String Код доступа для установки.

Возвращаться

EntryPoint — этот объект используется для создания цепочек вызовов.

Броски

Error — если предоставленный код доступа слишком длинный.

setEntryPointType(entryPointType)

Задает тип этой точки входа. Обязательно.

Параметры

Имя Тип Описание
entry Point Type Entry Point Type Тип точки входа для установки.

Возвращаться

EntryPoint — этот объект используется для создания цепочек вызовов.

setMeetingCode(meetingCode)

Код доступа к конференции. Максимальная длина 128 символов. Необязательно.

Параметры

Имя Тип Описание
meeting Code String Код встречи, который необходимо установить.

Возвращаться

EntryPoint — этот объект используется для создания цепочек вызовов.

Броски

Error — если предоставленный код встречи слишком длинный.

setPasscode(passcode)

Код доступа к конференции. Максимальная длина 128 символов. Необязательно.

Параметры

Имя Тип Описание
passcode String Код доступа для установки.

Возвращаться

EntryPoint — этот объект используется для создания цепочек вызовов.

Броски

Error — если предоставленный пароль слишком длинный.

setPassword(password)

Пароль для доступа к конференции. Максимальная длина 128 символов. Необязательно.

Параметры

Имя Тип Описание
password String Пароль для установки.

Возвращаться

EntryPoint — этот объект используется для создания цепочек вызовов.

Броски

Error — если предоставленный пароль слишком длинный.

setPin(pin)

PIN-код для доступа к конференции. Максимальная длина 128 символов. Необязательно.

Параметры

Имя Тип Описание
pin String PIN-код для установки.

Возвращаться

EntryPoint — этот объект используется для создания цепочек вызовов.

Броски

Error — если предоставленный PIN-код слишком длинный.

setRegionCode(regionCode)

Региональный код CLDR/ISO 3166 для страны, связанной с данной точкой входа. Применимо только к типам точек входа, связанным с телефоном. Необязательно.

Параметры

Имя Тип Описание
region Code String Код региона для установки.

Возвращаться

EntryPoint — этот объект используется для создания цепочек вызовов.

Броски

Error — если предоставленный regionCode слишком длинный.

setUri(uri)

Задает URI для подключения к конференции через эту точку входа. Для точек входа PHONE требуется префикс tel: :. Для точек входа SIP требуется префикс sip: :. Для точек входа VIDEO и MORE требуются префиксы http: или https: :. Максимальная длина 1300 символов. Обязательно.

Параметры

Имя Тип Описание
uri String URI для установки.

Возвращаться

EntryPoint — этот объект используется для создания цепочек вызовов.

Броски

Error — если предоставленный URI имеет некорректный формат.