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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/chat/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 resource is associated with.

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

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

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

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



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
368
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 338

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



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

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



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

def attributes
  @properties['attributes']
end

#body ⇒ String

Returns The content of the message.

Returns:

  • (String) —

    The content of the message



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

def body
  @properties['body']
end

#channel_sid ⇒ String

Returns The unique ID of the Channel the Message resource belongs to.

Returns:

  • (String) —

    The unique ID of the Channel the Message resource belongs to



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

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:



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

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



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the MessageInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ MessageInstance

Fetch a MessageInstance

Returns:



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

def fetch
  context.fetch
end

#from ⇒ String

Returns The identity of the message’s author.

Returns:

  • (String) —

    The identity of the message’s author



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

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



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

def index
  @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Chat.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



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

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



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

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



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

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



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

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



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

def to
  @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#type ⇒ String

Returns The Message type.

Returns:

  • (String) —

    The Message type



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

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 also 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.

  • 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:



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

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



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

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



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

def was_edited
  @properties['was_edited']
end