Class: Twilio::REST::Conversations::V1::ServiceContext::UserInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/service/user.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, chat_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.



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user.rb', line 311

def initialize(version, payload , chat_service_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'chat_service_sid' => payload['chat_service_sid'],
        'role_sid' => payload['role_sid'],
        'identity' => payload['identity'],
        'friendly_name' => payload['friendly_name'],
        'attributes' => payload['attributes'],
        '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']),
        'url' => payload['url'],
        'links' => payload['links'],
    }

    # Context
    @instance_context = nil
    @params = { 'chat_service_sid' => chat_service_sid  || @properties['chat_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:



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

def 
    @properties['account_sid']
end

#attributes ⇒ String

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

Returns:

  • (String) —

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



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

def attributes
    @properties['attributes']
end

#chat_service_sid ⇒ String

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

Returns:



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

def chat_service_sid
    @properties['chat_service_sid']
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:



340
341
342
343
344
345
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user.rb', line 340

def context
    unless @instance_context
        @instance_context = UserContext.new(@version , @params['chat_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:



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

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:



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

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the UserInstance

Parameters:

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

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



429
430
431
432
433
434
435
436
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user.rb', line 429

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#fetch ⇒ UserInstance

Fetch the UserInstance

Returns:



441
442
443
444
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user.rb', line 441

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.



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

def friendly_name
    @properties['friendly_name']
end

#identity ⇒ String

Returns The application-defined string that uniquely identifies the resource’s User within the [Conversation Service](www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive.

Returns:



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

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



484
485
486
487
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user.rb', line 484

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

#is_notifiable ⇒ Boolean

Returns Whether the User has a potentially valid Push Notification registration (APN or GCM) for this Conversations Service. 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 this Conversations Service. 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`.



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

def is_notifiable
    @properties['is_notifiable']
end

#is_online ⇒ Boolean

Returns Whether the User is actively connected to this Conversations Service 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 this Conversations Service, even if the Service’s ‘reachability_enabled` is `true`.

Returns:

  • (Boolean) —

    Whether the User is actively connected to this Conversations Service 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 this Conversations Service, even if the Service’s ‘reachability_enabled` is `true`.



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

def is_online
    @properties['is_online']
end

#links ⇒ Hash

Returns:

  • (Hash) 


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

def links
    @properties['links']
end

#role_sid ⇒ String

Returns The SID of a service-level [Role](www.twilio.com/docs/conversations/api/role-resource) assigned to the user.

Returns:



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

def role_sid
    @properties['role_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.



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



477
478
479
480
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user.rb', line 477

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Conversations.V1.UserInstance #{values}>"
end

#update(friendly_name: :unset, attributes: :unset, role_sid: :unset, x_twilio_webhook_enabled: :unset) ⇒ UserInstance

Update the UserInstance

Parameters:

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

    The string that you assigned to describe the resource.

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

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

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

    The SID of a service-level [Role](www.twilio.com/docs/conversations/api/role-resource) to assign to the user.

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

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:



453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user.rb', line 453

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

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

#url ⇒ String

Returns An absolute API resource URL for this user.

Returns:

  • (String) —

    An absolute API resource URL for this user.



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

def url
    @properties['url']
end

#user_conversations ⇒ user_conversations

Access the user_conversations

Returns:



471
472
473
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user.rb', line 471

def user_conversations
    context.user_conversations
end