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 that created this Media resource.

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

    The SID of the Call resource to fetch.



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 244

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  || @properties['message_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) associated with this Media resource.

Returns:



276
277
278
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 276

def 
    @properties['account_sid']
end

#content_type ⇒ String

Returns The default [MIME type](en.wikipedia.org/wiki/Internet_media_type) of the media, for example ‘image/jpeg`, `image/png`, or `image/gif`.

Returns:



282
283
284
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 282

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:



267
268
269
270
271
272
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 267

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 date and time in GMT when this Media resource was created, specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



288
289
290
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 288

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when this Media resource was last updated, specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:

  • (Time) —

    The date and time in GMT when this Media resource was last updated, specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the MediaInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ MediaInstance

Fetch the MediaInstance

Returns:



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



341
342
343
344
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 341

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

#parent_sid ⇒ String

Returns The SID of the Message resource that is associated with this Media resource.

Returns:

  • (String) —

    The SID of the Message resource that is associated with this Media resource.



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

def parent_sid
    @properties['parent_sid']
end

#sid ⇒ String

Returns The unique string that identifies this Media resource.

Returns:

  • (String) —

    The unique string that identifies this Media resource.



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



334
335
336
337
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 334

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

#uri ⇒ String

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

Returns:

  • (String) —

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



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

def uri
    @properties['uri']
end