Builder for creating for Conference objects.
Methods
| Method | Return type | Brief description |
|---|---|---|
add | Conference | Adds a Conference to this Conference. |
add | Conference | Adds an Entry to this Conference. |
build() | Conference | Builds and validates the Conference. |
set | Conference | Sets the conference ID of this Conference. |
set | Conference | Sets the conference solution ID defined in the addon's manifest. |
set | Conference | Sets the Conference of this Conference, indicating that the conference was not successfully created. |
set | Conference | Sets the additional notes of this Conference, such as instructions from the administrator or legal notices. |
Detailed documentation
addConferenceParameter(conferenceParameter)
Adds a Conference to this Conference. The maximum number of parameters per Conference is 300.
Parameters
| Name | Type | Description |
|---|---|---|
conference | Conference | The parameter to add. |
Return
Conference — This builder, for chaining.
Throws
Error — if the provided conference parameter is invalid or if too many conference parameters were added.
addEntryPoint(entryPoint)
Adds an Entry to this Conference. The maximum number of entry points per Conference is 300.
Parameters
| Name | Type | Description |
|---|---|---|
entry | Entry | The entry point to add. |
Return
Conference — This builder, for chaining.
Throws
Error — if the provided entry point is invalid or if too many entry points were added.
build()
Builds and validates the Conference.
Return
Conference — the validated conference data
Throws
Error — if the constructed conference data is not valid.
setConferenceId(conferenceId)
Sets the conference ID of this Conference. The maximum length for this field is 512 characters.
Parameters
| Name | Type | Description |
|---|---|---|
conference | String | The ID to set. |
Return
Conference — 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 |
|---|---|---|
conference | String | The ID matching the manifest. |
Return
Conference — 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)
Sets the Conference of this Conference, indicating that the conference was not successfully created.
Parameters
| Name | Type | Description |
|---|---|---|
conference | Conference | The error to set. |
Return
Conference — This builder, for chaining.
Throws
Error — if the provided error is invalid.
setNotes(notes)
Sets the additional notes of this Conference, 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
Conference — This builder, for chaining.
Throws
Error — if the provided notes are too long.