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

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/chat/v1/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 SID of the [Service](www.twilio.com/docs/api/chat/rest/services) to fetch the resource from.

  • channel_sid (String) —

    The unique ID of the [Channel](www.twilio.com/docs/api/chat/rest/channels) the member to fetch belongs to. Can be the Channel resource’s ‘sid` or `unique_name` value.

  • sid (String) —

    The Twilio-provided string that uniquely identifies the Member resource to fetch.



215
216
217
218
219
220
221
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 215

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



247
248
249
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 247

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

#fetch ⇒ MemberInstance

Fetch a MemberInstance

Returns:



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 226

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



292
293
294
295
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 292

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

#to_s ⇒ Object

Provide a user friendly representation



285
286
287
288
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 285

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

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

Update the MemberInstance

Parameters:

Returns:



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 262

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