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))
Line 14: Line 14:
  
 
  <nowiki>* Create: when the transaction is a creation of the ticket
 
  <nowiki>* Create: when the transaction is a creation of the ticket
* Resolve: when the transacion is a resolution of the ticket
+
* Resolve: when the transacion is a resolution of the ticket
  * Set
+
* Set
  * CustomField
+
* CustomField
  * EmailRecord
+
* EmailRecord
  * Comment
+
* Comment
  * Status
+
* Status
  * AddLink
+
* AddLink
  * DeleteLink
+
* DeleteLink
  * Take
+
* Take
  * Give
+
* Give
  * Told
+
* Told
  * Correspond
+
* Correspond
  * AddWatcher
+
* AddWatcher
  * Steal
+
* Steal
  * CommentEmailRecord
+
* CommentEmailRecord
</nowiki>
+
    </nowiki>
  
 
* Field:
 
* Field:
  
 
  <nowiki>* Password
 
  <nowiki>* Password
* Status
+
* Status
* RefersTo
+
* RefersTo
* Owner
+
* Owner
* Told
+
* Told
* Description
+
* Description
* Priority
+
* Priority
* TimeLeft
+
* TimeLeft
* AdminCc
+
* AdminCc
* DependsOn
+
* DependsOn
* Lang
+
* Lang
* DependedOnBy
+
* DependedOnBy
* Subject
+
* Subject
* HasComponent
+
* HasComponent
* ComponentOf
+
* ComponentOf
* TimeEstimated
+
* TimeEstimated
* MergedInto
+
* MergedInto
* ReferredToBy
+
* ReferredToBy
* Starts
+
* Starts
* Started
+
* Started
* Due
+
* Due
* Requestor
+
* Requestor
* FinalPriority
+
* FinalPriority
* Queue
+
* Queue
  </nowiki>
+
    </nowiki>
 +
 
 +
* CreatorObj:
 +
  <nowiki>* Name
 +
* RealName
 +
* CorrespondAddress
 +
* (To be completed)
 +
    </nowiki>
  
 
=== TicketObj ===
 
=== TicketObj ===

Revision as of 14:51, 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: * Name</li> <li>RealName</li> <li>CorrespondAddress</li> <li>(To be completed)

TicketObj

This object represents the ticket at a transaction.

TicketObj Properties:

  • Priority: priority value of the ticket
  • QueueObj: Queue Object
      • Name: Name of the queue
      • (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