Class ConferenceDataBuilder

Conference Data Builder

Builder for creating for Conference Data objects.

Methods

Method Return type Brief description
Conference Data Builder Adds a Conference Parameter to this Conference Data .
Conference Data Builder Adds an Entry Point to this Conference Data .
Conference Data Builds and validates the Conference Data .
Conference Data Builder Sets the conference ID of this Conference Data .
Conference Data Builder Sets the conference solution ID defined in the addon's manifest.
Conference Data Builder Sets the Conference Error of this Conference Data , indicating that the conference was not successfully created.
Conference Data Builder Sets the additional notes of this Conference Data , such as instructions from the administrator or legal notices.

Detailed documentation

add Conference Parameter(conferenceParameter)

Adds a Conference Parameter to this Conference Data . The maximum number of parameters per Conference Data is 300.

Parameters

Name Type Description
conference Parameter
Conference Parameter The parameter to add.

Return

Conference Data Builder — This builder, for chaining.

Throws

Error — if the provided conference parameter is invalid or if too many conference parameters were added.


add Entry Point(entryPoint)

Adds an Entry Point to this Conference Data . The maximum number of entry points per Conference Data is 300.

Parameters

Name Type Description
entry Point
Entry Point The entry point to add.

Return

Conference Data Builder — 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 Data .

Return

Conference Data — the validated conference data

Throws

Error — if the constructed conference data is not valid.


set Conference Id(conferenceId)

Sets the conference ID of this Conference Data . The maximum length for this field is 512 characters.

Parameters

Name Type Description
conference Id
String The ID to set.

Return

Conference Data Builder — This builder, for chaining.

Throws

Error — if the provided conference ID is too long.


set Conference Solution Id(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 Solution Id
String The ID matching the manifest.

Return

Conference Data Builder — This builder, for chaining.

Throws

Error — if the provided conference solution id is too long. The maximum length for this field is 512 characters.


set Error(conferenceError)

Sets the Conference Error of this Conference Data , indicating that the conference was not successfully created.

Parameters

Name Type Description
conference Error
Conference Error The error to set.

Return

Conference Data Builder — This builder, for chaining.

Throws

Error — if the provided error is invalid.


set Notes(notes)

Sets the additional notes of this Conference Data , 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 Data Builder — This builder, for chaining.

Throws

Error — if the provided notes are too long.

Create a Mobile Website
View Site in Mobile | Classic
Share by: