Class: Twilio::REST::Conversations::V1::ServiceContext::ConversationContext::MessageInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Conversations::V1::ServiceContext::ConversationContext::MessageInstance
- Defined in:
- lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The unique ID of the [Account](www.twilio.com/docs/iam/api/account) responsible for this message.
-
#attributes ⇒ String
A string metadata field you can use to store any data you wish.
-
#author ⇒ String
The channel specific identifier of the message’s author.
-
#body ⇒ String
The content of the message, can be up to 1,600 characters long.
-
#chat_service_sid ⇒ String
The SID of the [Conversation Service](www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.
-
#content_sid ⇒ String
The unique ID of the multi-channel [Rich Content](www.twilio.com/docs/content-api) template.
-
#context ⇒ MessageContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#conversation_sid ⇒ String
The unique ID of the [Conversation](www.twilio.com/docs/conversations/api/conversation-resource) for this message.
-
#date_created ⇒ Time
The date that this resource was created.
-
#date_updated ⇒ Time
The date that this resource was last updated.
-
#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean
Delete the MessageInstance.
-
#delivery ⇒ Hash
An object that contains the summary of delivery statuses for the message to non-chat participants.
-
#delivery_receipts ⇒ delivery_receipts
Access the delivery_receipts.
-
#fetch ⇒ MessageInstance
Fetch the MessageInstance.
-
#index ⇒ String
The index of the message within the [Conversation](www.twilio.com/docs/conversations/api/conversation-resource).
-
#initialize(version, payload, chat_service_sid: nil, conversation_sid: nil, sid: nil) ⇒ MessageInstance
constructor
Initialize the MessageInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#links ⇒ Hash
Contains an absolute API resource URL to access the delivery & read receipts of this message.
-
#media ⇒ Array<Hash>
An array of objects that describe the Message’s media, if the message contains media.
-
#participant_sid ⇒ String
The unique ID of messages’s author participant.
-
#sid ⇒ String
A 34 character string that uniquely identifies this resource.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(author: :unset, body: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, x_twilio_webhook_enabled: :unset) ⇒ MessageInstance
Update the MessageInstance.
-
#url ⇒ String
An absolute API resource URL for this message.
Constructor Details
#initialize(version, payload, chat_service_sid: nil, conversation_sid: nil, sid: nil) ⇒ MessageInstance
Initialize the MessageInstance
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 362 363 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 337 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_sid ⇒ String
Returns The unique ID of the [Account](www.twilio.com/docs/iam/api/account) responsible for this message.
378 379 380 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 378 def account_sid @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.
426 427 428 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 426 def attributes @properties['attributes'] end |
#author ⇒ String
Returns The channel specific identifier of the message’s author. Defaults to ‘system`.
408 409 410 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 408 def @properties['author'] end |
#body ⇒ String
Returns The content of the message, can be up to 1,600 characters long.
414 415 416 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 414 def body @properties['body'] end |
#chat_service_sid ⇒ String
Returns The SID of the [Conversation Service](www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.
384 385 386 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 384 def chat_service_sid @properties['chat_service_sid'] end |
#content_sid ⇒ String
Returns The unique ID of the multi-channel [Rich Content](www.twilio.com/docs/content-api) template.
468 469 470 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 468 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
369 370 371 372 373 374 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 369 def context unless @instance_context @instance_context = MessageContext.new(@version , @params['chat_service_sid'], @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.
390 391 392 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 390 def conversation_sid @properties['conversation_sid'] end |
#date_created ⇒ Time
Returns The date that this resource was created.
438 439 440 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 438 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.
444 445 446 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 444 def date_updated @properties['date_updated'] end |
#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean
Delete the MessageInstance
476 477 478 479 480 481 482 483 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 476 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.
450 451 452 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 450 def delivery @properties['delivery'] end |
#delivery_receipts ⇒ delivery_receipts
Access the delivery_receipts
524 525 526 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 524 def delivery_receipts context.delivery_receipts end |
#fetch ⇒ MessageInstance
Fetch the MessageInstance
488 489 490 491 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 488 def fetch context.fetch end |
#index ⇒ String
Returns The index of the message within the [Conversation](www.twilio.com/docs/conversations/api/conversation-resource).
402 403 404 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 402 def index @properties['index'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
537 538 539 540 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 537 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.
462 463 464 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 462 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`.
420 421 422 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 420 def media @properties['media'] end |
#participant_sid ⇒ String
Returns The unique ID of messages’s author participant. Null in case of ‘system` sent message.
432 433 434 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 432 def participant_sid @properties['participant_sid'] end |
#sid ⇒ String
Returns A 34 character string that uniquely identifies this resource.
396 397 398 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 396 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
530 531 532 533 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 530 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
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 502 def update( author: :unset, body: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, x_twilio_webhook_enabled: :unset ) context.update( 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 resource URL for this message.
456 457 458 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 456 def url @properties['url'] end |