Class ConferenceDataBuilder

    • The ConferenceDataBuilder is used to create ConferenceData objects.

    • Methods are available to add conference parameters and entry points, set conference ID and solution ID, set errors, and add notes.

    • The build() method is used to finalize and validate the ConferenceData object.
    ConferenceDataBuilder

    Builder for creating for ConferenceData objects.

    Methods

    Method Return type Brief description
    add Conference Parameter(conferenceParameter)
    		Conference Data Builder Adds a Conference Parameter to this Conference Data .
    add Entry Point(entryPoint)
    		Conference Data Builder Adds an Entry Point to this Conference Data .
    build()
    		Conference Data Builds and validates the Conference Data .
    set Conference Id(conferenceId)
    		Conference Data Builder Sets the conference ID of this Conference Data .
    set Conference Solution Id(conferenceSolutionId)
    		Conference Data Builder Sets the conference solution ID defined in the addon's manifest.
    set Error(conferenceError)
    		Conference Data Builder Sets the Conference Error of this Conference Data , indicating that the conference was not successfully created.
    set Notes(notes)
    		Conference Data Builder Sets the additional notes of this Conference Data , 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
    conference Parameter
    		Conference Parameter 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
    entry Point
    		Entry Point 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
    conference Id
    		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
    conference Solution Id
    		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
    conference Error
    		Conference Error 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.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: