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))
m (9 revisions imported)
 
(5 intermediate revisions by 4 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
** Resolve: when the transaction is a resolution of the ticket
** Set
** CustomField
** EmailRecord
** Comment
** Status
** AddLink
** DeleteLink
** Take
** Give
** Told
** Correspond
** AddWatcher
** Steal
** CommentEmailRecord


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


* Field:
=== CreatorObj ===


<nowiki>* Password
This object represents the Creator of a transaction.
* Status
* RefersTo
* Owner
* Told
* Description
* Priority
* TimeLeft
* AdminCc
* DependsOn
* Lang
* DependedOnBy
* Subject
* HasComponent
* ComponentOf
* TimeEstimated
* MergedInto
* ReferredToBy
* Starts
* Started
* Due
* Requestor
* FinalPriority
* Queue
    </nowiki>


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


=== TicketObj ===
=== TicketObj ===
Line 73: Line 75:


* Priority: priority value of the ticket
* Priority: priority value of the ticket
* QueueObj: Queue Object
* QueueObj: see QueueObj on this page
** Name: Name of the queue
* OwnerObj: see OwnerObj on this page
** (More to be added)
* 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.
 
<nowiki>* Name
* Description
* id
* InitialPriority
* FinalPriority
* DefaultDueIn
* Encrypt
* Sign
* (More to be added)
  </nowiki>


Usage example in a scrip:
Usage example in a scrip:
  if ($self->TicketObj->QueueObj->Name eq 'Incident') {
  <nowiki>
    # do something
  if ($self->TicketObj->QueueObj->Name eq 'Incident') {
}
    # do something
  }
  </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

Retrieved from "https://rt-wiki.bestpractical.com/index.php?title=ClassObjectsMethods&oldid=499"