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.



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 327

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:



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

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.



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

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:



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

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:



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

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:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the UserInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ UserInstance

Fetch the UserInstance

Returns:



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

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.



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

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:



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

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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`.



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

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`.



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

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.



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

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:



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

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:



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

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:



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

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.



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



502
503
504
505
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 502

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:



471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 471

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.



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

def url
    @properties['url']
end

#user_bindings ⇒ user_bindings

Access the user_bindings

Returns:



496
497
498
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 496

def user_bindings
    context.user_bindings
end

#user_channels ⇒ user_channels

Access the user_channels

Returns:



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

def user_channels
    context.user_channels
end