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

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

  • channel_sid (String)

    The channel_sid

  • sid (String)

    The sid



203
204
205
206
207
208
209
210
211
212
213
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 203

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

#deleteBoolean

Deletes the MessageInstance

Returns:

  • (Boolean)

    true if delete succeeds, true otherwise



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

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

#fetchMessageInstance

Fetch a MessageInstance

Returns:



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 218

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  MessageInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      channel_sid: @solution[:channel_sid],
      sid: @solution[:sid],
  )
end

#to_sObject

Provide a user friendly representation



271
272
273
274
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 271

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

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

Update the MessageInstance

Parameters:

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

    The body

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

    The attributes

Returns:



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 248

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