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 SID of the [Account](www.twilio.com/docs/api/rest/account) that created this Conference resource.

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

    The Twilio-provided string that uniquely identifies the Conference resource to fetch



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 351

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 SID of the Account that created this resource.

Returns:

  • (String) —

    The SID of the Account that created this resource



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

def 
  @properties['account_sid']
end

#api_version ⇒ String

Returns The API version used to create this conference.

Returns:

  • (String) —

    The API version used to create this conference



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

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:



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

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

#date_created ⇒ Time

Returns The RFC 2822 date and time in GMT that this resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT that this resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT that this resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT that this resource was last updated



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

def date_updated
  @properties['date_updated']
end

#fetch ⇒ ConferenceInstance

Fetch a ConferenceInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns A string that you assigned to describe this conference room.

Returns:

  • (String) —

    A string that you assigned to describe this conference room



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



489
490
491
492
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 489

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

#participants ⇒ participants

Access the participants

Returns:



469
470
471
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 469

def participants
  context.participants
end

#recordings ⇒ recordings

Access the recordings

Returns:



476
477
478
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 476

def recordings
  context.recordings
end

#region ⇒ String

Returns A string that represents the Twilio Region where the conference was mixed.

Returns:

  • (String) —

    A string that represents the Twilio Region where the conference was mixed



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

def region
  @properties['region']
end

#sid ⇒ String

Returns The unique string that identifies this resource.

Returns:

  • (String) —

    The unique string that identifies this resource



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

def sid
  @properties['sid']
end

#status ⇒ conference.Status

Returns The status of this conference.

Returns:

  • (conference.Status) —

    The status of this conference



428
429
430
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 428

def status
  @properties['status']
end

#subresource_uris ⇒ String

Returns A list of related resources identified by their relative URIs.

Returns:

  • (String) —

    A list of related resources identified by their relative URIs



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

def subresource_uris
  @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation



482
483
484
485
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 482

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

#update(status: :unset, announce_url: :unset, announce_method: :unset) ⇒ ConferenceInstance

Update the ConferenceInstance

Parameters:

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

    The new status of the resource. Can be: Can be: ‘init`, `in-progress`, or `completed`. Specifying `completed` will end the conference and hang up all participants

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

    The URL we should call to announce something into the conference. The URL can return an MP3, a WAV, or a TwiML document with ‘<Play>` or `<Say>`.

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

    The HTTP method used to call ‘announce_url`. Can be: `GET` or `POST` and the default is `POST`

Returns:



462
463
464
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 462

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

#uri ⇒ String

Returns The URI of this resource, relative to ‘api.twilio.com`.

Returns:

  • (String) —

    The URI of this resource, relative to ‘api.twilio.com`



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

def uri
  @properties['uri']
end