Conference Data Service

Conference Data

This service allows scripts to configure and build conferencing data objects that interact with Google Calendar.

Classes

Name Brief description
ConferenceData Container for all conference-related information.
ConferenceDataBuilder Builder for creating for ConferenceData objects.
ConferenceDataService Service that scripts can use to create conferencing information.
ConferenceError Error that occurred in a conferencing add-on.
ConferenceErrorType Enum that defines the types of errors that you can specify in a ConferenceError .
ConferenceParameter Solution-specific parameter available fo the add-on's use.
EntryPoint Definition of a specific way to join a conference.
EntryPointFeature Enum that defines the features of the entry point that can be created by a conferencing add-on.
EntryPointType Enum that defines the types of entry points that can be created by a conferencing add-on.

ConferenceData

Methods

Method Return type Brief description
printJson()
String Prints the JSON representation of this object.

ConferenceDataBuilder

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.

ConferenceDataService

Properties

Property Type Description
ConferenceErrorType
ConferenceErrorType The ConferenceErrorType enumeration.
EntryPointFeature
EntryPointFeature The EntryPointFeature enumeration.
EntryPointType
EntryPointType The EntryPointType enumeration.

Methods

Method Return type Brief description
newConferenceDataBuilder()
ConferenceDataBuilder Returns a new, empty ConferenceDataBuilder .
newConferenceError()
ConferenceError Returns a new, empty ConferenceError .
newConferenceParameter()
ConferenceParameter Returns a new, empty ConferenceParameter .
newEntryPoint()
EntryPoint Returns a new, empty EntryPoint .

ConferenceError

Methods

Method Return type Brief description
setAuthenticationUrl(authenticationUrl)
ConferenceError If the error type is AUTHENTICATION , the add-on must provide a URL calling back into the add-on to allow users to log in.
setConferenceErrorType(conferenceErrorType)
ConferenceError Sets the error type of this ConferenceError .

ConferenceErrorType

Properties

Property Type Description
AUTHENTICATION
Enum An authentication error during conference data generation.
CONFERENCE_SOLUTION_FORBIDDEN
Enum The user is not allowed to use the selected conference solution (but might be allowed to use other solutions offered by the add-on).
PERMANENT
Enum A permanent error during conference data generation.
PERMISSION_DENIED
Enum The user isn't allowed to perform an action in the third-party conferencing system.
TEMPORARY
Enum A temporary error during conference data generation.
UNKNOWN
Enum An unknown error during conference data generation.

ConferenceParameter

Methods

Method Return type Brief description
setKey(key)
ConferenceParameter Sets the key of this ConferenceParameter .
setValue(value)
ConferenceParameter Sets the value of this ConferenceParameter .

EntryPoint

Methods

Method Return type Brief description
addFeature(feature)
EntryPoint Adds the feature of the entry point, such as being toll or toll-free.
setAccessCode(accessCode)
EntryPoint An access code for accessing the conference.
setEntryPointType(entryPointType)
EntryPoint Sets the type of this entry point.
setMeetingCode(meetingCode)
EntryPoint A meeting code for accessing the conference.
setPasscode(passcode)
EntryPoint A passcode for accessing the conference.
setPassword(password)
EntryPoint A password code for accessing the conference.
setPin(pin)
EntryPoint A PIN code for accessing the conference.
setRegionCode(regionCode)
EntryPoint The CLDR/ISO 3166 region code for the country associated with this entry point.
setUri(uri)
EntryPoint Sets the URI for joining the conference through this entry point.

EntryPointFeature

Properties

Property Type Description
UNKNOWN_FEATURE
Enum Do not use.
TOLL
Enum Applies to PHONE entry point only.
TOLL_FREE
Enum Applies to PHONE entry point only.

EntryPointType

Properties

Property Type Description
VIDEO
Enum A video entry point for a conference.
PHONE
Enum A phone entry point for a conference.
MORE
Enum A link to more information about entry points into a conference.
SIP
Enum A SIP entry point for a conference.