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

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

Defined Under Namespace

Classes: FeedbackInstance, FeedbackList, FeedbackPage, MediaContext, MediaInstance, MediaList, MediaPage

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, sid) ⇒ MessageContext

Initialize the MessageContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) —

    The account_sid

  • sid (String) —

    The message Sid that uniquely identifies this resource



250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 250

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

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

  # Dependents
  @media = nil
  @feedback = nil
end

Instance Method Details

#delete ⇒ Boolean

Deletes the MessageInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  @version.delete('delete', @uri)
end

#feedback ⇒ FeedbackList, FeedbackContext

Access the feedback

Returns:



346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 346

def feedback
  unless @feedback
    @feedback = FeedbackList.new(
        @version,
        account_sid: @solution[:account_sid],
        message_sid: @solution[:sid],
    )
  end

  @feedback
end

#fetch ⇒ MessageInstance

Fetch a MessageInstance

Returns:



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 275

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  MessageInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      sid: @solution[:sid],
  )
end

#media(sid = :unset) ⇒ MediaList, MediaContext

Access the media

Returns:

Raises:

  • (ArgumentError) 


319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 319

def media(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return MediaContext.new(
        @version,
        @solution[:account_sid],
        @solution[:sid],
        sid,
    )
  end

  unless @media
    @media = MediaList.new(
        @version,
        account_sid: @solution[:account_sid],
        message_sid: @solution[:sid],
    )
  end

  @media
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#update(body: nil) ⇒ MessageInstance

Update the MessageInstance

Parameters:

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

    The body

Returns:



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 296

def update(body: nil)
  data = Twilio::Values.of({
      'Body' => body,
  })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  MessageInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      sid: @solution[:sid],
  )
end