Class: MicrosoftGraph::Models::Call

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/call.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Entity

#additional_data, #additional_data=, #id, #id=, #odata_type, #odata_type=

Constructor Details

#initialize ⇒ Object

Instantiates a new call and sets the default values.



175
176
177
 
# File 'lib/models/call.rb', line 175

def initialize()
    super
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node —

    The parse node to use to read the discriminator value and create the object

Returns:

  • a call

Raises:

  • (StandardError) 


198
199
200
201
 
# File 'lib/models/call.rb', line 198

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return Call.new
end

Instance Method Details

#audio_routing_groups ⇒ Object

Gets the audioRoutingGroups property value. The audioRoutingGroups property

Returns:

  • a audio_routing_group



85
86
87
 
# File 'lib/models/call.rb', line 85

def audio_routing_groups
    return @audio_routing_groups
end

#audio_routing_groups=(value) ⇒ Object

Sets the audioRoutingGroups property value. The audioRoutingGroups property

Parameters:

  • value —

    Value to set for the audioRoutingGroups property.

Returns:

  • a void



93
94
95
 
# File 'lib/models/call.rb', line 93

def audio_routing_groups=(value)
    @audio_routing_groups = value
end

#call_chain_id ⇒ Object

Gets the callChainId property value. A unique identifier for all the participant calls in a conference or a unique identifier for two participant calls in a P2P call. This needs to be copied over from Microsoft.Graph.Call.CallChainId.

Returns:

  • a string



100
101
102
 
# File 'lib/models/call.rb', line 100

def call_chain_id
    return @call_chain_id
end

#call_chain_id=(value) ⇒ Object

Sets the callChainId property value. A unique identifier for all the participant calls in a conference or a unique identifier for two participant calls in a P2P call. This needs to be copied over from Microsoft.Graph.Call.CallChainId.

Parameters:

  • value —

    Value to set for the callChainId property.

Returns:

  • a void



108
109
110
 
# File 'lib/models/call.rb', line 108

def call_chain_id=(value)
    @call_chain_id = value
end

#call_options ⇒ Object

Gets the callOptions property value. Contains the optional features for the call.

Returns:

  • a call_options



115
116
117
 
# File 'lib/models/call.rb', line 115

def call_options
    return @call_options
end

#call_options=(value) ⇒ Object

Sets the callOptions property value. Contains the optional features for the call.

Parameters:

  • value —

    Value to set for the callOptions property.

Returns:

  • a void



123
124
125
 
# File 'lib/models/call.rb', line 123

def call_options=(value)
    @call_options = value
end

#call_routes ⇒ Object

Gets the callRoutes property value. The routing information on how the call was retargeted. Read-only.

Returns:

  • a call_route



130
131
132
 
# File 'lib/models/call.rb', line 130

def call_routes
    return @call_routes
end

#call_routes=(value) ⇒ Object

Sets the callRoutes property value. The routing information on how the call was retargeted. Read-only.

Parameters:

  • value —

    Value to set for the callRoutes property.

Returns:

  • a void



138
139
140
 
# File 'lib/models/call.rb', line 138

def call_routes=(value)
    @call_routes = value
end

#callback_uri ⇒ Object

Gets the callbackUri property value. The callback URL on which callbacks will be delivered. Must be https.

Returns:

  • a string



145
146
147
 
# File 'lib/models/call.rb', line 145

def callback_uri
    return @callback_uri
end

#callback_uri=(value) ⇒ Object

Sets the callbackUri property value. The callback URL on which callbacks will be delivered. Must be https.

Parameters:

  • value —

    Value to set for the callbackUri property.

Returns:

  • a void



153
154
155
 
# File 'lib/models/call.rb', line 153

def callback_uri=(value)
    @callback_uri = value
end

#chat_info ⇒ Object

Gets the chatInfo property value. The chat information. Required information for joining a meeting.

Returns:

  • a chat_info



160
161
162
 
# File 'lib/models/call.rb', line 160

def chat_info
    return @chat_info
end

#chat_info=(value) ⇒ Object

Sets the chatInfo property value. The chat information. Required information for joining a meeting.

Parameters:

  • value —

    Value to set for the chatInfo property.

Returns:

  • a void



168
169
170
 
# File 'lib/models/call.rb', line 168

def chat_info=(value)
    @chat_info = value
end

#content_sharing_sessions ⇒ Object

Gets the contentSharingSessions property value. The contentSharingSessions property

Returns:

  • a content_sharing_session



182
183
184
 
# File 'lib/models/call.rb', line 182

def content_sharing_sessions
    return @content_sharing_sessions
end

#content_sharing_sessions=(value) ⇒ Object

Sets the contentSharingSessions property value. The contentSharingSessions property

Parameters:

  • value —

    Value to set for the contentSharingSessions property.

Returns:

  • a void



190
191
192
 
# File 'lib/models/call.rb', line 190

def content_sharing_sessions=(value)
    @content_sharing_sessions = value
end

#direction ⇒ Object

Gets the direction property value. The direction of the call. The possible value are incoming or outgoing. Read-only.

Returns:

  • a call_direction



206
207
208
 
# File 'lib/models/call.rb', line 206

def direction
    return @direction
end

#direction=(value) ⇒ Object

Sets the direction property value. The direction of the call. The possible value are incoming or outgoing. Read-only.

Parameters:

  • value —

    Value to set for the direction property.

Returns:

  • a void



214
215
216
 
# File 'lib/models/call.rb', line 214

def direction=(value)
    @direction = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/models/call.rb', line 221

def get_field_deserializers()
    return super.merge({
        "audioRoutingGroups" => lambda {|n| @audio_routing_groups = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AudioRoutingGroup.create_from_discriminator_value(pn) }) },
        "callChainId" => lambda {|n| @call_chain_id = n.get_string_value() },
        "callOptions" => lambda {|n| @call_options = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::CallOptions.create_from_discriminator_value(pn) }) },
        "callRoutes" => lambda {|n| @call_routes = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::CallRoute.create_from_discriminator_value(pn) }) },
        "callbackUri" => lambda {|n| @callback_uri = n.get_string_value() },
        "chatInfo" => lambda {|n| @chat_info = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::ChatInfo.create_from_discriminator_value(pn) }) },
        "contentSharingSessions" => lambda {|n| @content_sharing_sessions = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ContentSharingSession.create_from_discriminator_value(pn) }) },
        "direction" => lambda {|n| @direction = n.get_enum_value(MicrosoftGraph::Models::CallDirection) },
        "incomingContext" => lambda {|n| @incoming_context = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::IncomingContext.create_from_discriminator_value(pn) }) },
        "mediaConfig" => lambda {|n| @media_config = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::MediaConfig.create_from_discriminator_value(pn) }) },
        "mediaState" => lambda {|n| @media_state = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::CallMediaState.create_from_discriminator_value(pn) }) },
        "meetingInfo" => lambda {|n| @meeting_info = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::MeetingInfo.create_from_discriminator_value(pn) }) },
        "myParticipantId" => lambda {|n| @my_participant_id = n.get_string_value() },
        "operations" => lambda {|n| @operations = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::CommsOperation.create_from_discriminator_value(pn) }) },
        "participants" => lambda {|n| @participants = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Participant.create_from_discriminator_value(pn) }) },
        "requestedModalities" => lambda {|n| @requested_modalities = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Modality.create_from_discriminator_value(pn) }) },
        "resultInfo" => lambda {|n| @result_info = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::ResultInfo.create_from_discriminator_value(pn) }) },
        "source" => lambda {|n| @source = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::ParticipantInfo.create_from_discriminator_value(pn) }) },
        "state" => lambda {|n| @state = n.get_enum_value(MicrosoftGraph::Models::CallState) },
        "subject" => lambda {|n| @subject = n.get_string_value() },
        "targets" => lambda {|n| @targets = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::InvitationParticipantInfo.create_from_discriminator_value(pn) }) },
        "tenantId" => lambda {|n| @tenant_id = n.get_string_value() },
        "toneInfo" => lambda {|n| @tone_info = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::ToneInfo.create_from_discriminator_value(pn) }) },
        "transcription" => lambda {|n| @transcription = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::CallTranscriptionInfo.create_from_discriminator_value(pn) }) },
    })
end

#incoming_context ⇒ Object

Gets the incomingContext property value. Call context associated with an incoming call.

Returns:

  • a incoming_context



253
254
255
 
# File 'lib/models/call.rb', line 253

def incoming_context
    return @incoming_context
end

#incoming_context=(value) ⇒ Object

Sets the incomingContext property value. Call context associated with an incoming call.

Parameters:

  • value —

    Value to set for the incomingContext property.

Returns:

  • a void



261
262
263
 
# File 'lib/models/call.rb', line 261

def incoming_context=(value)
    @incoming_context = value
end

#media_config ⇒ Object

Gets the mediaConfig property value. The media configuration. Required.

Returns:

  • a media_config



268
269
270
 
# File 'lib/models/call.rb', line 268

def media_config
    return @media_config
end

#media_config=(value) ⇒ Object

Sets the mediaConfig property value. The media configuration. Required.

Parameters:

  • value —

    Value to set for the mediaConfig property.

Returns:

  • a void



276
277
278
 
# File 'lib/models/call.rb', line 276

def media_config=(value)
    @media_config = value
end

#media_state ⇒ Object

Gets the mediaState property value. Read-only. The call media state.

Returns:

  • a call_media_state



283
284
285
 
# File 'lib/models/call.rb', line 283

def media_state
    return @media_state
end

#media_state=(value) ⇒ Object

Sets the mediaState property value. Read-only. The call media state.

Parameters:

  • value —

    Value to set for the mediaState property.

Returns:

  • a void



291
292
293
 
# File 'lib/models/call.rb', line 291

def media_state=(value)
    @media_state = value
end

#meeting_info ⇒ Object

Gets the meetingInfo property value. The meeting information. Required information for meeting scenarios.

Returns:

  • a meeting_info



298
299
300
 
# File 'lib/models/call.rb', line 298

def meeting_info
    return @meeting_info
end

#meeting_info=(value) ⇒ Object

Sets the meetingInfo property value. The meeting information. Required information for meeting scenarios.

Parameters:

  • value —

    Value to set for the meetingInfo property.

Returns:

  • a void



306
307
308
 
# File 'lib/models/call.rb', line 306

def meeting_info=(value)
    @meeting_info = value
end

#my_participant_id ⇒ Object

Gets the myParticipantId property value. The myParticipantId property

Returns:

  • a string



313
314
315
 
# File 'lib/models/call.rb', line 313

def my_participant_id
    return @my_participant_id
end

#my_participant_id=(value) ⇒ Object

Sets the myParticipantId property value. The myParticipantId property

Parameters:

  • value —

    Value to set for the myParticipantId property.

Returns:

  • a void



321
322
323
 
# File 'lib/models/call.rb', line 321

def my_participant_id=(value)
    @my_participant_id = value
end

#operations ⇒ Object

Gets the operations property value. The operations property

Returns:

  • a comms_operation



328
329
330
 
# File 'lib/models/call.rb', line 328

def operations
    return @operations
end

#operations=(value) ⇒ Object

Sets the operations property value. The operations property

Parameters:

  • value —

    Value to set for the operations property.

Returns:

  • a void



336
337
338
 
# File 'lib/models/call.rb', line 336

def operations=(value)
    @operations = value
end

#participants ⇒ Object

Gets the participants property value. The participants property

Returns:

  • a participant



343
344
345
 
# File 'lib/models/call.rb', line 343

def participants
    return @participants
end

#participants=(value) ⇒ Object

Sets the participants property value. The participants property

Parameters:

  • value —

    Value to set for the participants property.

Returns:

  • a void



351
352
353
 
# File 'lib/models/call.rb', line 351

def participants=(value)
    @participants = value
end

#requested_modalities ⇒ Object

Gets the requestedModalities property value. The list of requested modalities. Possible values are: unknown, audio, video, videoBasedScreenSharing, data.

Returns:

  • a modality



358
359
360
 
# File 'lib/models/call.rb', line 358

def requested_modalities
    return @requested_modalities
end

#requested_modalities=(value) ⇒ Object

Sets the requestedModalities property value. The list of requested modalities. Possible values are: unknown, audio, video, videoBasedScreenSharing, data.

Parameters:

  • value —

    Value to set for the requestedModalities property.

Returns:

  • a void



366
367
368
 
# File 'lib/models/call.rb', line 366

def requested_modalities=(value)
    @requested_modalities = value
end

#result_info ⇒ Object

Gets the resultInfo property value. The result information. For example can hold termination reason. Read-only.

Returns:

  • a result_info



373
374
375
 
# File 'lib/models/call.rb', line 373

def result_info
    return @result_info
end

#result_info=(value) ⇒ Object

Sets the resultInfo property value. The result information. For example can hold termination reason. Read-only.

Parameters:

  • value —

    Value to set for the resultInfo property.

Returns:

  • a void



381
382
383
 
# File 'lib/models/call.rb', line 381

def result_info=(value)
    @result_info = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer —

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError) 


389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/models/call.rb', line 389

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_collection_of_object_values("audioRoutingGroups", @audio_routing_groups)
    writer.write_string_value("callChainId", @call_chain_id)
    writer.write_object_value("callOptions", @call_options)
    writer.write_collection_of_object_values("callRoutes", @call_routes)
    writer.write_string_value("callbackUri", @callback_uri)
    writer.write_object_value("chatInfo", @chat_info)
    writer.write_collection_of_object_values("contentSharingSessions", @content_sharing_sessions)
    writer.write_enum_value("direction", @direction)
    writer.write_object_value("incomingContext", @incoming_context)
    writer.write_object_value("mediaConfig", @media_config)
    writer.write_object_value("mediaState", @media_state)
    writer.write_object_value("meetingInfo", @meeting_info)
    writer.write_string_value("myParticipantId", @my_participant_id)
    writer.write_collection_of_object_values("operations", @operations)
    writer.write_collection_of_object_values("participants", @participants)
    writer.write_collection_of_object_values("requestedModalities", @requested_modalities)
    writer.write_object_value("resultInfo", @result_info)
    writer.write_object_value("source", @source)
    writer.write_enum_value("state", @state)
    writer.write_string_value("subject", @subject)
    writer.write_collection_of_object_values("targets", @targets)
    writer.write_string_value("tenantId", @tenant_id)
    writer.write_object_value("toneInfo", @tone_info)
    writer.write_object_value("transcription", @transcription)
end

#source ⇒ Object

Gets the source property value. The originator of the call.

Returns:

  • a participant_info



421
422
423
 
# File 'lib/models/call.rb', line 421

def source
    return @source
end

#source=(value) ⇒ Object

Sets the source property value. The originator of the call.

Parameters:

  • value —

    Value to set for the source property.

Returns:

  • a void



429
430
431
 
# File 'lib/models/call.rb', line 429

def source=(value)
    @source = value
end

#state ⇒ Object

Gets the state property value. The call state. Possible values are: incoming, establishing, ringing, established, hold, transferring, transferAccepted, redirecting, terminating, terminated. Read-only.

Returns:

  • a call_state



436
437
438
 
# File 'lib/models/call.rb', line 436

def state
    return @state
end

#state=(value) ⇒ Object

Sets the state property value. The call state. Possible values are: incoming, establishing, ringing, established, hold, transferring, transferAccepted, redirecting, terminating, terminated. Read-only.

Parameters:

  • value —

    Value to set for the state property.

Returns:

  • a void



444
445
446
 
# File 'lib/models/call.rb', line 444

def state=(value)
    @state = value
end

#subject ⇒ Object

Gets the subject property value. The subject of the conversation.

Returns:

  • a string



451
452
453
 
# File 'lib/models/call.rb', line 451

def subject
    return @subject
end

#subject=(value) ⇒ Object

Sets the subject property value. The subject of the conversation.

Parameters:

  • value —

    Value to set for the subject property.

Returns:

  • a void



459
460
461
 
# File 'lib/models/call.rb', line 459

def subject=(value)
    @subject = value
end

#targets ⇒ Object

Gets the targets property value. The targets of the call. Required information for creating peer to peer call.

Returns:

  • a invitation_participant_info



466
467
468
 
# File 'lib/models/call.rb', line 466

def targets
    return @targets
end

#targets=(value) ⇒ Object

Sets the targets property value. The targets of the call. Required information for creating peer to peer call.

Parameters:

  • value —

    Value to set for the targets property.

Returns:

  • a void



474
475
476
 
# File 'lib/models/call.rb', line 474

def targets=(value)
    @targets = value
end

#tenant_id ⇒ Object

Gets the tenantId property value. The tenantId property

Returns:

  • a string



481
482
483
 
# File 'lib/models/call.rb', line 481

def tenant_id
    return @tenant_id
end

#tenant_id=(value) ⇒ Object

Sets the tenantId property value. The tenantId property

Parameters:

  • value —

    Value to set for the tenantId property.

Returns:

  • a void



489
490
491
 
# File 'lib/models/call.rb', line 489

def tenant_id=(value)
    @tenant_id = value
end

#tone_info ⇒ Object

Gets the toneInfo property value. The toneInfo property

Returns:

  • a tone_info



496
497
498
 
# File 'lib/models/call.rb', line 496

def tone_info
    return @tone_info
end

#tone_info=(value) ⇒ Object

Sets the toneInfo property value. The toneInfo property

Parameters:

  • value —

    Value to set for the toneInfo property.

Returns:

  • a void



504
505
506
 
# File 'lib/models/call.rb', line 504

def tone_info=(value)
    @tone_info = value
end

#transcription ⇒ Object

Gets the transcription property value. The transcription information for the call. Read-only.

Returns:

  • a call_transcription_info



511
512
513
 
# File 'lib/models/call.rb', line 511

def transcription
    return @transcription
end

#transcription=(value) ⇒ Object

Sets the transcription property value. The transcription information for the call. Read-only.

Parameters:

  • value —

    Value to set for the transcription property.

Returns:

  • a void



519
520
521
 
# File 'lib/models/call.rb', line 519

def transcription=(value)
    @transcription = value
end