Class: Twilio::REST::Api::V2010::AccountContext::ConferenceContext::RecordingInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Api::V2010::AccountContext::ConferenceContext::RecordingInstance

Defined in:

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

Instance Method Summary

• #account_sid ⇒ String

  The SID of the Account that created the resource.

• #api_version ⇒ String

  The API version used to create the recording.

• #call_sid ⇒ String

  The SID of the Call the resource is associated with.

• #channels ⇒ String

  The number of channels in the final recording file as an integer.

• #conference_sid ⇒ String

  The Conference SID that identifies the conference associated with the recording.

• #context ⇒ RecordingContext

  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 the resource was created.

• #date_updated ⇒ Time

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

• #delete ⇒ Boolean

  Delete the RecordingInstance.

• #duration ⇒ String

  The length of the recording in seconds.

• #encryption_details ⇒ Hash

  How to decrypt the recording.

• #error_code ⇒ String

  More information about why the recording is missing, if status is ‘absent`.

• #fetch ⇒ RecordingInstance

  Fetch the RecordingInstance.

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

  Initialize the RecordingInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #price ⇒ String

  The one-time cost of creating the recording.

• #price_unit ⇒ String

  The currency used in the price property.

• #sid ⇒ String

  The unique string that identifies the resource.

• #source ⇒ recording.Source

  How the recording was created.

• #start_time ⇒ Time

  The start time of the recording, given in RFC 2822 format.

• #status ⇒ recording.Status

  The status of the recording.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #update(status: nil, pause_behavior: :unset) ⇒ RecordingInstance

  Update the RecordingInstance.

• #uri ⇒ String

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

Constructor Details

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

Initialize the RecordingInstance

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

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

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'api_version' => payload['api_version'],
      'call_sid' => payload['call_sid'],
      'conference_sid' => payload['conference_sid'],
      'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
      'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
      'start_time' => Twilio.deserialize_rfc2822(payload['start_time']),
      'duration' => payload['duration'],
      'sid' => payload['sid'],
      'price' => payload['price'],
      'price_unit' => payload['price_unit'],
      'status' => payload['status'],
      'channels' => payload['channels'].to_i,
      'source' => payload['source'],
      'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
      'encryption_details' => payload['encryption_details'],
      'uri' => payload['uri'],
  }

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

Instance Method Details

#account_sid ⇒ String

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

def account_sid
  @properties['account_sid']
end

#api_version ⇒ String

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

def api_version
  @properties['api_version']
end

#call_sid ⇒ String

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

def call_sid
  @properties['call_sid']
end

#channels ⇒ String

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

def channels
  @properties['channels']
end

#conference_sid ⇒ String

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

def conference_sid
  @properties['conference_sid']
end

#context ⇒ RecordingContext

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/recording.rb', line 308

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

#date_created ⇒ Time

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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RecordingInstance

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

def delete
  context.delete
end

#duration ⇒ String

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

def duration
  @properties['duration']
end

#encryption_details ⇒ Hash

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

def encryption_details
  @properties['encryption_details']
end

#error_code ⇒ String

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

def error_code
  @properties['error_code']
end

#fetch ⇒ RecordingInstance

Fetch the RecordingInstance

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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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

#price ⇒ String

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

def price
  @properties['price']
end

#price_unit ⇒ String

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

def price_unit
  @properties['price_unit']
end

#sid ⇒ String

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

def sid
  @properties['sid']
end

#source ⇒ recording.Source

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

def source
  @properties['source']
end

#start_time ⇒ Time

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

def start_time
  @properties['start_time']
end

#status ⇒ recording.Status

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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

#update(status: nil, pause_behavior: :unset) ⇒ RecordingInstance

Update the RecordingInstance

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

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

#uri ⇒ String

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

def uri
  @properties['uri']
end