Class EntryPoint

EntryPoint

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:[phone],,,112233445;9687')
        .addFeature(ConferenceDataService.EntryPointFeature.TOLL)
        .setPin('9687');

const sipEntryPoint =
    ConferenceDataService.newEntryPoint()
        .setEntryPointType(ConferenceDataService.EntryPointType.SIP)
        .setUri('sip:[e-mail]')
        .setAccessCode('1234567');

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

Methods

Method	Return type	Brief description
addFeature(feature)	EntryPoint	Adds the feature of the entry point, such as being toll or toll-free.
setAccessCode(accessCode)	EntryPoint	An access code for accessing the conference.
setEntryPointType(entryPointType)	EntryPoint	Sets the type of this entry point.
setMeetingCode(meetingCode)	EntryPoint	A meeting code for accessing the conference.
setPasscode(passcode)	EntryPoint	A passcode for accessing the conference.
setPassword(password)	EntryPoint	A password code for accessing the conference.
setPin(pin)	EntryPoint	A PIN code for accessing the conference.
setRegionCode(regionCode)	EntryPoint	The CLDR/ISO 3166 region code for the country associated with this entry point.
setUri(uri)	EntryPoint	Sets the URI for joining the conference through this entry point.

Detailed documentation

addFeature(feature)

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

Parameters

Name	Type	Description
feature	EntryPointFeature	The feature to set.

Return

EntryPoint — this object, for chaining

Throws

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

---

setAccessCode(accessCode)

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

Parameters

Name	Type	Description
accessCode	String	The access code to set.

Return

EntryPoint — this object, for chaining

Throws

Error — if the provided access code is too long.

---

setEntryPointType(entryPointType)

Sets the type of this entry point. Required.

Parameters

Name	Type	Description
entryPointType	EntryPointType	The entry point type to set.

Return

EntryPoint — this object, for chaining

---

setMeetingCode(meetingCode)

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

Parameters

Name	Type	Description
meetingCode	String	The meeting code to set.

Return

EntryPoint — this object, for chaining

Throws

Error — if the provided meeting code is too long.

---

setPasscode(passcode)

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

Parameters

Name	Type	Description
passcode	String	The passcode to set.

Return

EntryPoint — this object, for chaining

Throws

Error — if the provided passcode is too long.

---

setPassword(password)

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

Parameters

Name	Type	Description
password	String	The password to set.

Return

EntryPoint — this object, for chaining

Throws

Error — if the provided password is too long.

---

setPin(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

EntryPoint — this object, for chaining

Throws

Error — if the provided PIN code is too long.

---

setRegionCode(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
regionCode	String	The regionCode to set.

Return

EntryPoint — this object, for chaining

Throws

Error — if the provided regionCode is too long.

---

setUri(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

EntryPoint — this object, for chaining

Throws

Error — if the provided URI is malformed.