rt::client::rest::queue(3pm) [debian man page]

RT::Client::REST::Queue(3pm)				User Contributed Perl Documentation			      RT::Client::REST::Queue(3pm)

NAME

       RT::Client::REST::Queue -- queue object representation.

SYNOPSIS

	 my $rt = RT::Client::REST->new(server => $ENV{RTSERVER});

	 my $queue = RT::Client::REST::Queue->new(
	   rt  => $rt,
	   id  => 'General',
	 )->retrieve;

DESCRIPTION

       RT::Client::REST::Queue is based on RT::Client::REST::Object.  The representation allows one to retrieve, edit, comment on, and create
       queue in RT.

       Note: RT currently does not allow REST client to search queues.

ATTRIBUTES

       id
	 For retrieval, you can specify either the numeric ID of the queue or its name (case-sensitive).  After the retrieval, however, this
	 attribute will be set to the numeric id.

       name
	 This is the name of the queue.

       description
	 Queue description.

       correspond_address
	 Correspond address.

       comment_address
	 Comment address.

       initial_priority
	 Initial priority.

       final_priority
	 Final priority.

       default_due_in
	 Default due in.

DB METHODS

       For full explanation of these, please see "DB METHODS" in RT::Client::REST::Object documentation.

       retrieve
	 Retrieve queue from database.

       store
	 Create or update the queue.

       search
	 Currently RT does not allow REST clients to search queues.

QUEUE-SPECIFIC METHODS
       tickets
	 Get tickets that are in this queue (note: this may be a lot of tickets).  Note: tickets with status "deleted" will not be shown.  Object
	 of type RT::Client::REST::SearchResult is returned which then can be used to get to objects of type RT::Client::REST::Ticket.

INTERNAL METHODS

       rt_type
	 Returns 'queue'.

SEE ALSO

       RT::Client::REST, RT::Client::REST::Object, RT::Client::REST::SearchResult, RT::Client::REST::Ticket.

AUTHOR

       Dmitri Tikhonov <dtikhonov@yahoo.com>

LICENSE

       Perl license with the exception of RT::Client::REST, which is GPLed.

perl v5.14.2							    2012-01-20					      RT::Client::REST::Queue(3pm)