Class: Twilio::REST::Insights::V1::ConferenceInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, conference_sid: nil) ⇒ ConferenceInstance

Initialize the ConferenceInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • conference_sid (String) (defaults to: nil) —

    The conference_sid



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 276

def initialize(version, payload, conference_sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'conference_sid' => payload['conference_sid'],
      'account_sid' => payload['account_sid'],
      'friendly_name' => payload['friendly_name'],
      'create_time' => Twilio.deserialize_iso8601_datetime(payload['create_time']),
      'start_time' => Twilio.deserialize_iso8601_datetime(payload['start_time']),
      'end_time' => Twilio.deserialize_iso8601_datetime(payload['end_time']),
      'duration_seconds' => payload['duration_seconds'] == nil ? payload['duration_seconds'] : payload['duration_seconds'].to_i,
      'connect_duration_seconds' => payload['connect_duration_seconds'] == nil ? payload['connect_duration_seconds'] : payload['connect_duration_seconds'].to_i,
      'status' => payload['status'],
      'max_participants' => payload['max_participants'] == nil ? payload['max_participants'] : payload['max_participants'].to_i,
      'max_concurrent_participants' => payload['max_concurrent_participants'] == nil ? payload['max_concurrent_participants'] : payload['max_concurrent_participants'].to_i,
      'unique_participants' => payload['unique_participants'] == nil ? payload['unique_participants'] : payload['unique_participants'].to_i,
      'end_reason' => payload['end_reason'],
      'ended_by' => payload['ended_by'],
      'mixer_region' => payload['mixer_region'],
      'mixer_region_requested' => payload['mixer_region_requested'],
      'recording_enabled' => payload['recording_enabled'],
      'detected_issues' => payload['detected_issues'],
      'tags' => payload['tags'],
      'tag_info' => payload['tag_info'],
      'url' => payload['url'],
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



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

def 
  @properties['account_sid']
end

#conference_participants ⇒ conference_participants

Access the conference_participants

Returns:



463
464
465
 
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 463

def conference_participants
  context.conference_participants
end

#conference_sid ⇒ String

Returns The conference_sid.

Returns:

  • (String) —

    The conference_sid



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

def conference_sid
  @properties['conference_sid']
end

#connect_duration_seconds ⇒ String

Returns The connect_duration_seconds.

Returns:

  • (String) —

    The connect_duration_seconds



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

def connect_duration_seconds
  @properties['connect_duration_seconds']
end

#context ⇒ ConferenceContext

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

Returns:



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

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

#create_time ⇒ Time

Returns The create_time.

Returns:

  • (Time) —

    The create_time



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

def create_time
  @properties['create_time']
end

#detected_issues ⇒ Hash

Returns The detected_issues.

Returns:

  • (Hash) —

    The detected_issues



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

def detected_issues
  @properties['detected_issues']
end

#duration_seconds ⇒ String

Returns The duration_seconds.

Returns:

  • (String) —

    The duration_seconds



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

def duration_seconds
  @properties['duration_seconds']
end

#end_reason ⇒ conference.ConferenceEndReason

Returns The end_reason.

Returns:

  • (conference.ConferenceEndReason) —

    The end_reason



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

def end_reason
  @properties['end_reason']
end

#end_time ⇒ Time

Returns The end_time.

Returns:

  • (Time) —

    The end_time



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

def end_time
  @properties['end_time']
end

#ended_by ⇒ String

Returns The ended_by.

Returns:

  • (String) —

    The ended_by



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

def ended_by
  @properties['ended_by']
end

#fetch ⇒ ConferenceInstance

Fetch the ConferenceInstance

Returns:



456
457
458
 
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 456

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The friendly_name.

Returns:

  • (String) —

    The friendly_name



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



476
477
478
479
 
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 476

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

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



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

def links
  @properties['links']
end

#max_concurrent_participants ⇒ String

Returns The max_concurrent_participants.

Returns:

  • (String) —

    The max_concurrent_participants



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

def max_concurrent_participants
  @properties['max_concurrent_participants']
end

#max_participants ⇒ String

Returns The max_participants.

Returns:

  • (String) —

    The max_participants



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

def max_participants
  @properties['max_participants']
end

#mixer_region ⇒ conference.Region

Returns The mixer_region.

Returns:

  • (conference.Region) —

    The mixer_region



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

def mixer_region
  @properties['mixer_region']
end

#mixer_region_requested ⇒ conference.Region

Returns The mixer_region_requested.

Returns:

  • (conference.Region) —

    The mixer_region_requested



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

def mixer_region_requested
  @properties['mixer_region_requested']
end

#recording_enabled ⇒ Boolean

Returns The recording_enabled.

Returns:

  • (Boolean) —

    The recording_enabled



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

def recording_enabled
  @properties['recording_enabled']
end

#start_time ⇒ Time

Returns The start_time.

Returns:

  • (Time) —

    The start_time



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

def start_time
  @properties['start_time']
end

#status ⇒ conference.ConferenceStatus

Returns The status.

Returns:

  • (conference.ConferenceStatus) —

    The status



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

def status
  @properties['status']
end

#tag_info ⇒ Hash

Returns The tag_info.

Returns:

  • (Hash) —

    The tag_info



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

def tag_info
  @properties['tag_info']
end

#tags ⇒ Array[conference.Tag]

Returns The tags.

Returns:

  • (Array[conference.Tag]) —

    The tags



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

def tags
  @properties['tags']
end

#to_s ⇒ Object

Provide a user friendly representation



469
470
471
472
 
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 469

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

#unique_participants ⇒ String

Returns The unique_participants.

Returns:

  • (String) —

    The unique_participants



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

def unique_participants
  @properties['unique_participants']
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end