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 the Message resource is associated with.

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

    The SID of the Channel the Message resource belongs to.

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

    The SID of the Message resource to fetch.


330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 330

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


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

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


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

def attributes
  @properties['attributes']
end

#body ⇒ String

Returns The content of the message.

Returns:

  • (String) —

    The content of the message


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

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


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

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:


366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 366

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


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

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


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

def date_updated
  @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the MessageInstance

Parameters:

  • x_twilio_webhook_enabled (message.WebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


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

def delete(x_twilio_webhook_enabled: :unset)
  context.delete(x_twilio_webhook_enabled: x_twilio_webhook_enabled, )
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance

Returns:


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

def fetch
  context.fetch
end

#from ⇒ String

Returns The Identity of the message's author.

Returns:

  • (String) —

    The Identity of the message's author


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

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


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

def index
  @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


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

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


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

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


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

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


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

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


380
381
382
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 380

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


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

def to
  @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation


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

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


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

def type
  @properties['type']
end

#update(body: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, last_updated_by: :unset, from: :unset, x_twilio_webhook_enabled: :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 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 format, to assign to the resource as the date it was last updated.

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

    The Identity of the User who last updated the Message, if applicable.

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

    The Identity of the message's author.

  • x_twilio_webhook_enabled (message.WebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:


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

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

#url ⇒ String

Returns The absolute URL of the Message resource.

Returns:

  • (String) —

    The absolute URL of the Message resource


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

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


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

def was_edited
  @properties['was_edited']
end