RT 4.4.5 Documentation

RT::Queue

  RT::Queue - an RT Queue object

SYNOPSIS

  use RT::Queue;

DESCRIPTION

An RT queue object.

METHODS

Create(ARGS)

Arguments: ARGS is a hash of named parameters. Valid parameters are:

  Name (required)
  Description
  CorrespondAddress
  CommentAddress

If you pass the ACL check, it creates the queue and returns its queue id.

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.

SetSign

Templates

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

CustomField NAME

Load the Ticket Custom Field applied to this Queue named NAME. Does not load Global custom fields.

TicketCustomFields

Returns an RT::CustomFields object containing all global and queue-specific ticket custom fields.

TicketTransactionCustomFields

Returns an RT::CustomFields object containing all global and queue-specific transaction custom fields.

CustomRoles

Returns an RT::CustomRoles object containing all queue-specific roles.

ManageableRoleGroupTypes

Returns a list of the names of the various role group types for Queues, excluding ones used only for ACLs such as Requestor and Owner. If you want them, see "Roles".

IsManageableRoleGroupType

Returns whether the passed-in type is a manageable role group type.

AddWatcher

Applies access control checking, then calls "AddRoleMember" in RT::Record::Role::Roles. Additionally, Email is accepted as an alternative argument name for User.

Returns a tuple of (status, message).

DeleteWatcher

Applies access control checking, then calls "DeleteRoleMember" in RT::Record::Role::Roles. Additionally, Email is accepted as an alternative argument name for User.

Returns a tuple of (status, message).

AdminCcAddresses

returns String: All queue AdminCc email addresses as a string

CcAddresses

returns String: All queue Ccs as a string of email addresses

Cc

Takes nothing. Returns an RT::Group object which contains this Queue's Ccs. If the user doesn't have "ShowQueue" permission, returns an empty group

AdminCc

Takes nothing. Returns an RT::Group object which contains this Queue's AdminCcs. If the user doesn't have "ShowQueue" permission, returns an empty group

IsWatcher { Type => TYPE, PrincipalId => PRINCIPAL_ID }

Takes a param hash with the attributes Type and PrincipalId

Type is one of Requestor, Cc, AdminCc and Owner

PrincipalId is an RT::Principal id

Returns true if that principal is a member of the group Type for this queue

IsCc PRINCIPAL_ID

Takes an RT::Principal id. Returns true if the principal is a requestor of the current queue.

IsAdminCc PRINCIPAL_ID

Takes an RT::Principal id. Returns true if the principal is a requestor of the current queue.

CurrentUserCanSee

Returns true if the current user can see the queue, using SeeQueue

id

Returns the current value of id. (In the database, id is stored as int(11).)

Name

Returns the current value of Name. (In the database, Name is stored as varchar(200).)

SetName VALUE

Set Name to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Name will be stored as a varchar(200).)

Description

Returns the current value of Description. (In the database, Description is stored as varchar(255).)

SetDescription VALUE

Set Description to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Description will be stored as a varchar(255).)

CorrespondAddress

Returns the current value of CorrespondAddress. (In the database, CorrespondAddress is stored as varchar(120).)

SetCorrespondAddress VALUE

Set CorrespondAddress to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, CorrespondAddress will be stored as a varchar(120).)

CommentAddress

Returns the current value of CommentAddress. (In the database, CommentAddress is stored as varchar(120).)

SetCommentAddress VALUE

Set CommentAddress to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, CommentAddress will be stored as a varchar(120).)

Lifecycle [CONTEXT_OBJ]

Returns the current value of Lifecycle.

Provide an optional ticket object as context to check role-level rights in addition to queue-level rights for SeeQueue.

(In the database, Lifecycle is stored as varchar(32).)