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

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • service_sid (String) (defaults to: nil) —

    The service_sid

  • sid (String) (defaults to: nil) —

    The sid



293
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
320
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 293

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'].to_i,
      'links' => payload['links'],
      'url' => payload['url'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



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

def 
  @properties['account_sid']
end

#attributes ⇒ String

Returns The attributes.

Returns:

  • (String) —

    The attributes



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

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

Returns:



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

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

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the UserInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ UserInstance

Fetch a UserInstance

Returns:



424
425
426
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 424

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The friendly_name.

Returns:

  • (String) —

    The friendly_name



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

def friendly_name
  @properties['friendly_name']
end

#identity ⇒ String

Returns The identity.

Returns:

  • (String) —

    The identity



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



465
466
467
468
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 465

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

#is_notifiable ⇒ Boolean

Returns The is_notifiable.

Returns:

  • (Boolean) —

    The is_notifiable



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

def is_notifiable
  @properties['is_notifiable']
end

#is_online ⇒ Boolean

Returns The is_online.

Returns:

  • (Boolean) —

    The is_online



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

def is_online
  @properties['is_online']
end

#joined_channels_count ⇒ String

Returns The joined_channels_count.

Returns:

  • (String) —

    The joined_channels_count



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

def joined_channels_count
  @properties['joined_channels_count']
end

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



411
412
413
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 411

def links
  @properties['links']
end

#role_sid ⇒ String

Returns The role_sid.

Returns:

  • (String) —

    The role_sid



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

def role_sid
  @properties['role_sid']
end

#service_sid ⇒ String

Returns The service_sid.

Returns:

  • (String) —

    The service_sid



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



458
459
460
461
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 458

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

Parameters:

  • role_sid (String) (defaults to: :unset) —

    The role_sid

  • attributes (String) (defaults to: :unset) —

    The attributes

  • friendly_name (String) (defaults to: :unset) —

    The friendly_name

Returns:



441
442
443
444
445
446
447
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 441

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

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end

#user_channels ⇒ user_channels

Access the user_channels

Returns:



452
453
454
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 452

def user_channels
  context.user_channels
end