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 update the resource from.

  • channel_sid (String) —

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

  • sid (String) —

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



178
179
180
181
182
183
184
185
186
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 178

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

Delete the MemberInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



190
191
192
193
194
195
196
197
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 190

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    @version.delete('DELETE', @uri, headers: headers)
end

#fetch ⇒ MemberInstance

Fetch the MemberInstance

Returns:



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 202

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    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



261
262
263
264
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 261

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

#to_s ⇒ Object

Provide a user friendly representation



254
255
256
257
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 254

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:



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

def update(
    role_sid: :unset, 
    last_consumed_message_index: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    MemberInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        channel_sid: @solution[:channel_sid],
        sid: @solution[:sid],
    )
end