Class EntryPoint

Point d'entrée

Définition d'une méthode spécifique pour rejoindre une conférence. Exemple d'utilisation : 

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

Méthodes

MéthodeType renvoyéBrève description
addFeature(feature)EntryPointAjoute la caractéristique du point d'accès, par exemple s'il est payant ou non.
setAccessCode(accessCode)EntryPointCode d'accès pour accéder à la conférence.
setEntryPointType(entryPointType)EntryPointDéfinit le type de ce point d'entrée.
setMeetingCode(meetingCode)EntryPointCode de réunion permettant d'accéder à la conférence.
setPasscode(passcode)EntryPointUn code secret pour accéder à la conférence.
setPassword(password)EntryPointCode de mot de passe permettant d'accéder à la conférence.
setPin(pin)EntryPointUn code PIN pour accéder à la conférence.
setRegionCode(regionCode)EntryPointCode région CLDR/ISO 3166 du pays associé à ce point d'entrée.
setUri(uri)EntryPointDéfinit l'URI permettant de rejoindre la conférence via ce point d'entrée.

Documentation détaillée

addFeature(feature)

Ajoute la caractéristique du point d'accès, par exemple s'il est payant ou non.

Paramètres

NomTypeDescription
featureEntryPointFeatureFonctionnalité à définir.

Renvois

EntryPoint : cet objet, pour le chaînage

Génère

Error : si la fonctionnalité n'est pas applicable à ce point d'entrée.

setAccessCode(accessCode)

Code d'accès pour accéder à la conférence. Longueur maximale : 128 caractères Facultatif.

Paramètres

NomTypeDescription
accessCodeStringCode d'accès à définir.

Renvois

EntryPoint : cet objet, pour le chaînage

Génère

Error : si le code d'accès fourni est trop long.

setEntryPointType(entryPointType)

Définit le type de ce point d'entrée. Obligatoire.

Paramètres

NomTypeDescription
entryPointTypeEntryPointTypeType de point d'entrée à définir.

Renvois

EntryPoint : cet objet, pour le chaînage

setMeetingCode(meetingCode)

Code de réunion permettant d'accéder à la conférence. Longueur maximale : 128 caractères Facultatif.

Paramètres

NomTypeDescription
meetingCodeStringCode de la réunion à définir.

Renvois

EntryPoint : cet objet, pour le chaînage

Génère

Error : si le code de réunion fourni est trop long.

setPasscode(passcode)

Un code secret pour accéder à la conférence. Longueur maximale : 128 caractères Facultatif.

Paramètres

NomTypeDescription
passcodeStringCode secret à définir.

Renvois

EntryPoint : cet objet, pour le chaînage

Génère

Error : si le code secret fourni est trop long.

setPassword(password)

Code de mot de passe permettant d'accéder à la conférence. Longueur maximale : 128 caractères Facultatif.

Paramètres

NomTypeDescription
passwordStringMot de passe à définir.

Renvois

EntryPoint : cet objet, pour le chaînage

Génère

Error : si le mot de passe fourni est trop long.

setPin(pin)

Un code PIN pour accéder à la conférence. Longueur maximale : 128 caractères Facultatif.

Paramètres

NomTypeDescription
pinStringCode PIN à définir.

Renvois

EntryPoint : cet objet, pour le chaînage

Génère

Error : si le code PIN fourni est trop long.

setRegionCode(regionCode)

Code région CLDR/ISO 3166 du pays associé à ce point d'entrée. Applicable uniquement aux types de points d'entrée par téléphone. Facultatif.

Paramètres

NomTypeDescription
regionCodeStringCode régional à définir.

Renvois

EntryPoint : cet objet, pour le chaînage

Génère

Error : si le code de région fourni est trop long.

setUri(uri)

Définit l'URI permettant de rejoindre la conférence via ce point d'entrée. Pour les points d'entrée PHONE, le préfixe tel: est obligatoire. Pour les points d'entrée SIP, le préfixe sip: est obligatoire. Pour les points d'entrée VIDEO et MORE, les préfixes http: ou https: sont obligatoires. La longueur maximale est de 1 300 caractères. Obligatoire.

Paramètres

NomTypeDescription
uriStringURI à définir.

Renvois

EntryPoint : cet objet, pour le chaînage

Génère

Error : si l'URI fourni n'est pas correctement formaté.