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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/chat/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.



634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 634

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 The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Message resource.

Returns:



682
683
684
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 682

def 
    @properties['account_sid']
end

#attributes ⇒ String

Returns The JSON string that stores application-specific data. If attributes have not been set, ‘{}` is returned.

Returns:

  • (String) —

    The JSON string that stores application-specific data. If attributes have not been set, ‘{}` is returned.



688
689
690
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 688

def attributes
    @properties['attributes']
end

#body ⇒ String

Returns The content of the message.

Returns:

  • (String) —

    The content of the message.



742
743
744
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 742

def body
    @properties['body']
end

#channel_sid ⇒ String

Returns The SID of the [Channel](www.twilio.com/docs/chat/channels) the Message resource belongs to.

Returns:



706
707
708
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 706

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:



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

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 The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



712
713
714
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 712

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



718
719
720
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 718

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



774
775
776
777
778
779
780
781
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 774

def delete(
  x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance

Returns:



786
787
788
789
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 786

def fetch

    context.fetch
end

#from ⇒ String

Returns The [Identity](www.twilio.com/docs/chat/identity) of the message’s author. The default value is ‘system`.

Returns:



736
737
738
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 736

def from
    @properties['from']
end

#index ⇒ String

Returns The index of the message within the [Channel](www.twilio.com/docs/chat/channels). Indices may skip numbers, but will always be in order of when the message was received.

Returns:

  • (String) —

    The index of the message within the [Channel](www.twilio.com/docs/chat/channels). Indices may skip numbers, but will always be in order of when the message was received.



748
749
750
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 748

def index
    @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



831
832
833
834
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 831

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

#last_updated_by ⇒ String

Returns The [Identity](www.twilio.com/docs/chat/identity) of the User who last updated the Message, if applicable.

Returns:



724
725
726
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 724

def last_updated_by
    @properties['last_updated_by']
end

#media ⇒ Hash

Returns An object that describes the Message’s media, if the message contains media. The object contains these fields: ‘content_type` with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object’s file size in bytes. If the Message has no media, this value is ‘null`.

Returns:

  • (Hash) —

    An object that describes the Message’s media, if the message contains media. The object contains these fields: ‘content_type` with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object’s file size in bytes. If the Message has no media, this value is ‘null`.



760
761
762
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 760

def media
    @properties['media']
end

#service_sid ⇒ String

Returns The SID of the [Service](www.twilio.com/docs/chat/rest/service-resource) the Message resource is associated with.

Returns:



694
695
696
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 694

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the Message resource.

Returns:

  • (String) —

    The unique string that we created to identify the Message resource.



676
677
678
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 676

def sid
    @properties['sid']
end

#to ⇒ String

Returns The SID of the [Channel](www.twilio.com/docs/chat/channels) that the message was sent to.

Returns:



700
701
702
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 700

def to
    @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#type ⇒ String

Returns The Message type. Can be: ‘text` or `media`.

Returns:

  • (String) —

    The Message type. Can be: ‘text` or `media`.



754
755
756
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 754

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) —

    The message to send to the channel. Can be an empty string or ‘null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string.

  • attributes (String) (defaults to: :unset) —

    A valid JSON string that contains application-specific data.

  • date_created (Time) (defaults to: :unset) —

    The date, specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. This parameter should only be used when a Chat’s history is being recreated from a backup/separate source.

  • date_updated (Time) (defaults to: :unset) —

    The date, specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated.

  • last_updated_by (String) (defaults to: :unset) —

    The [Identity](www.twilio.com/docs/chat/identity) of the User who last updated the Message, if applicable.

  • from (String) (defaults to: :unset) —

    The [Identity](www.twilio.com/docs/chat/identity) of the message’s author.

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

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:



801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 801

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 The absolute URL of the Message resource.

Returns:

  • (String) —

    The absolute URL of the Message resource.



766
767
768
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 766

def url
    @properties['url']
end

#was_edited ⇒ Boolean

Returns Whether the message has been edited since it was created.

Returns:

  • (Boolean) —

    Whether the message has been edited since it was created.



730
731
732
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 730

def was_edited
    @properties['was_edited']
end