Method Information
Method Information
- public function getMethodSummary() — Get a short, human-readable text summary of the method.
- final public function getMethodDescription()
Method Status
Method Status
- public function getMethodStatus() — Get the status for this method (e.g., stable, unstable or deprecated). Should return a METHOD_STATUS_* constant. By default, methods are "stable".
- public function getMethodStatusDescription() — Optional description to supplement the method status. In particular, if a method is deprecated, you can return a string here describing the reason for deprecation and stable alternatives.
Paging Results
Paging Results
- protected function getPagerParamTypes()
- protected function newPager($request)
- protected function addPagerResults($results, $pager)
Other Methods
Other Methods
- final public function getDocumentationPages($viewer)
- final protected function newDocumentationPages($viewer)
- final protected function newDocumentationPage($viewer)
- final protected function newDocumentationBoxPage($viewer, $title, $content)
- final protected function defineParamTypes()
- final protected function defineReturnType()
- protected function defineErrorTypes()
- final protected function execute($request)
- public function isInternalAPI()
- public function getParamTypes()
- public function getReturnType()
- public function getErrorTypes()
- public function getID() — This is mostly for compatibility with @{class:PhabricatorCursorPagedPolicyAwareQuery}.
- public function getErrorDescription($error_code)
- public function getRequiredScope()
- public function executeMethod($request)
- protected function newConduitCallProxyClient($request)
- abstract public function getAPIMethodName()
- public function getSortOrder() — Return a key which sorts methods by application name, then method status, then method name.
- public static function getMethodStatusMap()
- public function getApplicationName()
- public static function loadAllConduitMethods()
- private static function newClassMapQuery()
- public static function getConduitMethod($method_name)
- public function shouldRequireAuthentication() — Whether to require a session key for calling the API method.
- public function shouldAllowPublic() — Whether to allow public access. Related to the `policy.allow-public` global setting and policies set for the corresponding application.
- public function shouldAllowUnguardedWrites() — Whether not to guard writes against CSRF. See @{class:AphrontWriteGuard}.
- public function getApplication()
- protected function formatStringConstants($constants)
- public static function getParameterMetadataKey($key)
- final public function setViewer($viewer)
- final public function getViewer()
- public function newQueryObject()
- protected function newQueryForRequest($request)
- public function getPHID()
- public function getCapabilities()
- public function getPolicy($capability)
- public function hasAutomaticCapability($capability, $viewer)
- protected function hasApplicationCapability($capability, $viewer)
- protected function requireApplicationCapability($capability, $viewer)
- final protected function newRemarkupDocumentationView($remarkup)
- abstract public function newSearchEngine()
- final public function getQueryMaps($query)
- protected function getCustomQueryMaps($query)
- private function buildQueriesDocumentationPage($viewer, $engine)
- private function buildConstraintsDocumentationPage($viewer, $engine)
- private function buildOrderDocumentationPage($viewer, $engine, $query)
- private function buildFieldsDocumentationPage($viewer, $engine)
- private function buildAttachmentsDocumentationPage($viewer, $engine)
- private function buildPagingDocumentationPage($viewer, $engine)