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



658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 658

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 



700
701
702
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 700

def 
    @properties['account_sid']
end

#attributes ⇒ String 



748
749
750
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 748

def attributes
    @properties['attributes']
end

#author ⇒ String 



730
731
732
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 730

def author
    @properties['author']
end

#body ⇒ String 



736
737
738
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 736

def body
    @properties['body']
end

#chat_service_sid ⇒ String 



706
707
708
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 706

def chat_service_sid
    @properties['chat_service_sid']
end

#content_sid ⇒ String 



790
791
792
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 790

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



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

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 



712
713
714
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 712

def conversation_sid
    @properties['conversation_sid']
end

#date_created ⇒ Time 



760
761
762
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 760

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



766
767
768
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 766

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the MessageInstance



798
799
800
801
802
803
804
805
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 798

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#delivery ⇒ Hash 



772
773
774
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 772

def delivery
    @properties['delivery']
end

#delivery_receipts ⇒ delivery_receipts

Access the delivery_receipts



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

def delivery_receipts
    context.delivery_receipts
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance



810
811
812
813
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 810

def fetch

    context.fetch
end

#index ⇒ String 



724
725
726
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 724

def index
    @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



862
863
864
865
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 862

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

#links ⇒ Hash 



784
785
786
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 784

def links
    @properties['links']
end

#media ⇒ Array<Hash> 



742
743
744
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 742

def media
    @properties['media']
end

#participant_sid ⇒ String 



754
755
756
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 754

def participant_sid
    @properties['participant_sid']
end

#sid ⇒ String 



718
719
720
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 718

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



855
856
857
858
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 855

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



825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 825

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 



778
779
780
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 778

def url
    @properties['url']
end