Class EntryPoint
Stay organized with collections
Save and categorize content based on your preferences.
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:+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');
Detailed documentation
addFeature(feature)
Adds the feature of the entry point, such as being toll or toll-free.
Parameters
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-03 UTC.
[null,null,["Last updated 2024-12-03 UTC."],[[["\u003cp\u003e\u003ccode\u003eEntryPoint\u003c/code\u003e objects define specific ways to join a conference, such as by video, phone, or SIP.\u003c/p\u003e\n"],["\u003cp\u003eYou can set the entry point type, URI, and optional access codes using dedicated methods like \u003ccode\u003esetEntryPointType()\u003c/code\u003e, \u003ccode\u003esetUri()\u003c/code\u003e, and \u003ccode\u003esetPasscode()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eEach \u003ccode\u003eEntryPoint\u003c/code\u003e method returns the \u003ccode\u003eEntryPoint\u003c/code\u003e object itself, allowing for method chaining for convenient setup.\u003c/p\u003e\n"],["\u003cp\u003eParameters like access codes, meeting codes, and passwords have a maximum length of 128 characters, while URIs have a maximum length of 1300 characters.\u003c/p\u003e\n"],["\u003cp\u003eFor phone, SIP, video, and "more" entry points, the URI must start with the appropriate prefix (\u003ccode\u003etel:\u003c/code\u003e, \u003ccode\u003esip:\u003c/code\u003e, \u003ccode\u003ehttp:\u003c/code\u003e, or \u003ccode\u003ehttps:\u003c/code\u003e).\u003c/p\u003e\n"]]],[],null,["# Class EntryPoint\n\nEntryPoint\n\nDefinition of a specific way to join a conference. Example usage:\n\n```javascript\nconst videoEntryPoint =\n ConferenceDataService.newEntryPoint()\n .setEntryPointType(ConferenceDataService.EntryPointType.VIDEO)\n .setUri('https://example.com/myroom')\n .setPasscode('12345');\n\nconst phoneEntryPoint =\n ConferenceDataService.newEntryPoint()\n .setEntryPointType(ConferenceDataService.EntryPointType.PHONE)\n .setUri('tel:+11234567890,,,112233445;9687')\n .addFeature(ConferenceDataService.EntryPointFeature.TOLL)\n .setPin('9687');\n\nconst sipEntryPoint =\n ConferenceDataService.newEntryPoint()\n .setEntryPointType(ConferenceDataService.EntryPointType.SIP)\n .setUri('sip:joe@example.com')\n .setAccessCode('1234567');\n\nconst moreEntryPoint =\n ConferenceDataService.newEntryPoint()\n .setEntryPointType(ConferenceDataService.EntryPointType.MORE)\n .setUri('https://example.com/moreJoiningInfo');\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------------------------------------|-----------------|---------------------------------------------------------------------------------|\n| [addFeature(feature)](#addFeature(EntryPointFeature)) | [EntryPoint](#) | Adds the feature of the entry point, such as being toll or toll-free. |\n| [setAccessCode(accessCode)](#setAccessCode(String)) | [EntryPoint](#) | An access code for accessing the conference. |\n| [setEntryPointType(entryPointType)](#setEntryPointType(EntryPointType)) | [EntryPoint](#) | Sets the type of this entry point. |\n| [setMeetingCode(meetingCode)](#setMeetingCode(String)) | [EntryPoint](#) | A meeting code for accessing the conference. |\n| [setPasscode(passcode)](#setPasscode(String)) | [EntryPoint](#) | A passcode for accessing the conference. |\n| [setPassword(password)](#setPassword(String)) | [EntryPoint](#) | A password code for accessing the conference. |\n| [setPin(pin)](#setPin(String)) | [EntryPoint](#) | A PIN code for accessing the conference. |\n| [setRegionCode(regionCode)](#setRegionCode(String)) | [EntryPoint](#) | The CLDR/ISO 3166 region code for the country associated with this entry point. |\n| [setUri(uri)](#setUri(String)) | [EntryPoint](#) | Sets the URI for joining the conference through this entry point. |\n\nDetailed documentation\n----------------------\n\n### `add``Feature(feature)`\n\nAdds the feature of the entry point, such as being toll or toll-free.\n\n#### Parameters\n\n| Name | Type | Description |\n|-----------|---------------------------------------------------------------------------------|---------------------|\n| `feature` | [EntryPointFeature](/apps-script/reference/conference-data/entry-point-feature) | The feature to set. |\n\n#### Return\n\n\n[EntryPoint](#) --- this object, for chaining\n\n#### Throws\n\n\n[`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) --- if the feature isn't applicable to this entry point.\n\n*** ** * ** ***\n\n### `set``Access``Code(accessCode)`\n\nAn access code for accessing the conference. Maximum length 128 characters. Optional.\n\n#### Parameters\n\n| Name | Type | Description |\n|----------------|----------|-------------------------|\n| `access``Code` | `String` | The access code to set. |\n\n#### Return\n\n\n[EntryPoint](#) --- this object, for chaining\n\n#### Throws\n\n\n[`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) --- if the provided access code is too long.\n\n*** ** * ** ***\n\n### `set``Entry``Point``Type(entryPointType)`\n\nSets the type of this entry point. Required.\n\n#### Parameters\n\n| Name | Type | Description |\n|----------------------|---------------------------------------------------------------------------|------------------------------|\n| `entry``Point``Type` | [EntryPointType](/apps-script/reference/conference-data/entry-point-type) | The entry point type to set. |\n\n#### Return\n\n\n[EntryPoint](#) --- this object, for chaining\n\n*** ** * ** ***\n\n### `set``Meeting``Code(meetingCode)`\n\nA meeting code for accessing the conference. Maximum length 128 characters. Optional.\n\n#### Parameters\n\n| Name | Type | Description |\n|-----------------|----------|--------------------------|\n| `meeting``Code` | `String` | The meeting code to set. |\n\n#### Return\n\n\n[EntryPoint](#) --- this object, for chaining\n\n#### Throws\n\n\n[`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) --- if the provided meeting code is too long.\n\n*** ** * ** ***\n\n### `set``Passcode(passcode)`\n\nA passcode for accessing the conference. Maximum length 128 characters. Optional.\n\n#### Parameters\n\n| Name | Type | Description |\n|------------|----------|----------------------|\n| `passcode` | `String` | The passcode to set. |\n\n#### Return\n\n\n[EntryPoint](#) --- this object, for chaining\n\n#### Throws\n\n\n[`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) --- if the provided passcode is too long.\n\n*** ** * ** ***\n\n### `set``Password(password)`\n\nA password code for accessing the conference. Maximum length 128 characters. Optional.\n\n#### Parameters\n\n| Name | Type | Description |\n|------------|----------|----------------------|\n| `password` | `String` | The password to set. |\n\n#### Return\n\n\n[EntryPoint](#) --- this object, for chaining\n\n#### Throws\n\n\n[`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) --- if the provided password is too long.\n\n*** ** * ** ***\n\n### `set``Pin(pin)`\n\nA PIN code for accessing the conference. Maximum length 128 characters. Optional.\n\n#### Parameters\n\n| Name | Type | Description |\n|-------|----------|----------------------|\n| `pin` | `String` | The PIN code to set. |\n\n#### Return\n\n\n[EntryPoint](#) --- this object, for chaining\n\n#### Throws\n\n\n[`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) --- if the provided PIN code is too long.\n\n*** ** * ** ***\n\n### `set``Region``Code(regionCode)`\n\nThe CLDR/ISO 3166 region code for the country associated with this entry point. Applicable only\nto phone entry point types. Optional.\n\n#### Parameters\n\n| Name | Type | Description |\n|----------------|----------|------------------------|\n| `region``Code` | `String` | The regionCode to set. |\n\n#### Return\n\n\n[EntryPoint](#) --- this object, for chaining\n\n#### Throws\n\n\n[`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) --- if the provided regionCode is too long.\n\n*** ** * ** ***\n\n### `set``Uri(uri)`\n\nSets the URI for joining the conference through this entry point. For [PHONE](/apps-script/reference/conference-data/entry-point-type#PHONE) entry points, the prefix `tel:` is required. For [SIP](/apps-script/reference/conference-data/entry-point-type#SIP) entry points, the prefix `sip:` is required. For [VIDEO](/apps-script/reference/conference-data/entry-point-type#VIDEO) and [MORE](/apps-script/reference/conference-data/entry-point-type#MORE) entry points, the prefixes\n`http:` or `https:` are required. Maximum length 1300 characters. Required.\n\n#### Parameters\n\n| Name | Type | Description |\n|-------|----------|-----------------|\n| `uri` | `String` | The URI to set. |\n\n#### Return\n\n\n[EntryPoint](#) --- this object, for chaining\n\n#### Throws\n\n\n[`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) --- if the provided URI is malformed."]]
