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

  • account_sid (String) —

    The SID of the Account that created this User resource.

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

    The SID of the Call resource to fetch.



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 346

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

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the User resource.

Returns:



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

def 
    @properties['account_sid']
end

#attributes ⇒ String

Returns The JSON string that stores application-specific data. If attributes have not been set, ‘{}` is returned.

Returns:

  • (String) —

    The JSON string that stores application-specific data. If attributes have not been set, ‘{}` is returned.



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

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:



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

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 and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the UserInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ UserInstance

Fetch the UserInstance

Returns:



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

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.



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

def friendly_name
    @properties['friendly_name']
end

#identity ⇒ String

Returns The application-defined string that uniquely identifies the resource’s User within the [Service](www.twilio.com/docs/chat/rest/service-resource). This value is often a username or an email address, and is case-sensitive. See [access tokens](www.twilio.com/docs/chat/create-tokens) for more info.

Returns:



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

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



528
529
530
531
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 528

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 (APN or GCM) for the Service instance. If at least one registration exists, ‘true`; otherwise `false`. This value is only returned by Fetch actions that return a single resource and `null` is always returned by a Read action. This value is `null` if the Service’s ‘reachability_enabled` is `false`, and if the User has never had a notification registration, even if the Service’s ‘reachability_enabled` is `true`.

Returns:

  • (Boolean) —

    Whether the User has a potentially valid Push Notification registration (APN or GCM) for the Service instance. If at least one registration exists, ‘true`; otherwise `false`. This value is only returned by Fetch actions that return a single resource and `null` is always returned by a Read action. This value is `null` if the Service’s ‘reachability_enabled` is `false`, and if the User has never had a notification registration, even if the Service’s ‘reachability_enabled` is `true`.



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

def is_notifiable
    @properties['is_notifiable']
end

#is_online ⇒ Boolean

Returns Whether the User is actively connected to the Service instance and online. This value is only returned by Fetch actions that return a single resource and ‘null` is always returned by a Read action. This value is `null` if the Service’s ‘reachability_enabled` is `false`, if the User has never been online for the Service instance, even if the Service’s ‘reachability_enabled` is `true`.

Returns:

  • (Boolean) —

    Whether the User is actively connected to the Service instance and online. This value is only returned by Fetch actions that return a single resource and ‘null` is always returned by a Read action. This value is `null` if the Service’s ‘reachability_enabled` is `false`, if the User has never been online for the Service instance, even if the Service’s ‘reachability_enabled` is `true`.



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

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.



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

def joined_channels_count
    @properties['joined_channels_count']
end

#links ⇒ Hash

Returns The absolute URLs of the [Channel](www.twilio.com/docs/chat/channels) and [Binding](www.twilio.com/docs/chat/rest/binding-resource) resources related to the user.

Returns:



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

def links
    @properties['links']
end

#role_sid ⇒ String

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

Returns:



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

def role_sid
    @properties['role_sid']
end

#service_sid ⇒ String

Returns The SID of the [Service](www.twilio.com/docs/chat/rest/service-resource) the User resource is associated with.

Returns:



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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the User resource.

Returns:

  • (String) —

    The unique string that we created to identify the User resource.



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



521
522
523
524
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 521

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, x_twilio_webhook_enabled: :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.

  • x_twilio_webhook_enabled (UserEnumWebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:



490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 490

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

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

#url ⇒ String

Returns The absolute URL of the User resource.

Returns:

  • (String) —

    The absolute URL of the User resource.



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

def url
    @properties['url']
end

#user_bindings ⇒ user_bindings

Access the user_bindings

Returns:



515
516
517
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 515

def user_bindings
    context.user_bindings
end

#user_channels ⇒ user_channels

Access the user_channels

Returns:



508
509
510
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 508

def user_channels
    context.user_channels
end