Class: Twilio::REST::Api::V2010::AccountContext::MessageInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Api::V2010::AccountContext::MessageInstance
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/message.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) associated with the Message resource.
-
#api_version ⇒ String
The API version used to process the Message.
-
#body ⇒ String
The text content of the message.
-
#context ⇒ MessageContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The [RFC 2822](datatracker.ietf.org/doc/html/rfc2822#section-3.3) timestamp (in GMT) of when the Message resource was created.
-
#date_sent ⇒ Time
The [RFC 2822](datatracker.ietf.org/doc/html/rfc2822#section-3.3) timestamp (in GMT) of when the Message was sent.
-
#date_updated ⇒ Time
The [RFC 2822](datatracker.ietf.org/doc/html/rfc2822#section-3.3) timestamp (in GMT) of when the Message resource was last updated.
-
#delete ⇒ Boolean
Delete the MessageInstance.
- #direction ⇒ Direction
-
#error_code ⇒ String
The [error code](www.twilio.com/docs/api/errors) returned if the Message ‘status` is `failed` or `undelivered`.
-
#error_message ⇒ String
The description of the ‘error_code` if the Message `status` is `failed` or `undelivered`.
-
#feedback ⇒ feedback
Access the feedback.
-
#fetch ⇒ MessageInstance
Fetch the MessageInstance.
-
#from ⇒ String
The sender’s phone number (in [E.164](en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](www.twilio.com/docs/sms/quickstart), [Wireless SIM](www.twilio.com/docs/iot/wireless/programmable-wireless-send-machine-machine-sms-commands), [short code](www.twilio.com/en-us/messaging/channels/sms/short-codes), or [channel address](www.twilio.com/docs/messaging/channels) (e.g., ‘whatsapp:+15554449999`).
-
#initialize(version, payload, account_sid: nil, sid: nil) ⇒ MessageInstance
constructor
Initialize the MessageInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#media ⇒ media
Access the media.
-
#messaging_service_sid ⇒ String
The SID of the [Messaging Service](www.twilio.com/docs/messaging/api/service-resource) associated with the Message resource.
-
#num_media ⇒ String
The number of media files associated with the Message resource.
-
#num_segments ⇒ String
The number of segments that make up the complete message.
-
#price ⇒ String
The amount billed for the message in the currency specified by ‘price_unit`.
-
#price_unit ⇒ String
The currency in which ‘price` is measured, in [ISO 4127](www.iso.org/iso/home/standards/currency_codes.htm) format (e.g. `usd`, `eur`, `jpy`).
-
#sid ⇒ String
The unique, Twilio-provided string that identifies the Message resource.
- #status ⇒ Status
-
#subresource_uris ⇒ Hash
A list of related resources identified by their URIs relative to ‘api.twilio.com`.
-
#to ⇒ String
The recipient’s phone number (in [E.164](en.wikipedia.org/wiki/E.164) format) or [channel address](www.twilio.com/docs/messaging/channels) (e.g. ‘whatsapp:+15552229999`).
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(body: :unset, status: :unset) ⇒ MessageInstance
Update the MessageInstance.
-
#uri ⇒ String
The URI of the Message resource, relative to ‘api.twilio.com`.
Constructor Details
#initialize(version, payload, account_sid: nil, sid: nil) ⇒ MessageInstance
Initialize the MessageInstance
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 421 def initialize(version, payload , account_sid: nil, sid: nil) super(version) # Marshaled Properties @properties = { 'body' => payload['body'], 'num_segments' => payload['num_segments'], 'direction' => payload['direction'], 'from' => payload['from'], 'to' => payload['to'], 'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']), 'price' => payload['price'], 'error_message' => payload['error_message'], 'uri' => payload['uri'], 'account_sid' => payload['account_sid'], 'num_media' => payload['num_media'], 'status' => payload['status'], 'messaging_service_sid' => payload['messaging_service_sid'], 'sid' => payload['sid'], 'date_sent' => Twilio.deserialize_rfc2822(payload['date_sent']), 'date_created' => Twilio.deserialize_rfc2822(payload['date_created']), 'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i, 'price_unit' => payload['price_unit'], 'api_version' => payload['api_version'], 'subresource_uris' => payload['subresource_uris'], } # Context @instance_context = nil @params = { 'account_sid' => account_sid ,'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
520 521 522 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 520 def account_sid @properties['account_sid'] end |
#api_version ⇒ String
574 575 576 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 574 def api_version @properties['api_version'] end |
#body ⇒ String
466 467 468 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 466 def body @properties['body'] 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
457 458 459 460 461 462 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 457 def context unless @instance_context @instance_context = MessageContext.new(@version , @params['account_sid'], @params['sid']) end @instance_context end |
#date_created ⇒ Time
556 557 558 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 556 def date_created @properties['date_created'] end |
#date_sent ⇒ Time
550 551 552 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 550 def date_sent @properties['date_sent'] end |
#date_updated ⇒ Time
496 497 498 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 496 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the MessageInstance
587 588 589 590 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 587 def delete context.delete end |
#direction ⇒ Direction
478 479 480 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 478 def direction @properties['direction'] end |
#error_code ⇒ String
562 563 564 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 562 def error_code @properties['error_code'] end |
#error_message ⇒ String
508 509 510 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 508 def @properties['error_message'] end |
#feedback ⇒ feedback
Access the feedback
619 620 621 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 619 def feedback context.feedback end |
#fetch ⇒ MessageInstance
Fetch the MessageInstance
595 596 597 598 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 595 def fetch context.fetch end |
#from ⇒ String
484 485 486 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 484 def from @properties['from'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
639 640 641 642 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 639 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Api.V2010.MessageInstance #{values}>" end |
#media ⇒ media
Access the media
626 627 628 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 626 def media context.media end |
#messaging_service_sid ⇒ String
538 539 540 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 538 def messaging_service_sid @properties['messaging_service_sid'] end |
#num_media ⇒ String
526 527 528 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 526 def num_media @properties['num_media'] end |
#num_segments ⇒ String
472 473 474 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 472 def num_segments @properties['num_segments'] end |
#price ⇒ String
502 503 504 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 502 def price @properties['price'] end |
#price_unit ⇒ String
568 569 570 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 568 def price_unit @properties['price_unit'] end |
#sid ⇒ String
544 545 546 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 544 def sid @properties['sid'] end |
#status ⇒ Status
532 533 534 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 532 def status @properties['status'] end |
#subresource_uris ⇒ Hash
580 581 582 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 580 def subresource_uris @properties['subresource_uris'] end |
#to ⇒ String
490 491 492 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 490 def to @properties['to'] end |
#to_s ⇒ Object
Provide a user friendly representation
632 633 634 635 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 632 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Api.V2010.MessageInstance #{values}>" end |
#update(body: :unset, status: :unset) ⇒ MessageInstance
Update the MessageInstance
605 606 607 608 609 610 611 612 613 614 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 605 def update( body: :unset, status: :unset ) context.update( body: body, status: status, ) end |
#uri ⇒ String
514 515 516 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 514 def uri @properties['uri'] end |