Class: Twilio::REST::Api::V2010::AccountContext::QueueInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/queue.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, sid: nil) ⇒ QueueInstance

Initialize the QueueInstance



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/api/v2010/account/queue.rb', line 296

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' =>   ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sidString



354
355
356
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 354

def 
    @properties['account_sid']
end

#average_wait_timeString



360
361
362
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 360

def average_wait_time
    @properties['average_wait_time']
end

#contextQueueContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context



321
322
323
324
325
326
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 321

def context
    unless @instance_context
        @instance_context = QueueContext.new(@version , @params['account_sid'], @params['sid'])
    end
    @instance_context
end

#current_sizeString



336
337
338
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 336

def current_size
    @properties['current_size']
end

#date_createdTime



372
373
374
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 372

def date_created
    @properties['date_created']
end

#date_updatedTime



330
331
332
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 330

def date_updated
    @properties['date_updated']
end

#deleteBoolean

Delete the QueueInstance



385
386
387
388
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 385

def delete

    context.delete
end

#fetchQueueInstance

Fetch the QueueInstance



393
394
395
396
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 393

def fetch

    context.fetch
end

#friendly_nameString



342
343
344
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 342

def friendly_name
    @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation



430
431
432
433
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 430

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

#max_sizeString



378
379
380
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 378

def max_size
    @properties['max_size']
end

#membersmembers

Access the members



417
418
419
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 417

def members
    context.members
end

#sidString



366
367
368
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 366

def sid
    @properties['sid']
end

#to_sObject

Provide a user friendly representation



423
424
425
426
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 423

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



403
404
405
406
407
408
409
410
411
412
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 403

def update(
    friendly_name: :unset, 
    max_size: :unset
)

    context.update(
        friendly_name: friendly_name, 
        max_size: max_size, 
    )
end

#uriString



348
349
350
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 348

def uri
    @properties['uri']
end