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


Manual Reference Pages  -  RT::CLIENT::REST::ATTACHMENT (3)

.ds Aq ’

NAME

RT::Client::REST::Attachment -- this object represents an attachment.

CONTENTS

SYNOPSIS



  my $attachments = $ticket->attachments;

  my $count = $attachments->count;
  print "There are $count attachments.\n";

  my $iterator = $attachments->get_iterator;
  while (my $att = &$iterator) {
      print "Id: ", $att->id, "; Subject: ", $att->subject, "\n";
  }



DESCRIPTION

An attachment is a second-class citizen, as it does not exist (at least from the current REST protocol implementation) by itself. At the moment, it is always associated with a ticket (see <B>parent_idB> attribute). Thus, you will rarely retrieve an attachment by itself; instead, you should use attachments() method of RT::Client::REST::Ticket object to get an iterator for all attachments for that ticket.

ATTRIBUTES

<B>idB> Numeric ID of the attachment.
<B>creator_idB> Numeric ID of the user who created the attachment.
<B>parent_idB> Numeric ID of the object the attachment is associated with. This is not a proper attribute of the attachment as specified by REST — it is simply to store the ID of the RT::Client::REST::Ticket object this attachment belongs to.
<B>subjectB> Subject of the attachment.
<B>content_typeB> Content type.
<B>file_nameB> File name (if any).
<B>transaction_idB> Numeric ID of the RT::Client::REST::Transaction object this attachment is associated with.
<B>message_idB> Message ID.
<B>createdB> Time when the attachment was created
<B>contentB> Actual content of the attachment.
<B>headersB> Headers (not parsed), if any.
<B>parentB> Parent (not sure what this is yet).
<B>content_encodingB> Content encoding, if any.

METHODS

<B>RT::Client::REST::AttachmentB> is a read-only object, so you cannot store() it. Also, because it is a second-class citizen, you cannot search() or count() it — use attachments() method provided by RT::Client::REST::Ticket.
retrieve To retrieve an attachment, attributes <B>idB> and <B>parent_idB> must be set.

INTERNAL METHODS

<B>rt_typeB> Returns ’attachment’.

SEE ALSO

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

AUTHOR

Dmitri Tikhonov <dtikhonov@yahoo.com>

LICENSE

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


perl v5.20.3 RT::CLIENT::REST::ATTACHMENT (3) 2015-11-27

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