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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/chat/v2/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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 336

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 



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

def 
  @properties['account_sid']
end

#channel_sid ⇒ String 



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

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



367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 367

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 



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the MemberInstance



455
456
457
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 455

def delete
  context.delete
end

#fetch ⇒ MemberInstance

Fetch a MemberInstance



448
449
450
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 448

def fetch
  context.fetch
end

#identity ⇒ String 



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



498
499
500
501
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 498

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

#last_consumed_message_index ⇒ String 



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

def last_consumed_message_index
  @properties['last_consumed_message_index']
end

#last_consumption_timestamp ⇒ Time 



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

def last_consumption_timestamp
  @properties['last_consumption_timestamp']
end

#role_sid ⇒ String 



423
424
425
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 423

def role_sid
  @properties['role_sid']
end

#service_sid ⇒ String 



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String 



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



491
492
493
494
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 491

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

#update(role_sid: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset, date_created: :unset, date_updated: :unset) ⇒ MemberInstance

Update the MemberInstance



479
480
481
482
483
484
485
486
487
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 479

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

#url ⇒ String 



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

def url
  @properties['url']
end