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

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v1/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



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 572

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']),
        'was_edited' => payload['was_edited'],
        'from' => payload['from'],
        'body' => payload['body'],
        'index' => payload['index'] == nil ? payload['index'] : payload['index'].to_i,
        '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 



617
618
619
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 617

def 
    @properties['account_sid']
end

#attributes ⇒ String 



623
624
625
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 623

def attributes
    @properties['attributes']
end

#body ⇒ String 



671
672
673
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 671

def body
    @properties['body']
end

#channel_sid ⇒ String 



641
642
643
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 641

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



602
603
604
605
606
607
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 602

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 



647
648
649
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 647

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



653
654
655
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 653

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the MessageInstance



690
691
692
693
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 690

def delete

    context.delete
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance



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

def fetch

    context.fetch
end

#from ⇒ String 



665
666
667
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 665

def from
    @properties['from']
end

#index ⇒ String 



677
678
679
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 677

def index
    @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#service_sid ⇒ String 



629
630
631
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 629

def service_sid
    @properties['service_sid']
end

#sid ⇒ String 



611
612
613
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 611

def sid
    @properties['sid']
end

#to ⇒ String 



635
636
637
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 635

def to
    @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#update(body: :unset, attributes: :unset) ⇒ MessageInstance

Update the MessageInstance



708
709
710
711
712
713
714
715
716
717
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 708

def update(
  body: :unset, 
  attributes: :unset
)

    context.update(
        body: body, 
        attributes: attributes, 
    )
end

#url ⇒ String 



683
684
685
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 683

def url
    @properties['url']
end

#was_edited ⇒ Boolean 



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

def was_edited
    @properties['was_edited']
end