Class EntryPoint

EntryPoint

Définition d'une manière spécifique de participer à une conférence. Exemples d'utilisation :

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

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

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

var 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'entrée (par exemple, numéro vert ou vert).
setAccessCode(accessCode)EntryPointCode d'accès permettant d'accéder à la conférence.
setEntryPointType(entryPointType)EntryPointDéfinit le type de ce point d'entrée.
setMeetingCode(meetingCode)EntryPointUn code de réunion permettant d'accéder à la conférence.
setPasscode(passcode)EntryPointUn code secret permettant d'accéder à la conférence.
setPassword(password)EntryPointCode de mot de passe permettant d'accéder à la conférence.
setPin(pin)EntryPointCode d'accès à la conférence
setRegionCode(regionCode)EntryPointCode de 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'entrée (par exemple, numéro vert ou vert).

Paramètres

NomTypeDescription
featureEntryPointFeatureFonctionnalité à définir.

Renvois

EntryPoint : cet objet, pour le chaînage

Génère

Error : si la fonctionnalité ne s'applique pas à ce point d'entrée.


setAccessCode(accessCode)

Code d'accès permettant d'accéder à la conférence. Ne doit pas dépasser 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)

Un code de réunion permettant d'accéder à la conférence. Ne doit pas dépasser 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 permettant d'accéder à la conférence. Ne doit pas dépasser 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. Ne doit pas dépasser 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)

Code d'accès à la conférence Ne doit pas dépasser 128 caractères. Facultatif.

Paramètres

NomTypeDescription
pinStringCode à 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 de région CLDR/ISO 3166 du pays associé à ce point d'entrée. Applicable uniquement aux types de points d'entrée du téléphone. Facultatif.

Paramètres

NomTypeDescription
regionCodeStringLa valeur regionCode à définir.

Renvois

EntryPoint : cet objet, pour le chaînage

Génère

Error : si le regionCode 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. Ne doit pas dépasser 1 300 caractères. Obligatoire.

Paramètres

NomTypeDescription
uriStringURI à définir.

Renvois

EntryPoint : cet objet, pour le chaînage

Génère

Error : si le format de l'URI fourni est incorrect.