Class: Twilio::REST::Insights::V1::ConferenceContext::ConferenceParticipantInstance

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, conference_sid: nil, participant_sid: nil) ⇒ ConferenceParticipantInstance

Initialize the ConferenceParticipantInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this ConferenceParticipant resource.

  • sid (String) —

    The SID of the Call resource to fetch.



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 241

def initialize(version, payload , conference_sid: nil, participant_sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'participant_sid' => payload['participant_sid'],
        'label' => payload['label'],
        'conference_sid' => payload['conference_sid'],
        'call_sid' => payload['call_sid'],
        'account_sid' => payload['account_sid'],
        'call_direction' => payload['call_direction'],
        'from' => payload['from'],
        'to' => payload['to'],
        'call_status' => payload['call_status'],
        'country_code' => payload['country_code'],
        'is_moderator' => payload['is_moderator'],
        'join_time' => Twilio.deserialize_iso8601_datetime(payload['join_time']),
        'leave_time' => Twilio.deserialize_iso8601_datetime(payload['leave_time']),
        'duration_seconds' => payload['duration_seconds'] == nil ? payload['duration_seconds'] : payload['duration_seconds'].to_i,
        'outbound_queue_length' => payload['outbound_queue_length'] == nil ? payload['outbound_queue_length'] : payload['outbound_queue_length'].to_i,
        'outbound_time_in_queue' => payload['outbound_time_in_queue'] == nil ? payload['outbound_time_in_queue'] : payload['outbound_time_in_queue'].to_i,
        'jitter_buffer_size' => payload['jitter_buffer_size'],
        'is_coach' => payload['is_coach'],
        'coached_participants' => payload['coached_participants'],
        'participant_region' => payload['participant_region'],
        'conference_region' => payload['conference_region'],
        'call_type' => payload['call_type'],
        'processing_state' => payload['processing_state'],
        'properties' => payload['properties'],
        'events' => payload['events'],
        'metrics' => payload['metrics'],
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = { 'conference_sid' => conference_sid  || @properties['conference_sid']  ,'participant_sid' => participant_sid  || @properties['participant_sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique SID identifier of the Account.

Returns:

  • (String) —

    The unique SID identifier of the Account.



317
318
319
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 317

def 
    @properties['account_sid']
end

#call_direction ⇒ CallDirection

Returns:

  • (CallDirection) 


323
324
325
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 323

def call_direction
    @properties['call_direction']
end

#call_sid ⇒ String

Returns Unique SID identifier of the call that generated the Participant resource.

Returns:

  • (String) —

    Unique SID identifier of the call that generated the Participant resource.



311
312
313
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 311

def call_sid
    @properties['call_sid']
end

#call_status ⇒ CallStatus

Returns:

  • (CallStatus) 


341
342
343
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 341

def call_status
    @properties['call_status']
end

#call_type ⇒ CallType

Returns:

  • (CallType) 


419
420
421
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 419

def call_type
    @properties['call_type']
end

#coached_participants ⇒ Array<String>

Returns Call SIDs coached by this participant.

Returns:

  • (Array<String>) —

    Call SIDs coached by this participant.



401
402
403
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 401

def coached_participants
    @properties['coached_participants']
end

#conference_region ⇒ Region

Returns:

  • (Region) 


413
414
415
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 413

def conference_region
    @properties['conference_region']
end

#conference_sid ⇒ String

Returns The unique SID identifier of the Conference.

Returns:

  • (String) —

    The unique SID identifier of the Conference.



305
306
307
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 305

def conference_sid
    @properties['conference_sid']
end

#context ⇒ ConferenceParticipantContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



284
285
286
287
288
289
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 284

def context
    unless @instance_context
        @instance_context = ConferenceParticipantContext.new(@version , @params['conference_sid'], @params['participant_sid'])
    end
    @instance_context
end

#country_code ⇒ String

Returns ISO alpha-2 country code of the participant based on caller ID or called number.

Returns:

  • (String) —

    ISO alpha-2 country code of the participant based on caller ID or called number.



347
348
349
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 347

def country_code
    @properties['country_code']
end

#duration_seconds ⇒ String

Returns Participant durations in seconds.

Returns:

  • (String) —

    Participant durations in seconds.



371
372
373
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 371

def duration_seconds
    @properties['duration_seconds']
end

#events ⇒ Hash

Returns Object containing information of actions taken by participants. Contains a dictionary of URL links to nested resources of this Conference Participant.

Returns:

  • (Hash) —

    Object containing information of actions taken by participants. Contains a dictionary of URL links to nested resources of this Conference Participant.



437
438
439
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 437

def events
    @properties['events']
end

#fetch(events: :unset, metrics: :unset) ⇒ ConferenceParticipantInstance

Fetch the ConferenceParticipantInstance

Parameters:

  • events (String) (defaults to: :unset) —

    Conference events generated by application or participant activity; e.g. ‘hold`, `mute`, etc.

  • metrics (String) (defaults to: :unset) —

    Object. Contains participant call quality metrics.

Returns:



458
459
460
461
462
463
464
465
466
467
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 458

def fetch(
    events: :unset, 
    metrics: :unset
)

    context.fetch(
        events: events, 
        metrics: metrics, 
    )
end

#from ⇒ String

Returns Caller ID of the calling party.

Returns:

  • (String) —

    Caller ID of the calling party.



329
330
331
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 329

def from
    @properties['from']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



478
479
480
481
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 478

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Insights.V1.ConferenceParticipantInstance #{values}>"
end

#is_coach ⇒ Boolean

Returns Boolean. Indicated whether participant was a coach.

Returns:

  • (Boolean) —

    Boolean. Indicated whether participant was a coach.



395
396
397
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 395

def is_coach
    @properties['is_coach']
end

#is_moderator ⇒ Boolean

Returns Boolean. Indicates whether participant had startConferenceOnEnter=true or endConferenceOnExit=true.

Returns:

  • (Boolean) —

    Boolean. Indicates whether participant had startConferenceOnEnter=true or endConferenceOnExit=true.



353
354
355
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 353

def is_moderator
    @properties['is_moderator']
end

#jitter_buffer_size ⇒ JitterBufferSize

Returns:

  • (JitterBufferSize) 


389
390
391
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 389

def jitter_buffer_size
    @properties['jitter_buffer_size']
end

#join_time ⇒ Time

Returns ISO 8601 timestamp of participant join event.

Returns:

  • (Time) —

    ISO 8601 timestamp of participant join event.



359
360
361
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 359

def join_time
    @properties['join_time']
end

#label ⇒ String

Returns The user-specified label of this participant.

Returns:

  • (String) —

    The user-specified label of this participant.



299
300
301
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 299

def label
    @properties['label']
end

#leave_time ⇒ Time

Returns ISO 8601 timestamp of participant leave event.

Returns:

  • (Time) —

    ISO 8601 timestamp of participant leave event.



365
366
367
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 365

def leave_time
    @properties['leave_time']
end

#metrics ⇒ Hash

Returns Object. Contains participant call quality metrics.

Returns:

  • (Hash) —

    Object. Contains participant call quality metrics.



443
444
445
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 443

def metrics
    @properties['metrics']
end

#outbound_queue_length ⇒ String

Returns Add Participant API only. Estimated time in queue at call creation.

Returns:

  • (String) —

    Add Participant API only. Estimated time in queue at call creation.



377
378
379
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 377

def outbound_queue_length
    @properties['outbound_queue_length']
end

#outbound_time_in_queue ⇒ String

Returns Add Participant API only. Actual time in queue in seconds.

Returns:

  • (String) —

    Add Participant API only. Actual time in queue in seconds.



383
384
385
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 383

def outbound_time_in_queue
    @properties['outbound_time_in_queue']
end

#participant_region ⇒ Region

Returns:

  • (Region) 


407
408
409
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 407

def participant_region
    @properties['participant_region']
end

#participant_sid ⇒ String

Returns SID for this participant.

Returns:

  • (String) —

    SID for this participant.



293
294
295
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 293

def participant_sid
    @properties['participant_sid']
end

#processing_state ⇒ ProcessingState

Returns:

  • (ProcessingState) 


425
426
427
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 425

def processing_state
    @properties['processing_state']
end

#properties ⇒ Hash

Returns Participant properties and metadata.

Returns:

  • (Hash) —

    Participant properties and metadata.



431
432
433
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 431

def properties
    @properties['properties']
end

#to ⇒ String

Returns Called party.

Returns:

  • (String) —

    Called party.



335
336
337
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 335

def to
    @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



471
472
473
474
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 471

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Insights.V1.ConferenceParticipantInstance #{values}>"
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



449
450
451
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 449

def url
    @properties['url']
end