Conference
- class gcsa.conference.ConferenceSolution(entry_points, solution_type=None, name=None, icon_uri=None, conference_id=None, signature=None, notes=None)
Information about the conference solution, such as Hangouts or Google Meet.
- Parameters:
entry_points (EntryPoint | List[EntryPoint]) –
EntryPoint
or list ofEntryPoint
s. Information about individual conference entry points, such as URLs or phone numbers. All of them must belong to the same conference.solution_type (str) –
Solution type. See
SolutionType
The possible values are:
HANGOUT - for Hangouts for consumers (hangouts.google.com)
NAMED_HANGOUT - for classic Hangouts for Google Workspace users (hangouts.google.com)
HANGOUTS_MEET - for Google Meet (meet.google.com)
ADD_ON - for 3P conference providers
name (str) – The user-visible name of this solution. Not localized.
icon_uri (str) – The user-visible icon for this solution.
conference_id (str) –
The ID of the conference. Optional. Can be used by developers to keep track of conferences, should not be displayed to users.
Values for solution types (see
SolutionType
):HANGOUT: unset
NAMED_HANGOUT: the name of the Hangout
HANGOUTS_MEET: the 10-letter meeting code, for example “aaa-bbbb-ccc”
ADD_ON: defined by 3P conference provider
signature (str) – The signature of the conference data. Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. None for a conference with a failed create request. Optional for a conference with a pending create request.
notes (str) – String of additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters
- class gcsa.conference.EntryPoint(entry_point_type, uri=None, label=None, pin=None, access_code=None, meeting_code=None, passcode=None, password=None)
Information about individual conference entry points, such as URLs or phone numbers.
When creating new conference data, populate only the subset of meeting_code, access_code, passcode, password, and pin fields that match the terminology that the conference provider uses.
Only the populated fields should be displayed.
- Parameters:
entry_point_type (str) –
The type of the conference entry point.
Possible values are:
VIDEO - joining a conference over HTTP. A conference can have zero or one VIDEO entry point.
PHONE - joining a conference by dialing a phone number. A conference can have zero or more PHONE entry points.
SIP - joining a conference over SIP. A conference can have zero or one SIP entry point.
MORE - further conference joining instructions, for example additional phone numbers. A conference can have zero or one MORE entry point. A conference with only a MORE entry point is not a valid conference.
uri (str) –
The URI of the entry point. The maximum length is 1300 characters. Format:
for VIDEO, http: or https: schema is required.
for PHONE, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
for SIP, sip: schema is required, e.g., sip:12345678@myprovider.com.
for MORE, http: or https: schema is required.
label (str) –
The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.
Examples:
for VIDEO: meet.google.com/aaa-bbbb-ccc
for PHONE: +1 123 268 2601
for SIP: 12345678@altostrat.com
for MORE: should not be filled
pin (str) – The PIN to access the conference. The maximum length is 128 characters.
access_code (str) – The access code to access the conference. The maximum length is 128 characters. Optional.
meeting_code (str) – The meeting code to access the conference. The maximum length is 128 characters.
passcode (str) – The passcode to access the conference. The maximum length is 128 characters.
password (str) – The password to access the conference. The maximum length is 128 characters.
- VIDEO = 'video'
- PHONE = 'phone'
- SIP = 'sip'
- MORE = 'more'
- ENTRY_POINT_TYPES = ('video', 'phone', 'sip', 'more')
- class gcsa.conference.ConferenceSolutionCreateRequest(solution_type=None, request_id=None, _status=None, conference_id=None, signature=None, notes=None)
A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field.
- Parameters:
solution_type (str) –
Solution type. See
SolutionType
The possible values are:
HANGOUT - for Hangouts for consumers (hangouts.google.com)
NAMED_HANGOUT - for classic Hangouts for Google Workspace users (hangouts.google.com)
HANGOUTS_MEET - for Google Meet (meet.google.com)
ADD_ON - for 3P conference providers
request_id (str) – The client-generated unique ID for this request. By default it is generated as UUID. If you specify request_id manually, they should be unique for every new CreateRequest, otherwise request will be ignored.
_status (str) –
The current status of the conference create request. Should not be set by developer.
The possible values are:
”pending”: the conference create request is still being processed.
”failure”: the conference create request failed, there are no entry points.
”success”: the conference create request succeeded, the entry points are populated. In this case ConferenceSolution with created entry points is stored in the event’s conference_data. And ConferenceSolutionCreateRequest is omitted.
conference_id (str) –
The ID of the conference. Optional. Can be used by developers to keep track of conferences, should not be displayed to users.
Values for solution types (see
SolutionType
):HANGOUT: unset
NAMED_HANGOUT: the name of the Hangout
HANGOUTS_MEET: the 10-letter meeting code, for example “aaa-bbbb-ccc”
ADD_ON: defined by 3P conference provider
signature (str) – The signature of the conference data. Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. None for a conference with a failed create request. Optional for a conference with a pending create request.
notes (str) – String of additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters
- class gcsa.conference.SolutionType
HANGOUT - for Hangouts for consumers (hangouts.google.com)
NAMED_HANGOUT - for classic Hangouts for Google Workspace users (hangouts.google.com)
HANGOUTS_MEET - for Google Meet (meet.google.com)
ADD_ON - for 3P conference providers
- HANGOUT = 'eventHangout'
- NAMED_HANGOUT = 'eventNamedHangout'
- HANGOUTS_MEET = 'hangoutsMeet'
- ADD_ON = 'addOn'