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 SID of the [Service](www.twilio.com/docs/chat/rest/services) the Message resource is associated with.

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

    The SID of the [Channel](www.twilio.com/docs/chat/channels) the Message resource belongs to.

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

    The SID of the Message resource to fetch.



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 337

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 SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

def 
  @properties['account_sid']
end

#attributes ⇒ String

Returns The JSON string that stores application-specific data.

Returns:

  • (String) —

    The JSON string that stores application-specific data



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

def attributes
  @properties['attributes']
end

#body ⇒ String

Returns The content of the message.

Returns:

  • (String) —

    The content of the message



453
454
455
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 453

def body
  @properties['body']
end

#channel_sid ⇒ String

Returns The SID of the Channel the Message resource belongs to.

Returns:

  • (String) —

    The SID of the Channel the Message resource belongs to



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

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:



373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 373

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 RFC 2822 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the MessageInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



491
492
493
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 491

def delete
  context.delete
end

#fetch ⇒ MessageInstance

Fetch a MessageInstance

Returns:



484
485
486
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 484

def fetch
  context.fetch
end

#from ⇒ String

Returns The Identity of the message’s author.

Returns:

  • (String) —

    The Identity of the message’s author



447
448
449
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 447

def from
  @properties['from']
end

#index ⇒ String

Returns The index of the message within the Channel.

Returns:

  • (String) —

    The index of the message within the Channel



459
460
461
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 459

def index
  @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



536
537
538
539
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 536

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

#last_updated_by ⇒ String

Returns The Identity of the User who last updated the Message.

Returns:

  • (String) —

    The Identity of the User who last updated the Message



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

def last_updated_by
  @properties['last_updated_by']
end

#media ⇒ Hash

Returns A Media object that describes the Message’s media if attached; otherwise, null.

Returns:

  • (Hash) —

    A Media object that describes the Message’s media if attached; otherwise, null



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

def media
  @properties['media']
end

#service_sid ⇒ String

Returns The SID of the Service that the resource is associated with.

Returns:

  • (String) —

    The SID of the Service that the resource is associated with



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#to ⇒ String

Returns The SID of the Channel that the message was sent to.

Returns:

  • (String) —

    The SID of the Channel that the message was sent to



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

def to
  @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



529
530
531
532
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 529

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

#type ⇒ String

Returns The Message type.

Returns:

  • (String) —

    The Message type



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

def type
  @properties['type']
end

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

Update the MessageInstance

Parameters:

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

    The message to send to the channel. Can be an empty string or ‘null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string.

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

    A valid JSON string that contains application-specific data.

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

    The date, specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. This parameter should only be used when a Chat’s history is being recreated from a backup/separate source.

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

    The date, specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated.

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

    The [Identity](www.twilio.com/docs/chat/identity) of the User who last updated the Message, if applicable.

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

    The [Identity](www.twilio.com/docs/chat/identity) of the message’s author.

Returns:



516
517
518
519
520
521
522
523
524
525
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 516

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

#url ⇒ String

Returns The absolute URL of the Message resource.

Returns:

  • (String) —

    The absolute URL of the Message resource



477
478
479
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 477

def url
  @properties['url']
end

#was_edited ⇒ Boolean

Returns Whether the message has been edited since it was created.

Returns:

  • (Boolean) —

    Whether the message has been edited since it was created



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

def was_edited
  @properties['was_edited']
end