Current section

Files

Jump to
google_api_calendar lib google_api calendar v3 model conference_data.ex
Raw

lib/google_api/calendar/v3/model/conference_data.ex

# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# NOTE: This file is auto generated by the elixir code generator program.
# Do not edit this file manually.
defmodule GoogleApi.Calendar.V3.Model.ConferenceData do
@moduledoc """
## Attributes
* `conferenceId` (*type:* `String.t`, *default:* `nil`) - The ID of the conference.
Can be used by developers to keep track of conferences, should not be displayed to users.
The ID value is formed differently for each conference solution type:
- eventHangout: ID is not set. (This conference type is deprecated.)
- eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.)
- hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.
- addOn: ID is defined by the third-party provider. Optional.
* `conferenceSolution` (*type:* `GoogleApi.Calendar.V3.Model.ConferenceSolution.t`, *default:* `nil`) - The conference solution, such as Google Meet.
Unset for a conference with a failed create request.
Either conferenceSolution and at least one entryPoint, or createRequest is required.
* `createRequest` (*type:* `GoogleApi.Calendar.V3.Model.CreateConferenceRequest.t`, *default:* `nil`) - 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.
Either conferenceSolution and at least one entryPoint, or createRequest is required.
* `entryPoints` (*type:* `list(GoogleApi.Calendar.V3.Model.EntryPoint.t)`, *default:* `nil`) - Information about individual conference entry points, such as URLs or phone numbers.
All of them must belong to the same conference.
Either conferenceSolution and at least one entryPoint, or createRequest is required.
* `notes` (*type:* `String.t`, *default:* `nil`) - 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. Optional.
* `parameters` (*type:* `GoogleApi.Calendar.V3.Model.ConferenceParameters.t`, *default:* `nil`) - Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.
* `signature` (*type:* `String.t`, *default:* `nil`) - The signature of the conference data.
Generated on server side.
Unset for a conference with a failed create request.
Optional for a conference with a pending create request.
"""
use GoogleApi.Gax.ModelBase
@type t :: %__MODULE__{
:conferenceId => String.t() | nil,
:conferenceSolution => GoogleApi.Calendar.V3.Model.ConferenceSolution.t() | nil,
:createRequest => GoogleApi.Calendar.V3.Model.CreateConferenceRequest.t() | nil,
:entryPoints => list(GoogleApi.Calendar.V3.Model.EntryPoint.t()) | nil,
:notes => String.t() | nil,
:parameters => GoogleApi.Calendar.V3.Model.ConferenceParameters.t() | nil,
:signature => String.t() | nil
}
field(:conferenceId)
field(:conferenceSolution, as: GoogleApi.Calendar.V3.Model.ConferenceSolution)
field(:createRequest, as: GoogleApi.Calendar.V3.Model.CreateConferenceRequest)
field(:entryPoints, as: GoogleApi.Calendar.V3.Model.EntryPoint, type: :list)
field(:notes)
field(:parameters, as: GoogleApi.Calendar.V3.Model.ConferenceParameters)
field(:signature)
end
defimpl Poison.Decoder, for: GoogleApi.Calendar.V3.Model.ConferenceData do
def decode(value, options) do
GoogleApi.Calendar.V3.Model.ConferenceData.decode(value, options)
end
end
defimpl Poison.Encoder, for: GoogleApi.Calendar.V3.Model.ConferenceData do
def encode(value, options) do
GoogleApi.Gax.ModelBase.encode(value, options)
end
end