Difference between revisions of "ClassObjectsMethods"

From Request Tracker Wiki
Jump to navigation Jump to search
(→‎TransactionObj: Indent fixed in nowiki elements, CreatorObj added (not sure if the CreatorObj should get a separate headline))
(→‎Class, Objects and Methods - RT: Separate entries for QueueObj and CreatorObj. Indent fixed. Content added.)
Line 29: Line 29:
 
* Steal
 
* Steal
 
* CommentEmailRecord
 
* CommentEmailRecord
    </nowiki>
+
      </nowiki>
  
 
* Field:
 
* Field:
Line 57: Line 57:
 
* FinalPriority
 
* FinalPriority
 
* Queue
 
* Queue
    </nowiki>
+
      </nowiki>
 +
 
 +
* CreatorObj (see CreatorObj on this page)
 +
 
 +
=== CreatorObj ===
 +
 
 +
This object represents the Creator of a transaction.
  
* CreatorObj:
 
 
  <nowiki>* Name
 
  <nowiki>* Name
 
* RealName
 
* RealName
 
* CorrespondAddress
 
* CorrespondAddress
 +
* EmailAddress
 
* (To be completed)
 
* (To be completed)
    </nowiki>
+
      </nowiki>
  
 
=== TicketObj ===
 
=== TicketObj ===
Line 73: Line 79:
  
 
* Priority: priority value of the ticket
 
* Priority: priority value of the ticket
* QueueObj: Queue Object
+
* QueueObj: sehe QueueObj on this page
** Name: Name of the queue
+
 
** (More to be added)
+
=== QueueObj ===
 +
 
 +
This object represents a Queue.
 +
 
 +
<nowiki>* Name
 +
* Description
 +
* id
 +
* InitialPriority
 +
* FinalPriority
 +
* DefaultDueIn
 +
* Encrypt
 +
* Sign
 +
* (More to be added)
 +
  </nowiki>
  
 
Usage example in a scrip:
 
Usage example in a scrip:
 +
<nowiki>
 
  if ($self->TicketObj->QueueObj->Name eq 'Incident') {
 
  if ($self->TicketObj->QueueObj->Name eq 'Incident') {
 
     # do something
 
     # do something
 
  }
 
  }
 +
</nowiki>
 
Execute code (do something) if Queue Name equals "Incident".
 
Execute code (do something) if Queue Name equals "Incident".
  

Revision as of 15:26, 4 April 2011

Class, Objects and Methods - RT

In this page, We will discuss all methods and objects implemented at RT. We pretend to help on the development of the scrips.

$self:

TransactionObj

This object represents one transaction of the RT (something likes create a ticket, comment a ticket, etc).

TransactionObj Properties:

  • Type: returns the transaction's type. Values: * Create: when the transaction is a creation of the ticket</li> <li>Resolve: when the transacion is a resolution of the ticket</li> <li>Set</li> <li>CustomField</li> <li>EmailRecord</li> <li>Comment</li> <li>Status</li> <li>AddLink</li> <li>DeleteLink</li> <li>Take</li> <li>Give</li> <li>Told</li> <li>Correspond</li> <li>AddWatcher</li> <li>Steal</li> <li>CommentEmailRecord
  • Field: * Password</li> <li>Status</li> <li>RefersTo</li> <li>Owner</li> <li>Told</li> <li>Description</li> <li>Priority</li> <li>TimeLeft</li> <li>AdminCc</li> <li>DependsOn</li> <li>Lang</li> <li>DependedOnBy</li> <li>Subject</li> <li>HasComponent</li> <li>ComponentOf</li> <li>TimeEstimated</li> <li>MergedInto</li> <li>ReferredToBy</li> <li>Starts</li> <li>Started</li> <li>Due</li> <li>Requestor</li> <li>FinalPriority</li> <li>Queue
  • CreatorObj (see CreatorObj on this page)

CreatorObj

This object represents the Creator of a transaction.

* Name * RealName * CorrespondAddress * EmailAddress * (To be completed)

TicketObj

This object represents the ticket at a transaction.

TicketObj Properties:

  • Priority: priority value of the ticket
  • QueueObj: sehe QueueObj on this page

QueueObj

This object represents a Queue.

* Name * Description * id * InitialPriority * FinalPriority * DefaultDueIn * Encrypt * Sign * (More to be added)

Usage example in a scrip:

 if ($self->TicketObj->QueueObj->Name eq 'Incident') {
    # do something
 }
 

Execute code (do something) if Queue Name equals "Incident".

See also

GlobalObjects, ObjectModel, Documentation