Scroll to navigation

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

NAME

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

VERSION

version 0.56

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.
cc_addresses
CC Addresses (comma delimited).
admin_cc_addresses
Admin CC Addresses (comma delimited).
cf
Access custom fields. Inherited from RT::Client::REST::Object, where you can read more details.

Trivial example:

 my $queue = RT::Client::REST::Queue->new(
   rt => $rt, id => $queue_id
 )->retrieve();
 my @customfields = $queue->cf();
 for my $f (@customfields) {
   my $v = $queue->cf($f);
   say "field: $f";
   say "value: $v";
 }

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.

AUTHORS

  • Abhijit Menon-Sen <ams@wiw.org>
  • Dmitri Tikhonov <dtikhonov@yahoo.com>
  • Damien "dams" Krotkine <dams@cpan.org>
  • Dean Hamstead <dean@bytefoundry.com.au>
  • Miquel Ruiz <mruiz@cpan.org>
  • JLMARTIN
  • SRVSH

COPYRIGHT AND LICENSE

This software is copyright (c) 2018 by Dmitri Tikhonov.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

2018-12-26 perl v5.28.1