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.

  • 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


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 247

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


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

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


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

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:


274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 274

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


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

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


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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the MediaInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#fetch ⇒ MediaInstance

Fetch the MediaInstance

Returns:


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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


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

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


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

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


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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation


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

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:


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

def uri
  @properties['uri']
end