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



650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 650

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 



691
692
693
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 691

def 
    @properties['account_sid']
end

#attributes ⇒ String 



733
734
735
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 733

def attributes
    @properties['attributes']
end

#author ⇒ String 



715
716
717
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 715

def author
    @properties['author']
end

#body ⇒ String 



721
722
723
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 721

def body
    @properties['body']
end

#content_sid ⇒ String 



775
776
777
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 775

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



682
683
684
685
686
687
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 682

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

#conversation_sid ⇒ String 



697
698
699
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 697

def conversation_sid
    @properties['conversation_sid']
end

#date_created ⇒ Time 



745
746
747
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 745

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



751
752
753
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 751

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the MessageInstance



783
784
785
786
787
788
789
790
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 783

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#delivery ⇒ Hash 



763
764
765
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 763

def delivery
    @properties['delivery']
end

#delivery_receipts ⇒ delivery_receipts

Access the delivery_receipts



834
835
836
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 834

def delivery_receipts
    context.delivery_receipts
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance



795
796
797
798
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 795

def fetch

    context.fetch
end

#index ⇒ String 



709
710
711
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 709

def index
    @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



847
848
849
850
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 847

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

#links ⇒ Hash 



769
770
771
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 769

def links
    @properties['links']
end

#media ⇒ Array<Hash> 



727
728
729
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 727

def media
    @properties['media']
end

#participant_sid ⇒ String 



739
740
741
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 739

def participant_sid
    @properties['participant_sid']
end

#sid ⇒ String 



703
704
705
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 703

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



840
841
842
843
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 840

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



810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 810

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 



757
758
759
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 757

def url
    @properties['url']
end