Google is committed to advancing racial equity for Black communities. See how.

Conference Data Service

Conference Data

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

Classes

NameBrief description
ConferenceDataContainer for all conference-related information.
ConferenceDataBuilderBuilder for creating for ConferenceData objects.
ConferenceDataServiceService that scripts can use to create conferencing information.
ConferenceErrorError that occurred in a conferencing add-on.
ConferenceErrorTypeEnum that defines the types of errors that you can specify in a ConferenceError.
ConferenceParameterSolution-specific parameter available fo the add-on's use.
EntryPointDefinition of a specific way to join a conference.
EntryPointFeatureEnum that defines the features of the entry point that can be created by a conferencing add-on.
EntryPointTypeEnum that defines the types of entry points that can be created by a conferencing add-on.

ConferenceData

Methods

MethodReturn typeBrief description
printJson()StringPrints the JSON representation of this object.

ConferenceDataBuilder

Methods

MethodReturn typeBrief description
addConferenceParameter(conferenceParameter)ConferenceDataBuilderAdds a ConferenceParameter to this ConferenceData.
addEntryPoint(entryPoint)ConferenceDataBuilderAdds an EntryPoint to this ConferenceData.
build()ConferenceDataBuilds and validates the ConferenceData.
setConferenceId(conferenceId)ConferenceDataBuilderSets the conference ID of this ConferenceData.
setConferenceSolutionId(conferenceSolutionId)ConferenceDataBuilderSets the conference solution ID defined in the addon's manifest.
setError(conferenceError)ConferenceDataBuilderSets the ConferenceError of this ConferenceData, indicating that the conference was not successfully created.
setNotes(notes)ConferenceDataBuilderSets the additional notes of this ConferenceData, such as instructions from the administrator or legal notices.

ConferenceDataService

Properties

PropertyTypeDescription
ConferenceErrorTypeConferenceErrorTypeThe ConferenceErrorType enumeration.
EntryPointFeatureEntryPointFeatureThe EntryPointFeature enumeration.
EntryPointTypeEntryPointTypeThe EntryPointType enumeration.

Methods

MethodReturn typeBrief description
newConferenceDataBuilder()ConferenceDataBuilderReturns a new, empty ConferenceDataBuilder.
newConferenceError()ConferenceErrorReturns a new, empty ConferenceError.
newConferenceParameter()ConferenceParameterReturns a new, empty ConferenceParameter.
newEntryPoint()EntryPointReturns a new, empty EntryPoint.

ConferenceError

Methods

MethodReturn typeBrief description
setAuthenticationUrl(authenticationUrl)ConferenceErrorIf 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)ConferenceErrorSets the error type of this ConferenceError.

ConferenceErrorType

Properties

PropertyTypeDescription
AUTHENTICATIONEnumAn authentication error during conference data generation.
CONFERENCE_SOLUTION_FORBIDDENEnumThe user is not allowed to use the selected conference solution (but might be allowed to use other solutions offered by the add-on).
PERMANENTEnumA permanent error during conference data generation.
PERMISSION_DENIEDEnumThe user isn't allowed to perform an action in the third-party conferencing system.
TEMPORARYEnumA temporary error during conference data generation.
UNKNOWNEnumAn unknown error during conference data generation.

ConferenceParameter

Methods

MethodReturn typeBrief description
setKey(key)ConferenceParameterSets the key of this ConferenceParameter.
setValue(value)ConferenceParameterSets the value of this ConferenceParameter.

EntryPoint

Methods

MethodReturn typeBrief description
addFeature(feature)EntryPointAdds the feature of the entry point, such as being toll or toll-free.
setAccessCode(accessCode)EntryPointAn access code for accessing the conference.
setEntryPointType(entryPointType)EntryPointSets the type of this entry point.
setMeetingCode(meetingCode)EntryPointA meeting code for accessing the conference.
setPasscode(passcode)EntryPointA passcode for accessing the conference.
setPassword(password)EntryPointA password code for accessing the conference.
setPin(pin)EntryPointA PIN code for accessing the conference.
setRegionCode(regionCode)EntryPointThe CLDR/ISO 3166 region code for the country associated with this entry point.
setUri(uri)EntryPointSets the URI for joining the conference through this entry point.

EntryPointFeature

Properties

PropertyTypeDescription
UNKNOWN_FEATUREEnumDo not use.
TOLLEnumApplies to PHONE entry point only.
TOLL_FREEEnumApplies to PHONE entry point only.

EntryPointType

Properties

PropertyTypeDescription
VIDEOEnumA video entry point for a conference.
PHONEEnumA phone entry point for a conference.
MOREEnumA link to more information about entry points into a conference.
SIPEnumA SIP entry point for a conference.