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



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

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 



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

def 
  @properties['account_sid']
end

#channel_sid ⇒ String 



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

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



329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 329

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 



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the MemberInstance



417
418
419
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 417

def delete
  context.delete
end

#fetch ⇒ MemberInstance

Fetch a MemberInstance



410
411
412
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 410

def fetch
  context.fetch
end

#identity ⇒ String 



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



444
445
446
447
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 444

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

#last_consumed_message_index ⇒ String 



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

def last_consumed_message_index
  @properties['last_consumed_message_index']
end

#last_consumption_timestamp ⇒ Time 



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

def last_consumption_timestamp
  @properties['last_consumption_timestamp']
end

#role_sid ⇒ String 



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

def role_sid
  @properties['role_sid']
end

#service_sid ⇒ String 



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String 



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



437
438
439
440
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 437

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



431
432
433
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 431

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 



403
404
405
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 403

def url
  @properties['url']
end