Class: Twilio::REST::Chat::V1::ServiceContext::UserInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/chat/v1/service/user.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the UserInstance



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 289

def initialize(version, payload , service_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'attributes' => payload['attributes'],
        'friendly_name' => payload['friendly_name'],
        'role_sid' => payload['role_sid'],
        'identity' => payload['identity'],
        'is_online' => payload['is_online'],
        'is_notifiable' => payload['is_notifiable'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'joined_channels_count' => payload['joined_channels_count'] == nil ? payload['joined_channels_count'] : payload['joined_channels_count'].to_i,
        'links' => payload['links'],
        'url' => payload['url'],
    }

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

Instance Method Details

#account_sid ⇒ String 



334
335
336
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 334

def 
    @properties['account_sid']
end

#attributes ⇒ String 



346
347
348
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 346

def attributes
    @properties['attributes']
end

#context ⇒ UserContext

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



319
320
321
322
323
324
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 319

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

#date_created ⇒ Time 



382
383
384
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 382

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



388
389
390
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 388

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the UserInstance



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

def delete

    context.delete
end

#fetch ⇒ UserInstance

Fetch the UserInstance



421
422
423
424
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 421

def fetch

    context.fetch
end

#friendly_name ⇒ String 



352
353
354
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 352

def friendly_name
    @properties['friendly_name']
end

#identity ⇒ String 



364
365
366
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 364

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



461
462
463
464
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 461

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

#is_notifiable ⇒ Boolean 



376
377
378
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 376

def is_notifiable
    @properties['is_notifiable']
end

#is_online ⇒ Boolean 



370
371
372
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 370

def is_online
    @properties['is_online']
end

#joined_channels_count ⇒ String 



394
395
396
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 394

def joined_channels_count
    @properties['joined_channels_count']
end

#links ⇒ Hash 



400
401
402
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 400

def links
    @properties['links']
end

#role_sid ⇒ String 



358
359
360
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 358

def role_sid
    @properties['role_sid']
end

#service_sid ⇒ String 



340
341
342
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 340

def service_sid
    @properties['service_sid']
end

#sid ⇒ String 



328
329
330
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 328

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



454
455
456
457
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 454

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

#update(role_sid: :unset, attributes: :unset, friendly_name: :unset) ⇒ UserInstance

Update the UserInstance



432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 432

def update(
    role_sid: :unset, 
    attributes: :unset, 
    friendly_name: :unset
)

    context.update(
        role_sid: role_sid, 
        attributes: attributes, 
        friendly_name: friendly_name, 
    )
end

#url ⇒ String 



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

def url
    @properties['url']
end

#user_channels ⇒ user_channels

Access the user_channels



448
449
450
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 448

def user_channels
    context.user_channels
end