Class: Twilio::REST::IpMessaging::V2::ServiceContext::ChannelContext::MessageInstance

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb

Instance Method Summary collapse

Constructor Details

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



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 626

def initialize(version, payload , service_sid: nil, channel_sid: nil, sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'attributes' => payload['attributes'],
        'service_sid' => payload['service_sid'],
        'to' => payload['to'],
        'channel_sid' => payload['channel_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'last_updated_by' => payload['last_updated_by'],
        'was_edited' => payload['was_edited'],
        'from' => payload['from'],
        'body' => payload['body'],
        'index' => payload['index'] == nil ? payload['index'] : payload['index'].to_i,
        'type' => payload['type'],
        'media' => payload['media'],
        'url' => payload['url'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns:

  • (String) 


674
675
676
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 674

def 
    @properties['account_sid']
end

#attributes ⇒ String

Returns:

  • (String) 


680
681
682
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 680

def attributes
    @properties['attributes']
end

#body ⇒ String

Returns:

  • (String) 


734
735
736
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 734

def body
    @properties['body']
end

#channel_sid ⇒ String

Returns:

  • (String) 


698
699
700
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 698

def channel_sid
    @properties['channel_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

Returns:



659
660
661
662
663
664
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 659

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

#date_created ⇒ Time

Returns:

  • (Time) 


704
705
706
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 704

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


710
711
712
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 710

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the MessageInstance

Parameters:

  • x_twilio_webhook_enabled (MessageEnumWebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



766
767
768
769
770
771
772
773
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 766

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance

Returns:



778
779
780
781
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 778

def fetch

    context.fetch
end

#from ⇒ String

Returns:

  • (String) 


728
729
730
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 728

def from
    @properties['from']
end

#index ⇒ String

Returns:

  • (String) 


740
741
742
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 740

def index
    @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



823
824
825
826
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 823

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

#last_updated_by ⇒ String

Returns:

  • (String) 


716
717
718
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 716

def last_updated_by
    @properties['last_updated_by']
end

#media ⇒ Hash

Returns:

  • (Hash) 


752
753
754
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 752

def media
    @properties['media']
end

#service_sid ⇒ String

Returns:

  • (String) 


686
687
688
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 686

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns:

  • (String) 


668
669
670
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 668

def sid
    @properties['sid']
end

#to ⇒ String

Returns:

  • (String) 


692
693
694
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 692

def to
    @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



816
817
818
819
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 816

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.IpMessaging.V2.MessageInstance #{values}>"
end

#type ⇒ String

Returns:

  • (String) 


746
747
748
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 746

def type
    @properties['type']
end

#update(body: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, last_updated_by: :unset, from: :unset, x_twilio_webhook_enabled: :unset) ⇒ MessageInstance

Update the MessageInstance

Parameters:

  • body (String) (defaults to: :unset)
  • attributes (String) (defaults to: :unset)
  • date_created (Time) (defaults to: :unset)
  • date_updated (Time) (defaults to: :unset)
  • last_updated_by (String) (defaults to: :unset)
  • from (String) (defaults to: :unset)
  • x_twilio_webhook_enabled (MessageEnumWebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:



793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 793

def update(
    body: :unset, 
    attributes: :unset, 
    date_created: :unset, 
    date_updated: :unset, 
    last_updated_by: :unset, 
    from: :unset, 
    x_twilio_webhook_enabled: :unset
)

    context.update(
        body: body, 
        attributes: attributes, 
        date_created: date_created, 
        date_updated: date_updated, 
        last_updated_by: last_updated_by, 
        from: from, 
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#url ⇒ String

Returns:

  • (String) 


758
759
760
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 758

def url
    @properties['url']
end

#was_edited ⇒ Boolean

Returns:

  • (Boolean) 


722
723
724
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 722

def was_edited
    @properties['was_edited']
end