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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, message_sid, sid) ⇒ MediaContext

Initialize the MediaContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) —

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

  • message_sid (String) —

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

  • sid (String) —

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



188
189
190
191
192
193
194
195
196
197
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 188

def initialize(version, , message_sid, sid)
    super(version)
    

    # Path Solution
    @solution = { account_sid: , message_sid: message_sid, sid: sid,  }
    @uri = "/Accounts/#{@solution[:account_sid]}/Messages/#{@solution[:message_sid]}/Media/#{@solution[:sid]}.json"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the MediaInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



201
202
203
204
205
206
207
208
209
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 201

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

    @version.delete('DELETE', @uri, headers: headers)
end

#delete_with_metadata ⇒ Boolean

Delete the MediaInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 214

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      media_instance = MediaInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      MediaInstanceMetadata.new(@version, media_instance, response.headers, response.status_code)
end

#fetch ⇒ MediaInstance

Fetch the MediaInstance

Returns:



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 233

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    MediaInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
        message_sid: @solution[:message_sid],
        sid: @solution[:sid],
    )
end

#fetch_with_metadata ⇒ MediaInstance

Fetch the MediaInstanceMetadata

Returns:



254
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 254

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    media_instance = MediaInstance.new(
        @version,
        response.body,
        account_sid: @solution[:account_sid],
        message_sid: @solution[:message_sid],
        sid: @solution[:sid],
    )
    MediaInstanceMetadata.new(
        @version,
        media_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Api.V2010.MediaContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



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

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Api.V2010.MediaContext #{context}>"
end