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

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

    The SID of the [Service](www.twilio.com/docs/api/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.



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

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



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

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



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

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:



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

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



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the UserInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ UserInstance

Fetch a UserInstance

Returns:



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

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



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

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



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



455
456
457
458
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 455

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 for the Service instance.

Returns:

  • (Boolean) —

    Whether the User has a potentially valid Push Notification registration for the Service instance



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

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



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

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



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

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



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

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



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

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



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

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



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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:



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

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



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

def url
  @properties['url']
end

#user_channels ⇒ user_channels

Access the user_channels

Returns:



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

def user_channels
  context.user_channels
end