Class: Twilio::REST::Conversations::V1::ConversationContext::MessageInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/conversation/message.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the MessageInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The unique ID of the Conversation for this message.

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

    A 34 character string that uniquely identifies this resource.



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 322

def initialize(version, payload, conversation_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'conversation_sid' => payload['conversation_sid'],
      'sid' => payload['sid'],
      'index' => payload['index'] == nil ? payload['index'] : payload['index'].to_i,
      'author' => payload['author'],
      'body' => payload['body'],
      'media' => payload['media'],
      'attributes' => payload['attributes'],
      'participant_sid' => payload['participant_sid'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
      'delivery' => payload['delivery'],
      'links' => payload['links'],
      'content_sid' => payload['content_sid'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The unique ID of the Account responsible for this message.

Returns:

  • (String) —

    The unique ID of the Account responsible for this message.



362
363
364
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 362

def 
  @properties['account_sid']
end

#attributes ⇒ String

Returns A string metadata field you can use to store any data you wish.

Returns:

  • (String) —

    A string metadata field you can use to store any data you wish.



404
405
406
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 404

def attributes
  @properties['attributes']
end

#author ⇒ String

Returns The channel specific identifier of the message’s author.

Returns:

  • (String) —

    The channel specific identifier of the message’s author.



386
387
388
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 386

def author
  @properties['author']
end

#body ⇒ String

Returns The content of the message.

Returns:

  • (String) —

    The content of the message.



392
393
394
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 392

def body
  @properties['body']
end

#content_sid ⇒ String

Returns The unique ID of the multi-channel Rich Content template.

Returns:

  • (String) —

    The unique ID of the multi-channel Rich Content template.



446
447
448
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 446

def content_sid
  @properties['content_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:



353
354
355
356
357
358
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 353

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

#conversation_sid ⇒ String

Returns The unique ID of the Conversation for this message.

Returns:

  • (String) —

    The unique ID of the Conversation for this message.



368
369
370
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 368

def conversation_sid
  @properties['conversation_sid']
end

#date_created ⇒ Time

Returns The date that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created.



416
417
418
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 416

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated.



422
423
424
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/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



481
482
483
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 481

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

#delivery ⇒ Hash

Returns An object that contains the summary of delivery statuses for the message to non-chat participants.

Returns:

  • (Hash) —

    An object that contains the summary of delivery statuses for the message to non-chat participants.



434
435
436
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 434

def delivery
  @properties['delivery']
end

#delivery_receipts ⇒ delivery_receipts

Access the delivery_receipts

Returns:



495
496
497
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 495

def delivery_receipts
  context.delivery_receipts
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance

Returns:



488
489
490
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 488

def fetch
  context.fetch
end

#index ⇒ String

Returns The index of the message within the Conversation.

Returns:

  • (String) —

    The index of the message within the Conversation.



380
381
382
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 380

def index
  @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



508
509
510
511
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 508

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

#links ⇒ String

Returns Absolute URL to access the receipts of this message.

Returns:

  • (String) —

    Absolute URL to access the receipts of this message.



440
441
442
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 440

def links
  @properties['links']
end

#media ⇒ Array[Hash]

Returns An array of objects that describe the Message’s media if attached, otherwise, null.

Returns:

  • (Array[Hash]) —

    An array of objects that describe the Message’s media if attached, otherwise, null.



398
399
400
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 398

def media
  @properties['media']
end

#participant_sid ⇒ String

Returns The unique ID of messages’s author participant.

Returns:

  • (String) —

    The unique ID of messages’s author participant.



410
411
412
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 410

def participant_sid
  @properties['participant_sid']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



374
375
376
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 374

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



501
502
503
504
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 501

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

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

Update the MessageInstance

Parameters:

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

    The channel specific identifier of the message’s author. Defaults to ‘system`.

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

    The content of the message, can be up to 1,600 characters long.

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

    The date that this resource was created.

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

    The date that this resource was last updated. ‘null` if the message has not been edited.

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

    A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set “{}” will be returned.

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

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:



465
466
467
468
469
470
471
472
473
474
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 465

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

#url ⇒ String

Returns An absolute API URL for this message.

Returns:

  • (String) —

    An absolute API URL for this message.



428
429
430
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 428

def url
  @properties['url']
end