GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

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

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

version 0.60

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

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

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.

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";
 }
    

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.

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.

rt_type
Returns 'queue'.

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

Dmitri Tikhonov

This software is copyright (c) 2020, 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.

2022-04-07 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.