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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, chat_service_sid: nil, 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.



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/conversations/v1/service/conversation/message.rb', line 341

def initialize(version, payload , chat_service_sid: nil, conversation_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'chat_service_sid' => payload['chat_service_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']),
        'delivery' => payload['delivery'],
        'url' => payload['url'],
        'links' => payload['links'],
        'content_sid' => payload['content_sid'],
    }

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

Instance Method Details

#account_sidString

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

Returns:



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

def 
    @properties['account_sid']
end

#attributesString

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.



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

def attributes
    @properties['attributes']
end

#authorString

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



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

def author
    @properties['author']
end

#bodyString

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.



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

def body
    @properties['body']
end

#chat_service_sidString

Returns The SID of the [Conversation Service](www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.

Returns:



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

def chat_service_sid
    @properties['chat_service_sid']
end

#content_sidString

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

Returns:



472
473
474
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 472

def content_sid
    @properties['content_sid']
end

#contextMessageContext

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

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

#conversation_sidString

Returns The unique ID of the [Conversation](www.twilio.com/docs/conversations/api/conversation-resource) for this message.

Returns:



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

def conversation_sid
    @properties['conversation_sid']
end

#date_createdTime

Returns The date that this resource was created.

Returns:

  • (Time)

    The date that this resource was created.



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

def date_created
    @properties['date_created']
end

#date_updatedTime

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.



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

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the MessageInstance

Parameters:

  • x_twilio_webhook_enabled (ServiceConversationMessageEnumWebhookEnabledType) (defaults to: :unset)

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean)

    True if delete succeeds, false otherwise



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

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#deliveryHash

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.



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

def delivery
    @properties['delivery']
end

#delivery_receiptsdelivery_receipts

Access the delivery_receipts

Returns:



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

def delivery_receipts
    context.delivery_receipts
end

#fetchMessageInstance

Fetch the MessageInstance

Returns:



492
493
494
495
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 492

def fetch

    context.fetch
end

#indexString

Returns The index of the message within the [Conversation](www.twilio.com/docs/conversations/api/conversation-resource).

Returns:



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

def index
    @properties['index']
end

#inspectObject

Provide a detailed, user friendly representation



544
545
546
547
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 544

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

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.



466
467
468
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 466

def links
    @properties['links']
end

#mediaArray<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`.



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

def media
    @properties['media']
end

#participant_sidString

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.



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

def participant_sid
    @properties['participant_sid']
end

#sidString

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String)

    A 34 character string that uniquely identifies this resource.



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

def sid
    @properties['sid']
end

#to_sObject

Provide a user friendly representation



537
538
539
540
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 537

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 (ServiceConversationMessageEnumWebhookEnabledType) (defaults to: :unset)

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:



507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 507

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

#urlString

Returns An absolute API resource URL for this message.

Returns:

  • (String)

    An absolute API resource URL for this message.



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

def url
    @properties['url']
end