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

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

Instance Method Summary collapse

Constructor Details

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

Initialize the MemberContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The service_sid

  • channel_sid (String) —

    The channel_sid

  • sid (String) —

    The sid



201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 201

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]}/Members/#{@solution[:sid]}"
end

Instance Method Details

#delete ⇒ Boolean

Deletes the MemberInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



237
238
239
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 237

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

#fetch ⇒ MemberInstance

Fetch a MemberInstance

Returns:



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 216

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

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

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

#to_s ⇒ Object

Provide a user friendly representation



269
270
271
272
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 269

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

#update(role_sid: :unset, last_consumed_message_index: :unset) ⇒ MemberInstance

Update the MemberInstance

Parameters:

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

    The role_sid

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

    The last_consumed_message_index

Returns:



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

def update(role_sid: :unset, last_consumed_message_index: :unset)
  data = Twilio::Values.of({
      'RoleSid' => role_sid,
      'LastConsumedMessageIndex' => last_consumed_message_index,
  })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

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