Class: Google::Apis::CalendarV3::ConferenceData

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/calendar_v3/classes.rb,
generated/google/apis/calendar_v3/representations.rb,
generated/google/apis/calendar_v3/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ConferenceData

Returns a new instance of ConferenceData.



688
689
690
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 688

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#conference_id ⇒ String

The ID of the conference. Can be used by developers to keep track of conferences, should not be displayed to users. Values for solution types:

  • "eventHangout": unset.
  • "eventNamedHangout": the name of the Hangout.
  • "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".
  • "addOn": defined by 3P conference provider. Optional. Corresponds to the JSON property conferenceId

Returns:

  • (String) 


638
639
640
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 638

def conference_id
  @conference_id
end

#conference_solution ⇒ Google::Apis::CalendarV3::ConferenceSolution

The conference solution, such as Hangouts or Hangouts Meet. Unset for a conference with a failed create request. Either conferenceSolution and at least one entryPoint, or createRequest is required. Corresponds to the JSON property conferenceSolution

Returns:



646
647
648
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 646

def conference_solution
  @conference_solution
end

#create_request ⇒ Google::Apis::CalendarV3::CreateConferenceRequest

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. Corresponds to the JSON property createRequest

Returns:



655
656
657
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 655

def create_request
  @create_request
end

#entry_points ⇒ Array<Google::Apis::CalendarV3::EntryPoint>

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. Corresponds to the JSON property entryPoints

Returns:



664
665
666
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 664

def entry_points
  @entry_points
end

#notes ⇒ String

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. Corresponds to the JSON property notes

Returns:

  • (String) 


671
672
673
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 671

def notes
  @notes
end

#parameters ⇒ Google::Apis::CalendarV3::ConferenceParameters

Additional properties related to a conference. An example would be a solution- specific setting for enabling video streaming. Corresponds to the JSON property parameters

Returns:



677
678
679
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 677

def parameters
  @parameters
end

#signature ⇒ String

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. Unset for a conference with a failed create request. Optional for a conference with a pending create request. Corresponds to the JSON property signature

Returns:

  • (String) 


686
687
688
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 686

def signature
  @signature
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



693
694
695
696
697
698
699
700
701
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 693

def update!(**args)
  @conference_id = args[:conference_id] if args.key?(:conference_id)
  @conference_solution = args[:conference_solution] if args.key?(:conference_solution)
  @create_request = args[:create_request] if args.key?(:create_request)
  @entry_points = args[:entry_points] if args.key?(:entry_points)
  @notes = args[:notes] if args.key?(:notes)
  @parameters = args[:parameters] if args.key?(:parameters)
  @signature = args[:signature] if args.key?(:signature)
end