RT::Queue(3)

NAME
  RT::Queue - an RT Queue object

SYNOPSIS
  use RT::Queue;

DESCRIPTION

METHODS

  StatusArray
Returns an array of all statuses for this queue

  IsValidStatus VALUE
Returns true if VALUE is a valid status. Otherwise, returns 0

  Create
Create takes the name of the new queue If you pass the ACL check, it creates the queue and returns its queue id.

  SetDisabled
Takes a boolean. 1 will cause this queue to no longer be avaialble for tickets. 0 will re-enable this queue

  Load
Takes either a numerical id or a textual Name and loads the specified queue.

  ValidateName NAME
Takes a queue name. Returns true if it's an ok name for a new queue. Returns undef if there's already a queue by that name.

  Templates
Returns an RT::Templates object of all of this queue's templates.

  Watchers
Watchers returns a Watchers object preloaded with this queue\'s watchers.

  WatchersAsString
Returns a string of all queue watchers email addresses concatenated with ','s.

  AdminCcAsString
Takes nothing. returns a string: All Ticket/Queue AdminCcs.

  CcAsString
Returns String: All Queue Ccs as a comma delimited set of email addresses.

  Cc
Takes nothing. Returns a watchers object which contains this queue\'s Cc watchers

  AdminCc
Takes nothing. Returns this queue's administrative Ccs as an RT::Watchers object

  IsWatcher
Takes a param hash with the attributes Type and User. User is either a user object or string containing an email address. Returns true if that user or string is a queue watcher. Returns undef otherwise

  IsCc
Takes a string. Returns true if the string is a Cc watcher of the current queue

Bugs
    Should also be able to handle an RT::User object

  IsAdminCc
Takes a string. Returns true if the string is an AdminCc watcher of the current queue

Bugs
    Should also be able to handle an RT::User object

  AddWatcher
Takes a paramhash of Email, Owner and Type. Type is one of 'Cc' or 'AdminCc', We need either an Email Address in Email or a userid in Owner

  AddCc
Add a Cc to this queue. Takes a paramhash of Email and Owner. We need either an Email Address in Email or a userid in Owner

  AddAdminCc
Add an Administrative Cc to this queue. Takes a paramhash of Email and Owner. We need either an Email Address in Email or a userid in Owner

  DeleteWatcher id [type]
DeleteWatcher takes a single argument which is either an email address or a watcher id. If the first argument is an email address, you need to specify the watcher type you're talking about as the second argument. Valid values are 'Cc' or 'AdminCc'. It removes that watcher from this Queue\'s list of watchers.

  DeleteCc EMAIL
Takes an email address. It calls DeleteWatcher with a preset type of 'Cc'

  DeleteAdminCc EMAIL
Takes an email address. It calls DeleteWatcher with a preset type of 'AdminCc'

  AddKeywordSelect
Takes a paramhash of Name, Keyword, Depth and Single. Adds a new KeywordSelect for this queue with those attributes.

  KeywordSelect([NAME])
Takes the name of a keyword select for this queue or that's global. Returns the relevant KeywordSelect object. Prefers a keywordselect that's specific to this queue over a global one. If it can't find the proper Keword select or the user doesn't have permission, returns an empty KeywordSelect object

  KeywordSelects
Returns an RT::KeywordSelects object containing the collection of RT::KeywordSelect objects which apply to this queue. (Both queue specific keyword selects and global keyword selects.

  ACL
#Returns an RT::ACL object of ACEs everyone who has anything to do with this queue.

  CurrentUserHasRight
Takes one argument. A textual string with the name of the right we want to check. Returns true if the current user has that right for this queue. Returns undef otherwise.

  HasRight
Takes a param hash with the fields 'Right' and 'Principal'. Principal defaults to the current user. Returns true if the principal has that right for this queue. Returns undef otherwise.

POD ERRORS
Hey! The above document had some coding errors, which are explained below:

Around line 468:
    '=item' outside of any '=over'

Around line 487:
    You forgot a '=back' before '=head2'

Around line 491:
    '=item' outside of any '=over'

Around line 511:
    You forgot a '=back' before '=head2'