Class: Twilio::REST::Conversations::V1::UserInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Conversations::V1::UserInstance
- Defined in:
- lib/twilio-ruby/rest/conversations/v1/user.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the Account that created the resource.
-
#attributes ⇒ String
The JSON Object string that stores application-specific data.
-
#chat_service_sid ⇒ String
The SID of the Conversation Service that the resource is associated with.
-
#context ⇒ UserContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The ISO 8601 date and time in GMT when the resource was created.
-
#date_updated ⇒ Time
The ISO 8601 date and time in GMT when the resource was last updated.
-
#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean
Delete the UserInstance.
-
#fetch ⇒ UserInstance
Fetch the UserInstance.
-
#friendly_name ⇒ String
The string that you assigned to describe the resource.
-
#identity ⇒ String
The string that identifies the resource's User.
-
#initialize(version, payload, sid: nil) ⇒ UserInstance
constructor
Initialize the UserInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#is_notifiable ⇒ Boolean
Whether the User has a potentially valid Push Notification registration for this Conversations Service.
-
#is_online ⇒ Boolean
Whether the User is actively connected to this Conversations Service and online.
-
#links ⇒ String
The links.
-
#role_sid ⇒ String
The SID of a service-level Role assigned to the user.
-
#sid ⇒ String
The unique string that identifies the resource.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(friendly_name: :unset, attributes: :unset, role_sid: :unset, x_twilio_webhook_enabled: :unset) ⇒ UserInstance
Update the UserInstance.
-
#url ⇒ String
An absolute URL for this user.
-
#user_conversations ⇒ user_conversations
Access the user_conversations.
Constructor Details
#initialize(version, payload, sid: nil) ⇒ UserInstance
Initialize the UserInstance
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 |
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 276 def initialize(version, payload, 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 = {'sid' => sid || @properties['sid'], } end |
Instance Method Details
#account_sid ⇒ String
Returns The SID of the Account that created the resource.
320 321 322 |
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 320 def account_sid @properties['account_sid'] end |
#attributes ⇒ String
Returns The JSON Object string that stores application-specific data.
350 351 352 |
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 350 def attributes @properties['attributes'] end |
#chat_service_sid ⇒ String
Returns The SID of the Conversation Service that the resource is associated with.
326 327 328 |
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 326 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
305 306 307 308 309 310 |
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 305 def context unless @instance_context @instance_context = UserContext.new(@version, @params['sid'], ) end @instance_context end |
#date_created ⇒ Time
Returns The ISO 8601 date and time in GMT when the resource was created.
368 369 370 |
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 368 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The ISO 8601 date and time in GMT when the resource was last updated.
374 375 376 |
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 374 def date_updated @properties['date_updated'] end |
#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean
Delete the UserInstance
416 417 418 |
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 416 def delete(x_twilio_webhook_enabled: :unset) context.delete(x_twilio_webhook_enabled: x_twilio_webhook_enabled, ) end |
#fetch ⇒ UserInstance
Fetch the UserInstance
423 424 425 |
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 423 def fetch context.fetch end |
#friendly_name ⇒ String
Returns The string that you assigned to describe the resource.
344 345 346 |
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 344 def friendly_name @properties['friendly_name'] end |
#identity ⇒ String
Returns The string that identifies the resource's User.
338 339 340 |
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 338 def identity @properties['identity'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
443 444 445 446 |
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 443 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 for this Conversations Service.
362 363 364 |
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 362 def is_notifiable @properties['is_notifiable'] end |
#is_online ⇒ Boolean
Returns Whether the User is actively connected to this Conversations Service and online.
356 357 358 |
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 356 def is_online @properties['is_online'] end |
#links ⇒ String
Returns The links.
386 387 388 |
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 386 def links @properties['links'] end |
#role_sid ⇒ String
Returns The SID of a service-level Role assigned to the user.
332 333 334 |
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 332 def role_sid @properties['role_sid'] end |
#sid ⇒ String
Returns The unique string that identifies the resource.
314 315 316 |
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 314 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
436 437 438 439 |
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 436 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
402 403 404 405 406 407 408 409 |
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 402 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 URL for this user.
380 381 382 |
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 380 def url @properties['url'] end |
#user_conversations ⇒ user_conversations
Access the user_conversations
430 431 432 |
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 430 def user_conversations context.user_conversations end |