Class ConferenceDataBuilder
Stay organized with collections
Save and categorize content based on your preferences.
ConferenceDataBuilder
Builder for creating for ConferenceData objects.
Detailed documentation
addConferenceParameter(conferenceParameter)
addEntryPoint(entryPoint)
setConferenceId(conferenceId)
Sets the conference ID of this ConferenceData. The maximum length for this field is 512
characters.
Parameters
| Name | Type | Description |
conferenceId | String | The ID to set. |
Return
ConferenceDataBuilder — This builder, for chaining.
Throws
Error — if the provided conference ID is too long.
setConferenceSolutionId(conferenceSolutionId)
Sets the conference solution ID defined in the addon's manifest. The value must be specified
and populates conference's name and iconUrl values.
Note that the field is required for GSuite add-ons whereas it's ignored for Conferencing
add-ons
Parameters
| Name | Type | Description |
conferenceSolutionId | String | The ID matching the manifest. |
Return
ConferenceDataBuilder — This builder, for chaining.
Throws
Error — if the provided conference solution id is too long. The maximum
length for this field is 512 characters.
setError(conferenceError)
setNotes(notes)
Sets the additional notes of this ConferenceData, such as instructions from the
administrator or legal notices. Can contain HTML. The maximum length for this field is 2048
characters.
Parameters
| Name | Type | Description |
notes | String | The additional notes to set. |
Return
ConferenceDataBuilder — This builder, for chaining.
Throws
Error — if the provided notes are too long.
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-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\u003cp\u003e\u003ccode\u003eConferenceDataBuilder\u003c/code\u003e facilitates the creation of \u003ccode\u003eConferenceData\u003c/code\u003e objects, defining conference details for applications.\u003c/p\u003e\n"],["\u003cp\u003eIt offers methods to add conference parameters and entry points, set conference IDs and notes, and specify errors.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use the \u003ccode\u003ebuild()\u003c/code\u003e method to generate and validate the final \u003ccode\u003eConferenceData\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eThere are limitations on the number of parameters and entry points, as well as the length of certain fields like conference ID and notes.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eConferenceDataBuilder\u003c/code\u003e is essential for integrating conferencing functionality within Google Apps Script projects.\u003c/p\u003e\n"]]],[],null,["# Class ConferenceDataBuilder\n\nConferenceDataBuilder\n\nBuilder for creating for [ConferenceData](/apps-script/reference/conference-data/conference-data) objects. \n\n### Methods\n\n| Method | Return type | Brief description |\n|---------------------------------------------------------------------------------------------|--------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [addConferenceParameter(conferenceParameter)](#addConferenceParameter(ConferenceParameter)) | [ConferenceDataBuilder](#) | Adds a [ConferenceParameter](/apps-script/reference/conference-data/conference-parameter) to this [ConferenceData](/apps-script/reference/conference-data/conference-data). |\n| [addEntryPoint(entryPoint)](#addEntryPoint(EntryPoint)) | [ConferenceDataBuilder](#) | Adds an [EntryPoint](/apps-script/reference/conference-data/entry-point) to this [ConferenceData](/apps-script/reference/conference-data/conference-data). |\n| [build()](#build()) | [ConferenceData](/apps-script/reference/conference-data/conference-data) | Builds and validates the [ConferenceData](/apps-script/reference/conference-data/conference-data). |\n| [setConferenceId(conferenceId)](#setConferenceId(String)) | [ConferenceDataBuilder](#) | Sets the conference ID of this [ConferenceData](/apps-script/reference/conference-data/conference-data). |\n| [setConferenceSolutionId(conferenceSolutionId)](#setConferenceSolutionId(String)) | [ConferenceDataBuilder](#) | Sets the conference solution ID defined in the addon's manifest. |\n| [setError(conferenceError)](#setError(ConferenceError)) | [ConferenceDataBuilder](#) | Sets the [ConferenceError](/apps-script/reference/conference-data/conference-error) of this [ConferenceData](/apps-script/reference/conference-data/conference-data), indicating that the conference was not successfully created. |\n| [setNotes(notes)](#setNotes(String)) | [ConferenceDataBuilder](#) | Sets the additional notes of this [ConferenceData](/apps-script/reference/conference-data/conference-data), such as instructions from the administrator or legal notices. |\n\nDetailed documentation\n----------------------\n\n### `add``Conference``Parameter(conferenceParameter)`\n\nAdds a [ConferenceParameter](/apps-script/reference/conference-data/conference-parameter) to this [ConferenceData](/apps-script/reference/conference-data/conference-data). The maximum number of\nparameters per [ConferenceData](/apps-script/reference/conference-data/conference-data) is 300.\n\n#### Parameters\n\n| Name | Type | Description |\n|-------------------------|------------------------------------------------------------------------------------|-----------------------|\n| `conference``Parameter` | [ConferenceParameter](/apps-script/reference/conference-data/conference-parameter) | The parameter to add. |\n\n#### Return\n\n\n[ConferenceDataBuilder](#) --- This builder, 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 conference parameter is invalid or if too many\nconference parameters were added.\n\n*** ** * ** ***\n\n### `add``Entry``Point(entryPoint)`\n\nAdds an [EntryPoint](/apps-script/reference/conference-data/entry-point) to this [ConferenceData](/apps-script/reference/conference-data/conference-data). The maximum number of entry points\nper [ConferenceData](/apps-script/reference/conference-data/conference-data) is 300.\n\n#### Parameters\n\n| Name | Type | Description |\n|----------------|------------------------------------------------------------------|-------------------------|\n| `entry``Point` | [EntryPoint](/apps-script/reference/conference-data/entry-point) | The entry point to add. |\n\n#### Return\n\n\n[ConferenceDataBuilder](#) --- This builder, 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 entry point is invalid or if too many entry\npoints were added.\n\n*** ** * ** ***\n\n### `build()`\n\nBuilds and validates the [ConferenceData](/apps-script/reference/conference-data/conference-data).\n\n#### Return\n\n\n[ConferenceData](/apps-script/reference/conference-data/conference-data) --- the validated conference data\n\n#### Throws\n\n\n[`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) --- if the constructed conference data is not valid.\n\n*** ** * ** ***\n\n### `set``Conference``Id(conferenceId)`\n\nSets the conference ID of this [ConferenceData](/apps-script/reference/conference-data/conference-data). The maximum length for this field is 512\ncharacters.\n\n#### Parameters\n\n| Name | Type | Description |\n|------------------|----------|----------------|\n| `conference``Id` | `String` | The ID to set. |\n\n#### Return\n\n\n[ConferenceDataBuilder](#) --- This builder, 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 conference ID is too long.\n\n*** ** * ** ***\n\n### `set``Conference``Solution``Id(conferenceSolutionId)`\n\nSets the conference solution ID defined in the addon's manifest. The value must be specified\nand populates conference's name and iconUrl values.\n\nNote that the field is required for GSuite add-ons whereas it's ignored for Conferencing\nadd-ons\n\n#### Parameters\n\n| Name | Type | Description |\n|----------------------------|----------|-------------------------------|\n| `conference``Solution``Id` | `String` | The ID matching the manifest. |\n\n#### Return\n\n\n[ConferenceDataBuilder](#) --- This builder, 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 conference solution id is too long. The maximum\nlength for this field is 512 characters.\n\n*** ** * ** ***\n\n### `set``Error(conferenceError)`\n\nSets the [ConferenceError](/apps-script/reference/conference-data/conference-error) of this [ConferenceData](/apps-script/reference/conference-data/conference-data), indicating that the conference\nwas not successfully created.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------------------|----------------------------------------------------------------------------|-------------------|\n| `conference``Error` | [ConferenceError](/apps-script/reference/conference-data/conference-error) | The error to set. |\n\n#### Return\n\n\n[ConferenceDataBuilder](#) --- This builder, 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 error is invalid.\n\n*** ** * ** ***\n\n### `set``Notes(notes)`\n\nSets the additional notes of this [ConferenceData](/apps-script/reference/conference-data/conference-data), such as instructions from the\nadministrator or legal notices. Can contain HTML. The maximum length for this field is 2048\ncharacters.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|----------|------------------------------|\n| `notes` | `String` | The additional notes to set. |\n\n#### Return\n\n\n[ConferenceDataBuilder](#) --- This builder, 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 notes are too long."]]
