Differential D25238 Diff 823 src/applications/transactions/conduit/TransactionSearchConduitAPIMethod.php
Changeset View
Changeset View
Standalone View
Standalone View
src/applications/transactions/conduit/TransactionSearchConduitAPIMethod.php
Show All 15 Lines | final class TransactionSearchConduitAPIMethod | ||||
protected function newDocumentationPages(PhabricatorUser $viewer) { | protected function newDocumentationPages(PhabricatorUser $viewer) { | ||||
$markup = pht(<<<EOREMARKUP | $markup = pht(<<<EOREMARKUP | ||||
When an object (like a task) is edited, the relevant application creates a | When an object (like a task) is edited, the relevant application creates a | ||||
"transaction" and applies it. This list of transactions on each object is the | "transaction" and applies it. This list of transactions on each object is the | ||||
basis for essentially all edits and comments. 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 implementing 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 | ||||
========================= | ========================= | ||||
This API method can query transactions for any type of object which supports | This API method can query transactions for any type of object which supports | ||||
transactions, but only one type of object can be queried per call. For example: | transactions, but only one type of object can be queried per call. For example: | ||||
▲ Show 20 Lines • Show All 385 Lines • Show Last 20 Lines |
Content licensed under Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA) unless otherwise noted; code licensed under Apache 2.0 or other open source licenses. · CC BY-SA 4.0 · Apache 2.0