Difference between revisions of "ClassObjectsMethods"

From Request Tracker Wiki
Jump to navigation Jump to search
(→‎Class, Objects and Methods - RT: Separate entries for QueueObj and CreatorObj. Indent fixed. Content added.)
m (9 revisions imported)
 
(4 intermediate revisions by 3 users not shown)
Line 12: Line 12:


* Type: returns the transaction's type. Values:
* Type: returns the transaction's type. Values:
 
** Create: when the transaction is a creation of the ticket
<nowiki>* Create: when the transaction is a creation of the ticket
** Resolve: when the transaction 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>


* Field:
* Field:
 
** 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>


* CreatorObj (see CreatorObj on this page)
* CreatorObj (see CreatorObj on this page)
Line 66: Line 62:


  <nowiki>* Name
  <nowiki>* Name
* RealName
* RealName
* CorrespondAddress
* CorrespondAddress
* EmailAddress
* EmailAddress
* (To be completed)
* (To be completed)
      </nowiki>
      </nowiki>


=== TicketObj ===
=== TicketObj ===
Line 79: Line 75:


* Priority: priority value of the ticket
* Priority: priority value of the ticket
* QueueObj: sehe QueueObj on this page
* QueueObj: see QueueObj on this page
* OwnerObj: see OwnerObj on this page
* Status: current status of the ticket
* RequestorAddresses: Addresses of the requestors
* Transactions: The transactions on this ticket. $Ticket->Transactions->First is a TransactionObj


=== QueueObj ===
=== QueueObj ===
Line 86: Line 86:


  <nowiki>* Name
  <nowiki>* Name
* Description
* Description
* id
* id
* InitialPriority
* InitialPriority
* FinalPriority
* FinalPriority
* DefaultDueIn
* DefaultDueIn
* Encrypt
* Encrypt
* Sign
* Sign
* (More to be added)
* (More to be added)
  </nowiki>
  </nowiki>


Usage example in a scrip:
Usage example in a scrip:
  <nowiki>
  <nowiki>
if ($self->TicketObj->QueueObj->Name eq 'Incident') {
  if ($self->TicketObj->QueueObj->Name eq 'Incident') {
    # do something
    # do something
}
  }
</nowiki>
  </nowiki>
Execute code (do something) if Queue Name equals "Incident".
Execute code (do something) if Queue Name equals "Incident".



Latest revision as of 16:03, 6 April 2016

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).

  • Type: returns the transaction's type. Values:
    • Create: when the transaction is a creation of the ticket
    • Resolve: when the transaction is a resolution of the ticket
    • Set
    • CustomField
    • EmailRecord
    • Comment
    • Status
    • AddLink
    • DeleteLink
    • Take
    • Give
    • Told
    • Correspond
    • AddWatcher
    • Steal
    • CommentEmailRecord
  • Field:
    • Password
    • Status
    • RefersTo
    • Owner
    • Told
    • Description
    • Priority
    • TimeLeft
    • AdminCc
    • DependsOn
    • Lang
    • DependedOnBy
    • Subject
    • HasComponent
    • ComponentOf
    • TimeEstimated
    • MergedInto
    • ReferredToBy
    • Starts
    • Started
    • Due
    • Requestor
    • FinalPriority
    • 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.

  • Priority: priority value of the ticket
  • QueueObj: see QueueObj on this page
  • OwnerObj: see OwnerObj on this page
  • Status: current status of the ticket
  • RequestorAddresses: Addresses of the requestors
  • Transactions: The transactions on this ticket. $Ticket->Transactions->First is a TransactionObj

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