Class: Twilio::REST::Chat::V1::ServiceContext::ChannelContext::MessageContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/chat/v1/service/channel/message.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, channel_sid, sid) ⇒ MessageContext

Initialize the MessageContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The SID of the Service to update the resource from.

  • channel_sid (String) —

    The unique ID of the Channel the message belongs to. Can be the Channel's sid or unique_name.

  • sid (String) —

    The Twilio-provided string that uniquely identifies the Message resource to update.



172
173
174
175
176
177
178
179
180
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/message.rb', line 172

def initialize(version, service_sid, channel_sid, sid)
    super(version)

    # Path Solution
    @solution = { service_sid: service_sid, channel_sid: channel_sid, sid: sid,  }
    @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Messages/#{@solution[:sid]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the MessageInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



184
185
186
187
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/message.rb', line 184

def delete

    @version.delete('DELETE', @uri)
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance

Returns:



192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/message.rb', line 192

def fetch

    payload = @version.fetch('GET', @uri)
    MessageInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        channel_sid: @solution[:channel_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



239
240
241
242
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/message.rb', line 239

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Chat.V1.MessageContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



232
233
234
235
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/message.rb', line 232

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Chat.V1.MessageContext #{context}>"
end

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

Update the MessageInstance

Parameters:

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

    The message to send to the channel. Can also 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.

Returns:



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/message.rb', line 209

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

    data = Twilio::Values.of({
        'Body' => body,
        'Attributes' => attributes,
    })

    payload = @version.update('POST', @uri, data: data)
    MessageInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        channel_sid: @solution[:channel_sid],
        sid: @solution[:sid],
    )
end