Class: Google::Apis::CloudsearchV1::CallInfo

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

Overview

Contains information regarding an ongoing conference (aka call) for a meeting space.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CallInfo

Returns a new instance of CallInfo.



5601
5602
5603
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5601

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

Instance Attribute Details

#abuse_reporting_config ⇒ Google::Apis::CloudsearchV1::AbuseReportingConfig

Abuse reporting configuration outlining what is supported in this conference. Corresponds to the JSON property abuseReportingConfig

Returns:



5470
5471
5472
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5470

def abuse_reporting_config
  @abuse_reporting_config
end

#artifact_owner ⇒ Google::Apis::CloudsearchV1::UserDisplayInfo

Resource for displaying user info Corresponds to the JSON property artifactOwner

Returns:



5475
5476
5477
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5475

def artifact_owner
  @artifact_owner
end

#attached_documents ⇒ Array<Google::Apis::CloudsearchV1::DocumentInfo>

Output only. Documents attached to an ongoing conference. Corresponds to the JSON property attachedDocuments

Returns:



5480
5481
5482
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5480

def attached_documents
  @attached_documents
end

#available_access_types ⇒ Array<String>

List of available access types of the conference. Corresponds to the JSON property availableAccessTypes

Returns:

  • (Array<String>) 


5485
5486
5487
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5485

def available_access_types
  @available_access_types
end

#available_annotation_tool_types ⇒ Array<String>

Available screen annotation tool types. Corresponds to the JSON property availableAnnotationToolTypes

Returns:

  • (Array<String>) 


5490
5491
5492
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5490

def available_annotation_tool_types
  @available_annotation_tool_types
end

#available_reactions ⇒ Array<Google::Apis::CloudsearchV1::ReactionInfo>

Output only. The set of reactions that clients are allowed to send and can expect to receive. Note that a device in the conference should have the MAY_SEND_REACTIONS privilege to be able to send reactions. Corresponds to the JSON property availableReactions

Returns:



5497
5498
5499
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5497

def available_reactions
  @available_reactions
end

#broadcast_session_info ⇒ Google::Apis::CloudsearchV1::BroadcastSessionInfo

Information about a broadcast session. Corresponds to the JSON property broadcastSessionInfo

Returns:



5502
5503
5504
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5502

def broadcast_session_info
  @broadcast_session_info
end

#calendar_event_id ⇒ String

Output only. The calendar event ID of a Google Calendar event that the meeting space is associated with. If the meeting space is not associated with an event in Google Calendar, this field is empty. For recurring events, it refers to the recurring instance associated with the current call, as determined by the server. Corresponds to the JSON property calendarEventId

Returns:

  • (String) 


5511
5512
5513
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5511

def calendar_event_id
  @calendar_event_id
end

#co_activity ⇒ Google::Apis::CloudsearchV1::CoActivity

Metadata about a co-activity session. Corresponds to the JSON property coActivity

Returns:



5516
5517
5518
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5516

def co_activity
  @co_activity
end

#collaboration ⇒ Google::Apis::CloudsearchV1::Collaboration

Information about a collaboration session. Corresponds to the JSON property collaboration

Returns:



5521
5522
5523
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5521

def collaboration
  @collaboration
end

#cse_info ⇒ Google::Apis::CloudsearchV1::CseInfo

Information needed for Client-side Encryption. Corresponds to the JSON property cseInfo

Returns:



5526
5527
5528
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5526

def cse_info
  @cse_info
end

#max_joined_devices ⇒ Fixnum

Output only. The maximum number of devices that may be in the joined state simultaneously in this conference. This can be used by clients to guess whether it will be possible to join, but the only way to know is to try to join. It can also be used to inform users about the limit that is in effect. This limit is normally set when the conference is created and not changed during the lifetime of the conference. But there are some cases where it may change, so clients should be aware that the information may be stale. Corresponds to the JSON property maxJoinedDevices

Returns:

  • (Fixnum) 


5537
5538
5539
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5537

def max_joined_devices
  @max_joined_devices
end

#organization_name ⇒ String

Output only. The name or description of the organization or domain that the organizer belongs to. The expected use of this in clients is to present messages like "John Doe (outside of Google.com) is trying to join this call", where "Google.com" is the organization name. The field will be empty if the organization name could not be determined, possibly because of a backend error. Corresponds to the JSON property organizationName

Returns:

  • (String) 


5546
5547
5548
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5546

def organization_name
  @organization_name
end

#paygate_info ⇒ Google::Apis::CloudsearchV1::PaygateInfo

Information provided to clients so that they can show upgrade promos and warnings on call ending early (for non-paying users). Corresponds to the JSON property paygateInfo

Returns:



5552
5553
5554
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5552

def paygate_info
  @paygate_info
end

#presenter ⇒ Google::Apis::CloudsearchV1::Presenter

Presenter contains information about which device is currently presenting as well as which device requested the presenter to be set. Corresponds to the JSON property presenter

Returns:



5558
5559
5560
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5558

def presenter
  @presenter
end

#recording_info ⇒ Google::Apis::CloudsearchV1::RecordingInfo

This message is deprecated, please use RecordingSessionInfo instead. Information about recording in the current conference. Corresponds to the JSON property recordingInfo

Returns:



5564
5565
5566
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5564

def recording_info
  @recording_info
end

#recording_session_info ⇒ Google::Apis::CloudsearchV1::RecordingSessionInfo

Information about a recording session. Corresponds to the JSON property recordingSessionInfo

Returns:



5569
5570
5571
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5569

def recording_session_info
  @recording_session_info
end

#settings ⇒ Google::Apis::CloudsearchV1::CallSettings

Effective settings of the ongoing conference. Corresponds to the JSON property settings

Returns:



5574
5575
5576
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5574

def settings
  @settings
end

#streaming_sessions ⇒ Array<Google::Apis::CloudsearchV1::StreamingSessionInfo>

Output only. Info about streaming sessions (recording or broadcast) for this conference. This should contain all active sessions. Currently, it's guaranteed to have at most one recording and at most one broadcast (at most two sessions in total). For each application type (recording or broadcast), latest inactive session is included if there's no active one. Corresponds to the JSON property streamingSessions

Returns:



5583
5584
5585
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5583

def streaming_sessions
  @streaming_sessions
end

#transcription_session_info ⇒ Google::Apis::CloudsearchV1::TranscriptionSessionInfo

Information about a transcription session. Corresponds to the JSON property transcriptionSessionInfo

Returns:



5588
5589
5590
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5588

def transcription_session_info
  @transcription_session_info
end

#viewer_count ⇒ Fixnum

The number of devices viewing the conference - MeetingDevices that are in VIEWER role and JOINED state in the conference. Corresponds to the JSON property viewerCount

Returns:

  • (Fixnum) 


5594
5595
5596
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5594

def viewer_count
  @viewer_count
end

#you_tube_broadcast_session_infos ⇒ Array<Google::Apis::CloudsearchV1::YouTubeBroadcastSessionInfo>

Information about active YouTube broadcast sessions in the ongoing conference. Corresponds to the JSON property youTubeBroadcastSessionInfos

Returns:



5599
5600
5601
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5599

def you_tube_broadcast_session_infos
  @you_tube_broadcast_session_infos
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5606

def update!(**args)
  @abuse_reporting_config = args[:abuse_reporting_config] if args.key?(:abuse_reporting_config)
  @artifact_owner = args[:artifact_owner] if args.key?(:artifact_owner)
  @attached_documents = args[:attached_documents] if args.key?(:attached_documents)
  @available_access_types = args[:available_access_types] if args.key?(:available_access_types)
  @available_annotation_tool_types = args[:available_annotation_tool_types] if args.key?(:available_annotation_tool_types)
  @available_reactions = args[:available_reactions] if args.key?(:available_reactions)
  @broadcast_session_info = args[:broadcast_session_info] if args.key?(:broadcast_session_info)
  @calendar_event_id = args[:calendar_event_id] if args.key?(:calendar_event_id)
  @co_activity = args[:co_activity] if args.key?(:co_activity)
  @collaboration = args[:collaboration] if args.key?(:collaboration)
  @cse_info = args[:cse_info] if args.key?(:cse_info)
  @max_joined_devices = args[:max_joined_devices] if args.key?(:max_joined_devices)
  @organization_name = args[:organization_name] if args.key?(:organization_name)
  @paygate_info = args[:paygate_info] if args.key?(:paygate_info)
  @presenter = args[:presenter] if args.key?(:presenter)
  @recording_info = args[:recording_info] if args.key?(:recording_info)
  @recording_session_info = args[:recording_session_info] if args.key?(:recording_session_info)
  @settings = args[:settings] if args.key?(:settings)
  @streaming_sessions = args[:streaming_sessions] if args.key?(:streaming_sessions)
  @transcription_session_info = args[:transcription_session_info] if args.key?(:transcription_session_info)
  @viewer_count = args[:viewer_count] if args.key?(:viewer_count)
  @you_tube_broadcast_session_infos = args[:you_tube_broadcast_session_infos] if args.key?(:you_tube_broadcast_session_infos)
end