Class ConferenceDataBuilder

Builder for creating for ConferenceData objects.

Methods

Method	Return type	Brief description
`addConferenceParameter(conferenceParameter)`	`ConferenceDataBuilder`	Adds a `ConferenceParameter` to this `ConferenceData`.
`addEntryPoint(entryPoint)`	`ConferenceDataBuilder`	Adds an `EntryPoint` to this `ConferenceData`.
`build()`	`ConferenceData`	Builds and validates the `ConferenceData`.
`setConferenceId(conferenceId)`	`ConferenceDataBuilder`	Sets the conference ID of this `ConferenceData`.
`setConferenceSolutionId(conferenceSolutionId)`	`ConferenceDataBuilder`	Sets the conference solution ID defined in the addon's manifest.
`setError(conferenceError)`	`ConferenceDataBuilder`	Sets the `ConferenceError` of this `ConferenceData`, indicating that the conference was not successfully created.
`setNotes(notes)`	`ConferenceDataBuilder`	Sets the additional notes of this `ConferenceData`, such as instructions from the administrator or legal notices.

Detailed documentation

`addConferenceParameter(conferenceParameter)`

Adds a ConferenceParameter to this ConferenceData. The maximum number of parameters per ConferenceData is 300.

Parameters

Name	Type	Description
`conferenceParameter`	`ConferenceParameter`	The parameter to add.

Return

ConferenceDataBuilder — 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 EntryPoint to this ConferenceData. The maximum number of entry points per ConferenceData is 300.

Parameters

Name	Type	Description
`entryPoint`	`EntryPoint`	The entry point to add.

Return

ConferenceDataBuilder — 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 ConferenceData.

Return

ConferenceData — the validated conference data

Throws

Error — if the constructed conference data is not valid.

`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)`

Sets the ConferenceError of this ConferenceData, indicating that the conference was not successfully created.

Parameters

Name	Type	Description
`conferenceError`	`ConferenceError`	The error to set.

Return

ConferenceDataBuilder — This builder, for chaining.

Throws

Error — if the provided error is invalid.

`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.