Class: Twilio::REST::Api::V2010::AccountContext::ConferenceInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/conference.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, sid: nil) ⇒ ConferenceInstance

Initialize the ConferenceInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The unique id of the Account] responsible for creating this conference.

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

    The conference Sid that uniquely identifies this resource



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 320

def initialize(version, payload, account_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
      'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
      'api_version' => payload['api_version'],
      'friendly_name' => payload['friendly_name'],
      'region' => payload['region'],
      'sid' => payload['sid'],
      'status' => payload['status'],
      'uri' => payload['uri'],
      'subresource_uris' => payload['subresource_uris'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The unique sid that identifies this account.

Returns:

  • (String) —

    The unique sid that identifies this account



362
363
364
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 362

def 
  @properties['account_sid']
end

#api_version ⇒ String

Returns The api_version.

Returns:

  • (String) —

    The api_version



380
381
382
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 380

def api_version
  @properties['api_version']
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:



349
350
351
352
353
354
355
356
357
358
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 349

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

#date_created ⇒ Time

Returns The date this resource was created.

Returns:

  • (Time) —

    The date this resource was created



368
369
370
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 368

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this resource was last updated.

Returns:

  • (Time) —

    The date this resource was last updated



374
375
376
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 374

def date_updated
  @properties['date_updated']
end

#fetch ⇒ ConferenceInstance

Fetch a ConferenceInstance

Returns:



423
424
425
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 423

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns A human readable description of this resource.

Returns:

  • (String) —

    A human readable description of this resource



386
387
388
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 386

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



453
454
455
456
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 453

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

#participants ⇒ participants

Access the participants

Returns:



440
441
442
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 440

def participants
  context.participants
end

#region ⇒ String

Returns The region.

Returns:

  • (String) —

    The region



392
393
394
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 392

def region
  @properties['region']
end

#sid ⇒ String

Returns A string that uniquely identifies this conference.

Returns:

  • (String) —

    A string that uniquely identifies this conference



398
399
400
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 398

def sid
  @properties['sid']
end

#status ⇒ participant.Status

Returns The status of the conference.

Returns:

  • (participant.Status) —

    The status of the conference



404
405
406
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 404

def status
  @properties['status']
end

#subresource_uris ⇒ String

Returns The subresource_uris.

Returns:

  • (String) —

    The subresource_uris



416
417
418
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 416

def subresource_uris
  @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation



446
447
448
449
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 446

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

#update(status: :unset) ⇒ ConferenceInstance

Update the ConferenceInstance

Parameters:

  • status (conference.UpdateStatus) (defaults to: :unset) —

    The status

Returns:



431
432
433
434
435
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 431

def update(status: :unset)
  context.update(
      status: status,
  )
end

#uri ⇒ String

Returns The URI for this resource.

Returns:

  • (String) —

    The URI for this resource



410
411
412
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 410

def uri
  @properties['uri']
end