Package calendar

Index

ConferenceDataMarkup

Fields
conference_id

string

Unique identifier for this conference data. Maximum 512 characters long.

entry_point[]

EntryPointMarkup

Entry points to the conference. Maximum 300 entry points are allowed.

parameter[]

Parameter

Additional add-on parameters. Maximum 300 parameters are allowed.

error

Error

If set, it means an error occurred during conference creation.

notes

string

Additional notes (such as instructions from the administrator, legal notices) to display to the user. Can contain HTML. Max length 2048 characters.

conference_solution_id

string

An identifier of conferencing solution. Must match any value from addon's manifest, calendar/conferenceSolution/id field.

EntryPointMarkup

A way to join the conference.

Fields
type

Type

The type of the entry point. Required.

uri

string

A URI for joining the conference. Supports tel: and http(s): and should be at most 1300 characters long. Required.

label

string

The label of the entry point to display to the user. Maximum 512 characters long.

meeting_code

string

A meeting code for accessing the conference. Maximum 128 characters long.

access_code

string

An access code for accessing the conference. Maximum 128 characters long.

passcode

string

A passcode for accessing the conference. Maximum 128 characters long.

password

string

A password for accessing the conference. Maximum 128 characters long.

pin

string

A PIN for accessing the conference. Maximum 128 characters long.

region_code

string

The CLDR/ISO 3166 region code for the country associated with this entry point. Applicable only to Type.PHONE.

feature[]

Feature

Features of the entry point, such as being toll or toll-free. One entry point can have multiple features.

Feature

Features of the entry point. Some features might apply only to specifc entry points.

Enums
UNKNOWN_FEATURE Do not use! Here only as a default value for proto compatibility reasons.
TOLL Applies to PHONE entry point only. A call to a toll number is charged to the calling party. A number can't be toll and toll-free at the same time.
TOLL_FREE Applies to PHONE entry point only. For the calling party, a call to a toll-free number is free of charge. A number can't be toll and toll-free at the same time.

Type

The type of the entry point.

Enums
UNKNOWN
VIDEO
PHONE
MORE Used to provide a link to further conference joining information.
SIP

Error

Represents an error that occurred during conference creation.

Fields
type

Type

The type of error. Required.

authentication_url

string

If the error type is AUTHENTICATION, the add-on can provide a URL allowing users to log in. Maximum 1300 characters long.

Type

LINT.IfChange

Enums
UNKNOWN
AUTHENTICATION
TEMPORARY
PERMANENT
PERMISSION_DENIED The user isn't allowed to perform some action in the third-party conferencing system.
CONFERENCE_SOLUTION_FORBIDDEN The user is not allowed to use the selected conference solution (but might be allowed to use other solutions offered by the add-on).

Parameter

Solution-specific parameters that will be persisted with the event data and, if an update or delete is needed, will be passed to the add-on. For example: [{key: 'sessionKey', value: '123'}, {key: 'meetingId', value: '456'}]

Fields
key

string

The key of the parameter. Maximum 50 characters long. Required.

value

string

The value of the parameter. Maximum 1024 characters long. Required.