Class: Twilio::REST::Media::V1::MediaProcessorInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/media/v1/media_processor.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ MediaProcessorInstance

Initialize the MediaProcessorInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The SID of the MediaProcessor resource to fetch.



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 251

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

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'sid' => payload['sid'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'extension' => payload['extension'],
      'extension_context' => payload['extension_context'],
      'status' => payload['status'],
      'url' => payload['url'],
      'ended_reason' => payload['ended_reason'],
      'status_callback' => payload['status_callback'],
      'status_callback_method' => payload['status_callback_method'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



287
288
289
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 287

def 
  @properties['account_sid']
end

#context ⇒ MediaProcessorContext

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

Returns:



278
279
280
281
282
283
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 278

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

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



299
300
301
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 299

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated



305
306
307
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 305

def date_updated
  @properties['date_updated']
end

#ended_reason ⇒ String

Returns The reason why a MediaProcessor ended.

Returns:

  • (String) —

    The reason why a MediaProcessor ended



335
336
337
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 335

def ended_reason
  @properties['ended_reason']
end

#extension ⇒ String

Returns The Media Extension name or URL.

Returns:

  • (String) —

    The Media Extension name or URL



311
312
313
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 311

def extension
  @properties['extension']
end

#extension_context ⇒ String

Returns The Media Extension context.

Returns:

  • (String) —

    The Media Extension context



317
318
319
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 317

def extension_context
  @properties['extension_context']
end

#fetch ⇒ MediaProcessorInstance

Fetch the MediaProcessorInstance

Returns:



354
355
356
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 354

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



376
377
378
379
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 376

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

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



293
294
295
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 293

def sid
  @properties['sid']
end

#status ⇒ media_processor.Status

Returns The status of the MediaProcessor.

Returns:



323
324
325
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 323

def status
  @properties['status']
end

#status_callback ⇒ String

Returns The URL to which Twilio will send MediaProcessor event updates.

Returns:

  • (String) —

    The URL to which Twilio will send MediaProcessor event updates



341
342
343
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 341

def status_callback
  @properties['status_callback']
end

#status_callback_method ⇒ String

Returns The HTTP method Twilio should use to call the ‘status_callback` URL.

Returns:

  • (String) —

    The HTTP method Twilio should use to call the ‘status_callback` URL



347
348
349
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 347

def status_callback_method
  @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



369
370
371
372
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 369

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

#update(status: nil) ⇒ MediaProcessorInstance

Update the MediaProcessorInstance

Parameters:

  • status (media_processor.UpdateStatus) (defaults to: nil) —

    The status of the MediaProcessor. Can be ‘ended`.

Returns:



363
364
365
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 363

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

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource



329
330
331
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 329

def url
  @properties['url']
end