Class: Twilio::REST::IpMessaging::V2::ServiceContext::ChannelContext::MessageInstance

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil) ⇒ MessageInstance

Initialize the MessageInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The service_sid

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

    The channel_sid

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

    The sid



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 284

def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'attributes' => payload['attributes'],
      'service_sid' => payload['service_sid'],
      'to' => payload['to'],
      'channel_sid' => payload['channel_sid'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'last_updated_by' => payload['last_updated_by'],
      'was_edited' => payload['was_edited'],
      'from' => payload['from'],
      'body' => payload['body'],
      'index' => payload['index'].to_i,
      'type' => payload['type'],
      'media' => payload['media'],
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {
      'service_sid' => service_sid,
      'channel_sid' => channel_sid,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



340
341
342
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 340

def 
  @properties['account_sid']
end

#attributes ⇒ String

Returns The attributes.

Returns:

  • (String) —

    The attributes



346
347
348
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 346

def attributes
  @properties['attributes']
end

#body ⇒ String

Returns The body.

Returns:

  • (String) —

    The body



400
401
402
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 400

def body
  @properties['body']
end

#channel_sid ⇒ String

Returns The channel_sid.

Returns:

  • (String) —

    The channel_sid



364
365
366
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 364

def channel_sid
  @properties['channel_sid']
end

#context ⇒ MessageContext

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

Returns:



320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 320

def context
  unless @instance_context
    @instance_context = MessageContext.new(
        @version,
        @params['service_sid'],
        @params['channel_sid'],
        @params['sid'],
    )
  end
  @instance_context
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



370
371
372
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 370

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



376
377
378
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 376

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the MessageInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



438
439
440
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 438

def delete
  context.delete
end

#fetch ⇒ MessageInstance

Fetch a MessageInstance

Returns:



431
432
433
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 431

def fetch
  context.fetch
end

#from ⇒ String

Returns The from.

Returns:

  • (String) —

    The from



394
395
396
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 394

def from
  @properties['from']
end

#index ⇒ String

Returns The index.

Returns:

  • (String) —

    The index



406
407
408
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 406

def index
  @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



469
470
471
472
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 469

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

#last_updated_by ⇒ String

Returns The last_updated_by.

Returns:

  • (String) —

    The last_updated_by



382
383
384
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 382

def last_updated_by
  @properties['last_updated_by']
end

#media ⇒ Hash

Returns The media.

Returns:

  • (Hash) —

    The media



418
419
420
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 418

def media
  @properties['media']
end

#service_sid ⇒ String

Returns The service_sid.

Returns:

  • (String) —

    The service_sid



352
353
354
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 352

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



334
335
336
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 334

def sid
  @properties['sid']
end

#to ⇒ String

Returns The to.

Returns:

  • (String) —

    The to



358
359
360
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 358

def to
  @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



462
463
464
465
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 462

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

#type ⇒ String

Returns The type.

Returns:

  • (String) —

    The type



412
413
414
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 412

def type
  @properties['type']
end

#update(body: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, last_updated_by: :unset) ⇒ MessageInstance

Update the MessageInstance

Parameters:

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

    The body

  • attributes (String) (defaults to: :unset) —

    The attributes

  • date_created (Time) (defaults to: :unset) —

    The date_created

  • date_updated (Time) (defaults to: :unset) —

    The date_updated

  • last_updated_by (String) (defaults to: :unset) —

    The last_updated_by

Returns:



450
451
452
453
454
455
456
457
458
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 450

def update(body: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, last_updated_by: :unset)
  context.update(
      body: body,
      attributes: attributes,
      date_created: date_created,
      date_updated: date_updated,
      last_updated_by: last_updated_by,
  )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



424
425
426
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 424

def url
  @properties['url']
end

#was_edited ⇒ Boolean

Returns The was_edited.

Returns:

  • (Boolean) —

    The was_edited



388
389
390
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 388

def was_edited
  @properties['was_edited']
end