Class: Twilio::REST::Api::V2010::AccountContext::MessageContext::MediaInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the MediaInstance

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 Media resource.

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

    The unique string that that we created to identify the Message resource.

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

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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 255

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

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'content_type' => payload['content_type'],
      'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
      'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
      'parent_sid' => payload['parent_sid'],
      'sid' => payload['sid'],
      'uri' => payload['uri'],
  }

  # Context
  @instance_context = nil
  @params = {
      'account_sid' => ,
      'message_sid' => message_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



296
297
298
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 296

def 
  @properties['account_sid']
end

#content_type ⇒ String

Returns The default mime-type of the media.

Returns:

  • (String) —

    The default mime-type of the media



302
303
304
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 302

def content_type
  @properties['content_type']
end

#context ⇒ MediaContext

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

Returns:



282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 282

def context
  unless @instance_context
    @instance_context = MediaContext.new(
        @version,
        @params['account_sid'],
        @params['message_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



308
309
310
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 308

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



314
315
316
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 314

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the MediaInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



339
340
341
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 339

def delete
  context.delete
end

#fetch ⇒ MediaInstance

Fetch a MediaInstance

Returns:



346
347
348
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 346

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



359
360
361
362
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 359

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

#parent_sid ⇒ String

Returns The SID of the resource that created the media.

Returns:

  • (String) —

    The SID of the resource that created the media



320
321
322
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 320

def parent_sid
  @properties['parent_sid']
end

#sid ⇒ String

Returns The unique string that identifies this resource.

Returns:

  • (String) —

    The unique string that identifies this resource



326
327
328
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 326

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



352
353
354
355
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 352

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.MediaInstance #{values}>"
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`



332
333
334
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 332

def uri
  @properties['uri']
end