Class: Twilio::REST::Chat::V1::ServiceContext::UserInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/chat/v1/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.



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 293

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/api/rest/account) that created the User resource.

Returns:



338
339
340
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 338

def 
    @properties['account_sid']
end

#attributes ⇒ String

Returns The JSON string that stores application-specific data. Note If this property has been assigned a value, it’s only displayed in a FETCH action that returns a single resource; otherwise, it’s null. If the attributes have not been set, ‘{}` is returned.

Returns:

  • (String) —

    The JSON string that stores application-specific data. Note If this property has been assigned a value, it’s only displayed in a FETCH action that returns a single resource; otherwise, it’s null. If the attributes have not been set, ‘{}` is returned.



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

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:



323
324
325
326
327
328
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 323

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 [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

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 [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the UserInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ UserInstance

Fetch the UserInstance

Returns:



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

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.



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

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/api/chat/rest/services). This value is often a username or an email address. See [access tokens](www.twilio.com/docs/api/chat/guides/create-tokens) for more info.

Returns:



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

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Chat.V1.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`.



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

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



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

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.



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

def joined_channels_count
    @properties['joined_channels_count']
end

#links ⇒ Hash

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

Returns:



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

def links
    @properties['links']
end

#role_sid ⇒ String

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

Returns:



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

def role_sid
    @properties['role_sid']
end

#service_sid ⇒ String

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

Returns:



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

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.



332
333
334
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 332

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Chat.V1.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/api/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:



436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 436

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.



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

def url
    @properties['url']
end

#user_channels ⇒ user_channels

Access the user_channels

Returns:



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

def user_channels
    context.user_channels
end