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 unique id of the [Service](www.twilio.com/docs/api/chat/rest/services) this user belongs to.

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

    Key that uniquely defines the user to fetch. Could be Sid or Identity.



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 306

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 unique id of the Account responsible for this user.

Returns:

  • (String) —

    The unique id of the Account responsible for this user.



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

def 
  @properties['account_sid']
end

#attributes ⇒ String

Returns An optional string metadata field you can use to store any data you wish.

Returns:

  • (String) —

    An optional string metadata field you can use to store any data you wish.



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

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:



336
337
338
339
340
341
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 336

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 that this resource was created in ISO 8601 format.

Returns:

  • (Time) —

    The date that this resource was created in ISO 8601 format.



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated in ISO 8601 format.

Returns:

  • (Time) —

    The date that this resource was last updated in ISO 8601 format.



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the UserInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ UserInstance

Fetch a UserInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The human-readable name of this user.

Returns:

  • (String) —

    The human-readable name of this user.



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

def friendly_name
  @properties['friendly_name']
end

#identity ⇒ String

Returns A unique string that identifies the user within this service - often a username or email address.

Returns:

  • (String) —

    A unique string that identifies the user within this service - often a username or email address.



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#is_notifiable ⇒ Boolean

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

Returns:

  • (Boolean) —

    Indicates whether the User has a potentially valid Push Notification registration for the Service instance.



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

def is_notifiable
  @properties['is_notifiable']
end

#is_online ⇒ Boolean

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

Returns:

  • (Boolean) —

    Indicates whether the User is actively connected to the Service instance and online.



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

def is_online
  @properties['is_online']
end

#joined_channels_count ⇒ String

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

Returns:

  • (String) —

    The number of Channels this User is a Member of.



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

def joined_channels_count
  @properties['joined_channels_count']
end

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



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

def links
  @properties['links']
end

#role_sid ⇒ String

Returns The unique id of the [Role] assigned to this user.

Returns:

  • (String) —

    The unique id of the [Role] assigned to this user.



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

def role_sid
  @properties['role_sid']
end

#service_sid ⇒ String

Returns The unique id of the Service this user belongs to.

Returns:

  • (String) —

    The unique id of the Service this user belongs to.



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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 unique id of the [Role] assigned to this user.

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

    An optional string used to contain any metadata or other information for the User. The string must contain structurally valid JSON if specified.

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

    An optional human readable string representing the user. Often used for display purposes.

Returns:



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

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 An absolute URL for this user.

Returns:

  • (String) —

    An absolute URL for this user.



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

def url
  @properties['url']
end

#user_bindings ⇒ user_bindings

Access the user_bindings

Returns:



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

def user_bindings
  context.user_bindings
end

#user_channels ⇒ user_channels

Access the user_channels

Returns:



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

def user_channels
  context.user_channels
end