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



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
315
316
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 286

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



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

def 
  @properties['account_sid']
end

#attributes ⇒ String

Returns The attributes.

Returns:

  • (String) —

    The attributes



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

def attributes
  @properties['attributes']
end

#body ⇒ String

Returns The body.

Returns:

  • (String) —

    The body



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

def body
  @properties['body']
end

#channel_sid ⇒ String

Returns The channel_sid.

Returns:

  • (String) —

    The channel_sid



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

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:



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

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



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the MessageInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ MessageInstance

Fetch a MessageInstance

Returns:



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

def fetch
  context.fetch
end

#from ⇒ String

Returns The from.

Returns:

  • (String) —

    The from



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

def from
  @properties['from']
end

#index ⇒ String

Returns The index.

Returns:

  • (String) —

    The index



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

def index
  @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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



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

def last_updated_by
  @properties['last_updated_by']
end

#media ⇒ Hash

Returns The media.

Returns:

  • (Hash) —

    The media



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

def media
  @properties['media']
end

#service_sid ⇒ String

Returns The service_sid.

Returns:

  • (String) —

    The service_sid



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#to ⇒ String

Returns The to.

Returns:

  • (String) —

    The to



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

def to
  @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

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:



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

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



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

def url
  @properties['url']
end

#was_edited ⇒ Boolean

Returns The was_edited.

Returns:

  • (Boolean) —

    The was_edited



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

def was_edited
  @properties['was_edited']
end