Class: Twilio::REST::Api::V2010::AccountContext::QueueContext

Inherits:

InstanceContext

• Object
• InstanceContext
• Twilio::REST::Api::V2010::AccountContext::QueueContext

Defined in:

lib/twilio-ruby/rest/api/v2010/account/queue.rb,
lib/twilio-ruby/rest/api/v2010/account/queue/member.rb

Defined Under Namespace

Classes: MemberContext, MemberInstance, MemberList, MemberPage

Instance Method Summary

• #delete ⇒ Boolean

  Deletes the QueueInstance.

• #fetch ⇒ QueueInstance

  Fetch a QueueInstance.

• #initialize(version, account_sid, sid) ⇒ QueueContext constructor

  Initialize the QueueContext.

• #members(call_sid = :unset) ⇒ MemberList, MemberContext

  Access the members.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #update(friendly_name: :unset, max_size: :unset) ⇒ QueueInstance

  Update the QueueInstance.

Constructor Details

#initialize(version, account_sid, sid) ⇒ QueueContext

Initialize the QueueContext

Parameters:

• version (Version) —

  Version that contains the resource

• account_sid (String) —

  The account_sid

• sid (String) —

  The queue Sid that uniquely identifies this resource

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

def initialize(version, account_sid, sid)
  super(version)

  # Path Solution
  @solution = {account_sid: account_sid, sid: sid, }
  @uri = "/Accounts/#{@solution[:account_sid]}/Queues/#{@solution[:sid]}.json"

  # Dependents
  @members = nil
end

Instance Method Details

#delete ⇒ Boolean

Deletes the QueueInstance

Returns:

• (Boolean) —

  true if delete succeeds, true otherwise

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

def delete
  @version.delete('delete', @uri)
end

#fetch ⇒ QueueInstance

Fetch a QueueInstance

Returns:

• (QueueInstance) —

  Fetched QueueInstance

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

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  QueueInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
end

#members(call_sid = :unset) ⇒ MemberList, MemberContext

Access the members

Returns:

• (MemberList)
• (MemberContext) —

  if call_sid was passed.

Raises:

• (ArgumentError)

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

def members(call_sid=:unset)
  raise ArgumentError, 'call_sid cannot be nil' if call_sid.nil?

  if call_sid != :unset
    return MemberContext.new(@version, @solution[:account_sid], @solution[:sid], call_sid, )
  end

  unless @members
    @members = MemberList.new(
        @version,
        account_sid: @solution[:account_sid],
        queue_sid: @solution[:sid],
    )
  end

  @members
end

#to_s ⇒ Object

Provide a user friendly representation

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

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Api.V2010.QueueContext #{context}>"
end

#update(friendly_name: :unset, max_size: :unset) ⇒ QueueInstance

Update the QueueInstance

Parameters:

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

  A human readable description of the queue

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

  The maximum number of members that can be in the queue at a time

Returns:

• (QueueInstance) —

  Updated QueueInstance

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

def update(friendly_name: :unset, max_size: :unset)
  data = Twilio::Values.of({'FriendlyName' => friendly_name, 'MaxSize' => max_size, })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  QueueInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
end