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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil) ⇒ MemberInstance

Initialize the MemberInstance



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 294

def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'channel_sid' => payload['channel_sid'],
      'service_sid' => payload['service_sid'],
      'identity' => payload['identity'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'role_sid' => payload['role_sid'],
      'last_consumed_message_index' => payload['last_consumed_message_index'] == nil ? payload['last_consumed_message_index'] : payload['last_consumed_message_index'].to_i,
      'last_consumption_timestamp' => Twilio.deserialize_iso8601_datetime(payload['last_consumption_timestamp']),
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {
      'service_sid' => service_sid,
      'channel_sid' => channel_sid,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sid ⇒ String 



345
346
347
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 345

def 
  @properties['account_sid']
end

#channel_sid ⇒ String 



351
352
353
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 351

def channel_sid
  @properties['channel_sid']
end

#context ⇒ MemberContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context



325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 325

def context
  unless @instance_context
    @instance_context = MemberContext.new(
        @version,
        @params['service_sid'],
        @params['channel_sid'],
        @params['sid'],
    )
  end
  @instance_context
end

#date_created ⇒ Time 



369
370
371
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 369

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



375
376
377
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 375

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the MemberInstance



413
414
415
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 413

def delete
  context.delete
end

#fetch ⇒ MemberInstance

Fetch the MemberInstance



406
407
408
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 406

def fetch
  context.fetch
end

#identity ⇒ String 



363
364
365
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 363

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



441
442
443
444
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 441

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Chat.V1.MemberInstance #{values}>"
end

#last_consumed_message_index ⇒ String 



387
388
389
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 387

def last_consumed_message_index
  @properties['last_consumed_message_index']
end

#last_consumption_timestamp ⇒ Time 



393
394
395
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 393

def last_consumption_timestamp
  @properties['last_consumption_timestamp']
end

#role_sid ⇒ String 



381
382
383
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 381

def role_sid
  @properties['role_sid']
end

#service_sid ⇒ String 



357
358
359
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 357

def service_sid
  @properties['service_sid']
end

#sid ⇒ String 



339
340
341
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 339

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



434
435
436
437
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 434

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Chat.V1.MemberInstance #{values}>"
end

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

Update the MemberInstance



428
429
430
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 428

def update(role_sid: :unset, last_consumed_message_index: :unset)
  context.update(role_sid: role_sid, last_consumed_message_index: last_consumed_message_index, )
end

#url ⇒ String 



399
400
401
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 399

def url
  @properties['url']
end