Differential D21772 Diff 51894 src/applications/transactions/conduit/TransactionSearchConduitAPIMethod.php

Changeset View

Standalone View

src/applications/transactions/conduit/TransactionSearchConduitAPIMethod.php

Show All 9 Lines	final class TransactionSearchConduitAPIMethod
public function getMethodDescription() {		public function getMethodDescription() {
return pht(		return pht(
'Read transactions and comments for a particular object '.		'Read transactions and comments for a particular object '.
'or an entire object type.');		'or an entire object type.');
}		}

protected function newDocumentationPages(PhabricatorUser $viewer) {		protected function newDocumentationPages(PhabricatorUser $viewer) {
$markup = pht(<<<EOREMARKUP		$markup = pht(<<<EOREMARKUP
When an object (like a task) is edited, Phabricator creates a "transaction"		When an object (like a task) is edited, the relevant application creates a
and applies it. This list of transactions on each object is the basis for		"transaction" and applies it. This list of transactions on each object is the
essentially all edits and comments in Phabricator. Reviewing the transaction		basis for essentially all edits and comments. Reviewing the transaction
record allows you to see who edited an object, when, and how their edit changed		record allows you to see who edited an object, when, and how their edit changed
things.		things.

One common reason to call this method is that you're implmenting a webhook and		One common reason to call this method is that you're implmenting a webhook and
just received a notification that an object has changed. See the Webhooks		just received a notification that an object has changed. See the Webhooks
documentation for more detailed discussion of this use case.		documentation for more detailed discussion of this use case.

One Object Type at a Time		One Object Type at a Time
▲ Show 20 Lines • Show All 389 Lines • Show Last 20 Lines