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

  • account_sid (String) —

    The SID of the Account that created this Message resource.

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

    The SID of the Call resource to fetch.



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
361
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 336

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  || @properties['conversation_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique ID of the [Account](www.twilio.com/docs/iam/api/account) responsible for this message.

Returns:



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

def 
    @properties['account_sid']
end

#attributes ⇒ String

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

Returns:

  • (String) —

    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.



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

def attributes
    @properties['attributes']
end

#author ⇒ String

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

Returns:

  • (String) —

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



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

def author
    @properties['author']
end

#body ⇒ String

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

Returns:

  • (String) —

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



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

def body
    @properties['body']
end

#content_sid ⇒ String

Returns The unique ID of the multi-channel [Rich Content](www.twilio.com/docs/content-api) template.

Returns:



460
461
462
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 460

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:



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

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](www.twilio.com/docs/conversations/api/conversation-resource) for this message.

Returns:



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

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.



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

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

Returns:

  • (Time) —

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



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

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the MessageInstance

Parameters:

  • x_twilio_webhook_enabled (ConversationMessageEnumWebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

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.



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

def delivery
    @properties['delivery']
end

#delivery_receipts ⇒ delivery_receipts

Access the delivery_receipts

Returns:



519
520
521
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 519

def delivery_receipts
    context.delivery_receipts
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance

Returns:



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

def fetch

    context.fetch
end

#index ⇒ String

Returns The index of the message within the [Conversation](www.twilio.com/docs/conversations/api/conversation-resource). Indices may skip numbers, but will always be in order of when the message was received.

Returns:



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

def index
    @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



532
533
534
535
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 532

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

#links ⇒ Hash

Returns Contains an absolute API resource URL to access the delivery & read receipts of this message.

Returns:

  • (Hash) —

    Contains an absolute API resource URL to access the delivery & read receipts of this message.



454
455
456
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 454

def links
    @properties['links']
end

#media ⇒ Array<Hash>

Returns An array of objects that describe the Message’s media, if the message contains media. Each object contains these fields: ‘content_type` with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object’s file size in bytes. If the Message has no media, this value is ‘null`.

Returns:

  • (Array<Hash>) —

    An array of objects that describe the Message’s media, if the message contains media. Each object contains these fields: ‘content_type` with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object’s file size in bytes. If the Message has no media, this value is ‘null`.



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

def media
    @properties['media']
end

#participant_sid ⇒ String

Returns The unique ID of messages’s author participant. Null in case of ‘system` sent message.

Returns:

  • (String) —

    The unique ID of messages’s author participant. Null in case of ‘system` sent message.



424
425
426
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 424

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.



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



525
526
527
528
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 525

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, subject: :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.

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

    The subject of the message, can be up to 256 characters long.

  • x_twilio_webhook_enabled (ConversationMessageEnumWebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 495

def update(
    author: :unset, 
    body: :unset, 
    date_created: :unset, 
    date_updated: :unset, 
    attributes: :unset, 
    subject: :unset, 
    x_twilio_webhook_enabled: :unset
)

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

#url ⇒ String

Returns An absolute API resource API URL for this message.

Returns:

  • (String) —

    An absolute API resource API URL for this message.



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

def url
    @properties['url']
end