Class EntryPoint

Entry Point

Definition of a specific way to join a conference. Example usage:

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

Methods

Method Return type Brief description
Entry Point Adds the feature of the entry point, such as being toll or toll-free.
Entry Point An access code for accessing the conference.
Entry Point Sets the type of this entry point.
Entry Point A meeting code for accessing the conference.
Entry Point A passcode for accessing the conference.
Entry Point A password code for accessing the conference.
Entry Point A PIN code for accessing the conference.
Entry Point The CLDR/ISO 3166 region code for the country associated with this entry point.
Entry Point Sets the URI for joining the conference through this entry point.

Detailed documentation

add Feature(feature)

Adds the feature of the entry point, such as being toll or toll-free.

Parameters

Name Type Description
feature
Entry Point Feature The feature to set.

Return

Entry Point — this object, for chaining

Throws

Error — if the feature isn't applicable to this entry point.


set Access Code(accessCode)

An access code for accessing the conference. Maximum length 128 characters. Optional.

Parameters

Name Type Description
access Code
String The access code to set.

Return

Entry Point — this object, for chaining

Throws

Error — if the provided access code is too long.


set Entry Point Type(entryPointType)

Sets the type of this entry point. Required.

Parameters

Name Type Description
entry Point Type
Entry Point Type The entry point type to set.

Return

Entry Point — this object, for chaining


set Meeting Code(meetingCode)

A meeting code for accessing the conference. Maximum length 128 characters. Optional.

Parameters

Name Type Description
meeting Code
String The meeting code to set.

Return

Entry Point — this object, for chaining

Throws

Error — if the provided meeting code is too long.


set Passcode(passcode)

A passcode for accessing the conference. Maximum length 128 characters. Optional.

Parameters

Name Type Description
passcode
String The passcode to set.

Return

Entry Point — this object, for chaining

Throws

Error — if the provided passcode is too long.


set Password(password)

A password code for accessing the conference. Maximum length 128 characters. Optional.

Parameters

Name Type Description
password
String The password to set.

Return

Entry Point — this object, for chaining

Throws

Error — if the provided password is too long.


set Pin(pin)

A PIN code for accessing the conference. Maximum length 128 characters. Optional.

Parameters

Name Type Description
pin
String The PIN code to set.

Return

Entry Point — this object, for chaining

Throws

Error — if the provided PIN code is too long.


set Region Code(regionCode)

The CLDR/ISO 3166 region code for the country associated with this entry point. Applicable only to phone entry point types. Optional.

Parameters

Name Type Description
region Code
String The regionCode to set.

Return

Entry Point — this object, for chaining

Throws

Error — if the provided regionCode is too long.


set Uri(uri)

Sets the URI for joining the conference through this entry point. For PHONE entry points, the prefix tel: is required. For SIP entry points, the prefix sip: is required. For VIDEO and MORE entry points, the prefixes http: or https: are required. Maximum length 1300 characters. Required.

Parameters

Name Type Description
uri
String The URI to set.

Return

Entry Point — this object, for chaining

Throws

Error — if the provided URI is malformed.

Create a Mobile Website
View Site in Mobile | Classic
Share by: