Class EntryPoint

EntryPoint

Definition einer bestimmten Methode, um an einer Videokonferenz teilzunehmen. Nutzungsbeispiel:

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');

Methoden

MethodeRückgabetypKurzbeschreibung
addFeature(feature)EntryPointFügt das Feature des Einstiegspunkts hinzu, z. B. ob es sich um eine gebührenpflichtige oder gebührenfreie Nummer handelt.
setAccessCode(accessCode)EntryPointEin Zugangscode für den Zugriff auf die Konferenz.
setEntryPointType(entryPointType)EntryPointLegt den Typ dieses Einstiegspunkts fest.
setMeetingCode(meetingCode)EntryPointEin Besprechungscode für den Zugriff auf die Konferenz.
setPasscode(passcode)EntryPointEin Sicherheitscode für den Zugriff auf die Konferenz.
setPassword(password)EntryPointEin Passwortcode für den Zugriff auf die Konferenz.
setPin(pin)EntryPointEine PIN für den Zugriff auf die Konferenz.
setRegionCode(regionCode)EntryPointDer CLDR-/ISO 3166-Regionscode für das Land, das mit diesem Einstiegspunkt verknüpft ist.
setUri(uri)EntryPointLegt den URI für die Teilnahme an der Videokonferenz über diesen Einstiegspunkt fest.

Detaillierte Dokumentation

addFeature(feature)

Fügt das Feature des Einstiegspunkts hinzu, z. B. ob es sich um eine gebührenpflichtige oder gebührenfreie Nummer handelt.

Parameter

NameTypBeschreibung
featureEntryPointFeatureDie festzulegende Funktion.

Rückflug

EntryPoint – dieses Objekt für die Verkettung

Löst

Error – wenn die Funktion für diesen Einstiegspunkt nicht zutrifft.


setAccessCode(accessCode)

Ein Zugangscode für den Zugriff auf die Konferenz. Maximale Länge: 128 Zeichen. Optional.

Parameter

NameTypBeschreibung
accessCodeStringDer festzulegende Zugangscode.

Rückflug

EntryPoint – dieses Objekt für die Verkettung

Löst

Error: wenn der angegebene Zugriffscode zu lang ist.


setEntryPointType(entryPointType)

Legt den Typ dieses Einstiegspunkts fest. Erforderlich.

Parameter

NameTypBeschreibung
entryPointTypeEntryPointTypeDer festzulegende Einstiegspunkttyp.

Rückflug

EntryPoint – dieses Objekt für die Verkettung


setMeetingCode(meetingCode)

Ein Besprechungscode für den Zugriff auf die Konferenz. Maximale Länge: 128 Zeichen. Optional.

Parameter

NameTypBeschreibung
meetingCodeStringDer festzulegende Besprechungscode.

Rückflug

EntryPoint – dieses Objekt für die Verkettung

Löst

Error: wenn der angegebene Besprechungscode zu lang ist.


setPasscode(passcode)

Ein Sicherheitscode für den Zugriff auf die Konferenz. Maximale Länge: 128 Zeichen. Optional.

Parameter

NameTypBeschreibung
passcodeStringDer festzulegende Sicherheitscode.

Rückflug

EntryPoint – dieses Objekt für die Verkettung

Löst

Error: wenn der angegebene Sicherheitscode zu lang ist.


setPassword(password)

Ein Passwortcode für den Zugriff auf die Konferenz. Maximale Länge: 128 Zeichen. Optional.

Parameter

NameTypBeschreibung
passwordStringDas festzulegende Passwort.

Rückflug

EntryPoint – dieses Objekt für die Verkettung

Löst

Error: wenn das angegebene Passwort zu lang ist.


setPin(pin)

Eine PIN für den Zugriff auf die Konferenz. Maximale Länge: 128 Zeichen. Optional.

Parameter

NameTypBeschreibung
pinStringDie einzustellende PIN.

Rückflug

EntryPoint – dieses Objekt für die Verkettung

Löst

Error: wenn der angegebene PIN-Code zu lang ist.


setRegionCode(regionCode)

Der CLDR-/ISO 3166-Regionscode für das Land, das mit diesem Einstiegspunkt verknüpft ist. Gilt nur für Telefon-Einstiegspunkt-Typen. Optional.

Parameter

NameTypBeschreibung
regionCodeStringDer festzulegende „regionCode“.

Rückflug

EntryPoint – dieses Objekt für die Verkettung

Löst

Error: Wenn der angegebene „regionCode“ zu lang ist.


setUri(uri)

Legt den URI für die Teilnahme an der Videokonferenz über diesen Einstiegspunkt fest. Für PHONE-Einstiegspunkte ist das Präfix tel: erforderlich. Für SIP-Einstiegspunkte ist das Präfix sip: erforderlich. Für die Einstiegspunkte VIDEO und MORE sind die Präfixe http: oder https: erforderlich. Maximale Länge: 1.300 Zeichen. Erforderlich.

Parameter

NameTypBeschreibung
uriStringDer festzulegende URI.

Rückflug

EntryPoint – dieses Objekt für die Verkettung

Löst

Error: Wenn der angegebene URI fehlerhaft ist.