Class: Twilio::REST::Api::V2010::AccountContext::QueueInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Api::V2010::AccountContext::QueueInstance
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/queue.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created this Queue resource.
-
#average_wait_time ⇒ String
The average wait time in seconds of the members in this queue.
-
#context ⇒ QueueContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#current_size ⇒ String
The number of calls currently in the queue.
-
#date_created ⇒ Time
The date and time in GMT that this resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#date_updated ⇒ Time
The date and time in GMT that this resource was last updated, specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#delete ⇒ Boolean
Delete the QueueInstance.
-
#fetch ⇒ QueueInstance
Fetch the QueueInstance.
-
#friendly_name ⇒ String
A string that you assigned to describe this resource.
-
#initialize(version, payload, account_sid: nil, sid: nil) ⇒ QueueInstance
constructor
Initialize the QueueInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#max_size ⇒ String
The maximum number of calls that can be in the queue.
-
#members ⇒ members
Access the members.
-
#sid ⇒ String
The unique string that that we created to identify this Queue resource.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(friendly_name: :unset, max_size: :unset) ⇒ QueueInstance
Update the QueueInstance.
-
#uri ⇒ String
The URI of this resource, relative to ‘api.twilio.com`.
Constructor Details
#initialize(version, payload, account_sid: nil, sid: nil) ⇒ QueueInstance
Initialize the QueueInstance
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 |
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 288 def initialize(version, payload , account_sid: nil, sid: nil) super(version) # Marshaled Properties @properties = { 'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']), 'current_size' => payload['current_size'] == nil ? payload['current_size'] : payload['current_size'].to_i, 'friendly_name' => payload['friendly_name'], 'uri' => payload['uri'], 'account_sid' => payload['account_sid'], 'average_wait_time' => payload['average_wait_time'] == nil ? payload['average_wait_time'] : payload['average_wait_time'].to_i, 'sid' => payload['sid'], 'date_created' => Twilio.deserialize_rfc2822(payload['date_created']), 'max_size' => payload['max_size'] == nil ? payload['max_size'] : payload['max_size'].to_i, } # Context @instance_context = nil @params = { 'account_sid' => account_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 this Queue resource.
346 347 348 |
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 346 def account_sid @properties['account_sid'] end |
#average_wait_time ⇒ String
Returns The average wait time in seconds of the members in this queue. This is calculated at the time of the request.
352 353 354 |
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 352 def average_wait_time @properties['average_wait_time'] end |
#context ⇒ QueueContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
313 314 315 316 317 318 |
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 313 def context unless @instance_context @instance_context = QueueContext.new(@version , @params['account_sid'], @params['sid']) end @instance_context end |
#current_size ⇒ String
Returns The number of calls currently in the queue.
328 329 330 |
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 328 def current_size @properties['current_size'] end |
#date_created ⇒ Time
Returns The date and time in GMT that this resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
364 365 366 |
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 364 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date and time in GMT that this resource was last updated, specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
322 323 324 |
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 322 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the QueueInstance
377 378 379 380 |
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 377 def delete context.delete end |
#fetch ⇒ QueueInstance
Fetch the QueueInstance
385 386 387 388 |
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 385 def fetch context.fetch end |
#friendly_name ⇒ String
Returns A string that you assigned to describe this resource.
334 335 336 |
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 334 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
422 423 424 425 |
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 422 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Api.V2010.QueueInstance #{values}>" end |
#max_size ⇒ String
Returns The maximum number of calls that can be in the queue. The default is 1000 and the maximum is 5000.
370 371 372 |
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 370 def max_size @properties['max_size'] end |
#members ⇒ members
Access the members
409 410 411 |
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 409 def members context.members end |
#sid ⇒ String
Returns The unique string that that we created to identify this Queue resource.
358 359 360 |
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 358 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
415 416 417 418 |
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 415 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Api.V2010.QueueInstance #{values}>" end |
#update(friendly_name: :unset, max_size: :unset) ⇒ QueueInstance
Update the QueueInstance
395 396 397 398 399 400 401 402 403 404 |
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 395 def update( friendly_name: :unset, max_size: :unset ) context.update( friendly_name: friendly_name, max_size: max_size, ) end |
#uri ⇒ String
Returns The URI of this resource, relative to ‘api.twilio.com`.
340 341 342 |
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 340 def uri @properties['uri'] end |