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/services) the resource is associated with.

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

    The Twilio-provided string that uniquely identifies the User resource to fetch.



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

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



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

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



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

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:



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

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

#date_created ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the UserInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ UserInstance

Fetch a UserInstance

Returns:



442
443
444
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 442

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



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

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



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



489
490
491
492
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 489

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



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

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



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

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



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

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



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

def links
  @properties['links']
end

#role_sid ⇒ String

Returns The SID of the assigned to the user.

Returns:

  • (String) —

    The SID of the assigned to the user



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

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



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

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



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



482
483
484
485
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 482

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/roles) assigned to this 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:



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

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



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

def url
  @properties['url']
end

#user_bindings ⇒ user_bindings

Access the user_bindings

Returns:



476
477
478
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 476

def user_bindings
  context.user_bindings
end

#user_channels ⇒ user_channels

Access the user_channels

Returns:



469
470
471
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 469

def user_channels
  context.user_channels
end