Class: Twilio::REST::Chat::V2::ServiceContext::UserInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/chat/v2/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 SID of the [Service](www.twilio.com/docs/chat/rest/service-resource) the User resource is associated with.

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

    The SID of the User resource to fetch. This value can be either the sid or the identity of the User resource to fetch.



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 321

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 SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



366
367
368
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 366

def 
  @properties['account_sid']
end

#attributes ⇒ String

Returns The JSON string that stores application-specific data.

Returns:

  • (String) —

    The JSON string that stores application-specific data



378
379
380
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 378

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:



351
352
353
354
355
356
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 351

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

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated



420
421
422
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 420

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the UserInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#fetch ⇒ UserInstance

Fetch a UserInstance

Returns:



445
446
447
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 445

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource



384
385
386
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 384

def friendly_name
  @properties['friendly_name']
end

#identity ⇒ String

Returns The string that identifies the resource’s User.

Returns:

  • (String) —

    The string that identifies the resource’s User



396
397
398
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 396

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



493
494
495
496
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 493

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

#is_notifiable ⇒ Boolean

Returns Whether the User has a potentially valid Push Notification registration for the Service instance.

Returns:

  • (Boolean) —

    Whether the User has a potentially valid Push Notification registration for the Service instance



408
409
410
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 408

def is_notifiable
  @properties['is_notifiable']
end

#is_online ⇒ Boolean

Returns Whether the User is actively connected to the Service instance and online.

Returns:

  • (Boolean) —

    Whether the User is actively connected to the Service instance and online



402
403
404
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 402

def is_online
  @properties['is_online']
end

#joined_channels_count ⇒ String

Returns The number of Channels the User is a Member of.

Returns:

  • (String) —

    The number of Channels the User is a Member of



426
427
428
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 426

def joined_channels_count
  @properties['joined_channels_count']
end

#links ⇒ String

Returns The absolute URLs of the Channel and Binding resources related to the user.

Returns:

  • (String) —

    The absolute URLs of the Channel and Binding resources related to the user



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

def links
  @properties['links']
end

#role_sid ⇒ String

Returns The SID of the Role assigned to the user.

Returns:

  • (String) —

    The SID of the Role assigned to the user



390
391
392
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 390

def role_sid
  @properties['role_sid']
end

#service_sid ⇒ String

Returns The SID of the Service that the resource is associated with.

Returns:

  • (String) —

    The SID of the Service that the resource is associated with



372
373
374
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 372

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



360
361
362
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 360

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



486
487
488
489
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 486

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

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

Update the UserInstance

Parameters:

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

    The SID of the [Role](www.twilio.com/docs/chat/rest/role-resource) to assign to the User.

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

    A valid JSON string that contains application-specific data.

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

    A descriptive string that you create to describe the resource. It is often used for display purposes.

Returns:



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

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 absolute URL of the User resource.

Returns:

  • (String) —

    The absolute URL of the User resource



438
439
440
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 438

def url
  @properties['url']
end

#user_bindings ⇒ user_bindings

Access the user_bindings

Returns:



480
481
482
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 480

def user_bindings
  context.user_bindings
end

#user_channels ⇒ user_channels

Access the user_channels

Returns:



473
474
475
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 473

def user_channels
  context.user_channels
end