Class: Twilio::REST::Insights::V1::RoomInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, room_sid: nil) ⇒ RoomInstance

Initialize the RoomInstance

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 Room resource.

  • sid (String) —

    The SID of the Call resource to fetch.



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 262

def initialize(version, payload , room_sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'room_sid' => payload['room_sid'],
        'room_name' => payload['room_name'],
        'create_time' => Twilio.deserialize_iso8601_datetime(payload['create_time']),
        'end_time' => Twilio.deserialize_iso8601_datetime(payload['end_time']),
        'room_type' => payload['room_type'],
        'room_status' => payload['room_status'],
        'status_callback' => payload['status_callback'],
        'status_callback_method' => payload['status_callback_method'],
        'created_method' => payload['created_method'],
        'end_reason' => payload['end_reason'],
        'max_participants' => payload['max_participants'] == nil ? payload['max_participants'] : payload['max_participants'].to_i,
        'unique_participants' => payload['unique_participants'] == nil ? payload['unique_participants'] : payload['unique_participants'].to_i,
        'unique_participant_identities' => payload['unique_participant_identities'] == nil ? payload['unique_participant_identities'] : payload['unique_participant_identities'].to_i,
        'concurrent_participants' => payload['concurrent_participants'] == nil ? payload['concurrent_participants'] : payload['concurrent_participants'].to_i,
        'max_concurrent_participants' => payload['max_concurrent_participants'] == nil ? payload['max_concurrent_participants'] : payload['max_concurrent_participants'].to_i,
        'codecs' => payload['codecs'],
        'media_region' => payload['media_region'],
        'duration_sec' => payload['duration_sec'],
        'total_participant_duration_sec' => payload['total_participant_duration_sec'],
        'total_recording_duration_sec' => payload['total_recording_duration_sec'],
        'processing_state' => payload['processing_state'],
        'recording_enabled' => payload['recording_enabled'],
        'edge_location' => payload['edge_location'],
        'url' => payload['url'],
        'links' => payload['links'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns Account SID associated with this room.

Returns:

  • (String) —

    Account SID associated with this room.



313
314
315
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 313

def 
    @properties['account_sid']
end

#codecs ⇒ Array<Codec>

Returns Codecs used by participants in the room. Can be ‘VP8`, `H264`, or `VP9`.

Returns:

  • (Array<Codec>) —

    Codecs used by participants in the room. Can be ‘VP8`, `H264`, or `VP9`.



409
410
411
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 409

def codecs
    @properties['codecs']
end

#concurrent_participants ⇒ String

Returns Actual number of concurrent participants.

Returns:

  • (String) —

    Actual number of concurrent participants.



397
398
399
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 397

def concurrent_participants
    @properties['concurrent_participants']
end

#context ⇒ RoomContext

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

Returns:



304
305
306
307
308
309
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 304

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

#create_time ⇒ Time

Returns Creation time of the room.

Returns:

  • (Time) —

    Creation time of the room.



331
332
333
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 331

def create_time
    @properties['create_time']
end

#created_method ⇒ CreatedMethod

Returns:

  • (CreatedMethod) 


367
368
369
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 367

def created_method
    @properties['created_method']
end

#duration_sec ⇒ String

Returns Total room duration from create time to end time.

Returns:

  • (String) —

    Total room duration from create time to end time.



421
422
423
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 421

def duration_sec
    @properties['duration_sec']
end

#edge_location ⇒ EdgeLocation

Returns:

  • (EdgeLocation) 


451
452
453
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 451

def edge_location
    @properties['edge_location']
end

#end_reason ⇒ EndReason

Returns:

  • (EndReason) 


373
374
375
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 373

def end_reason
    @properties['end_reason']
end

#end_time ⇒ Time

Returns End time for the room.

Returns:

  • (Time) —

    End time for the room.



337
338
339
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 337

def end_time
    @properties['end_time']
end

#fetch ⇒ RoomInstance

Fetch the RoomInstance

Returns:



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



491
492
493
494
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 491

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

#links ⇒ Hash

Returns Room subresources.

Returns:

  • (Hash) —

    Room subresources.



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

def links
    @properties['links']
end

#max_concurrent_participants ⇒ String

Returns Maximum number of participants allowed in the room at the same time allowed by the application settings.

Returns:

  • (String) —

    Maximum number of participants allowed in the room at the same time allowed by the application settings.



403
404
405
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 403

def max_concurrent_participants
    @properties['max_concurrent_participants']
end

#max_participants ⇒ String

Returns Max number of total participants allowed by the application settings.

Returns:

  • (String) —

    Max number of total participants allowed by the application settings.



379
380
381
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 379

def max_participants
    @properties['max_participants']
end

#media_region ⇒ TwilioRealm

Returns:

  • (TwilioRealm) 


415
416
417
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 415

def media_region
    @properties['media_region']
end

#participants ⇒ participants

Access the participants

Returns:



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

def participants
    context.participants
end

#processing_state ⇒ ProcessingState

Returns:

  • (ProcessingState) 


439
440
441
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 439

def processing_state
    @properties['processing_state']
end

#recording_enabled ⇒ Boolean

Returns Boolean indicating if recording is enabled for the room.

Returns:

  • (Boolean) —

    Boolean indicating if recording is enabled for the room.



445
446
447
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 445

def recording_enabled
    @properties['recording_enabled']
end

#room_name ⇒ String

Returns Room friendly name.

Returns:

  • (String) —

    Room friendly name.



325
326
327
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 325

def room_name
    @properties['room_name']
end

#room_sid ⇒ String

Returns Unique identifier for the room.

Returns:

  • (String) —

    Unique identifier for the room.



319
320
321
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 319

def room_sid
    @properties['room_sid']
end

#room_status ⇒ RoomStatus

Returns:

  • (RoomStatus) 


349
350
351
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 349

def room_status
    @properties['room_status']
end

#room_type ⇒ RoomType

Returns:

  • (RoomType) 


343
344
345
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 343

def room_type
    @properties['room_type']
end

#status_callback ⇒ String

Returns Webhook provided for status callbacks.

Returns:

  • (String) —

    Webhook provided for status callbacks.



355
356
357
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 355

def status_callback
    @properties['status_callback']
end

#status_callback_method ⇒ String

Returns HTTP method provided for status callback URL.

Returns:

  • (String) —

    HTTP method provided for status callback URL.



361
362
363
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 361

def status_callback_method
    @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



484
485
486
487
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 484

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

#total_participant_duration_sec ⇒ String

Returns Combined amount of participant time in the room.

Returns:

  • (String) —

    Combined amount of participant time in the room.



427
428
429
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 427

def total_participant_duration_sec
    @properties['total_participant_duration_sec']
end

#total_recording_duration_sec ⇒ String

Returns Combined amount of recorded seconds for participants in the room.

Returns:

  • (String) —

    Combined amount of recorded seconds for participants in the room.



433
434
435
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 433

def total_recording_duration_sec
    @properties['total_recording_duration_sec']
end

#unique_participant_identities ⇒ String

Returns Unique number of participant identities.

Returns:

  • (String) —

    Unique number of participant identities.



391
392
393
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 391

def unique_participant_identities
    @properties['unique_participant_identities']
end

#unique_participants ⇒ String

Returns Number of participants. May include duplicate identities for participants who left and rejoined.

Returns:

  • (String) —

    Number of participants. May include duplicate identities for participants who left and rejoined.



385
386
387
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 385

def unique_participants
    @properties['unique_participants']
end

#url ⇒ String

Returns URL for the room resource.

Returns:

  • (String) —

    URL for the room resource.



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

def url
    @properties['url']
end