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

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Api::V2010::AccountContext::ConferenceInstance

Defined in:

lib/twilio-ruby/rest/api/v2010/account/conference.rb

Instance Method Summary

• #account_sid ⇒ String

  The SID of the Account that created this resource.

• #api_version ⇒ String

  The API version used to create this conference.

• #call_sid_ending_conference ⇒ String

  The call SID that caused the conference to end.

• #context ⇒ ConferenceContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #date_created ⇒ Time

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

• #date_updated ⇒ Time

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

• #fetch ⇒ ConferenceInstance

  Fetch the ConferenceInstance.

• #friendly_name ⇒ String

  A string that you assigned to describe this conference room.

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

  Initialize the ConferenceInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #participants ⇒ participants

  Access the participants.

• #reason_conference_ended ⇒ conference.ReasonConferenceEnded

  The reason why a conference ended.

• #recordings ⇒ recordings

  Access the recordings.

• #region ⇒ String

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

• #sid ⇒ String

  The unique string that identifies this resource.

• #status ⇒ conference.Status

  The status of this conference.

• #subresource_uris ⇒ String

  A list of related resources identified by their relative URIs.

• #to_s ⇒ Object

  Provide a user friendly representation.

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

  Update the ConferenceInstance.

• #uri ⇒ String

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

Constructor Details

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

Initialize the ConferenceInstance

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

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'],
      'reason_conference_ended' => payload['reason_conference_ended'],
      'call_sid_ending_conference' => payload['call_sid_ending_conference'],
  }

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

Instance Method Details

#account_sid ⇒ String

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

def account_sid
  @properties['account_sid']
end

#api_version ⇒ String

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

def api_version
  @properties['api_version']
end

#call_sid_ending_conference ⇒ String

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

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

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

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

#date_created ⇒ Time

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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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

def date_updated
  @properties['date_updated']
end

#fetch ⇒ ConferenceInstance

Fetch the ConferenceInstance

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

def fetch
  context.fetch
end

#friendly_name ⇒ String

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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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

#participants ⇒ participants

Access the participants

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

def participants
  context.participants
end

#reason_conference_ended ⇒ conference.ReasonConferenceEnded

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

def reason_conference_ended
  @properties['reason_conference_ended']
end

#recordings ⇒ recordings

Access the recordings

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

def recordings
  context.recordings
end

#region ⇒ String

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

def region
  @properties['region']
end

#sid ⇒ String

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

def sid
  @properties['sid']
end

#status ⇒ conference.Status

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

def status
  @properties['status']
end

#subresource_uris ⇒ String

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

def subresource_uris
  @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

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

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

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

def uri
  @properties['uri']
end