public function getMethodSummary()Inherited
Get a short, human-readable text summary of the method.
string | Short summary of method. |
abstract public function getMethodDescription()Inherited
Get a detailed description of the method.
This method should return remarkup.
string | Detailed description of the method. |
public function getMethodDocumentation()Inherited
wild |
abstract protected function defineParamTypes()Inherited
wild |
abstract protected function defineReturnType()Inherited
wild |
protected function defineErrorTypes()Inherited
wild |
abstract protected function execute($request)Inherited
ConduitAPIRequest | $request |
wild |
public function isInternalAPI()Inherited
wild |
public function getParamTypes()Inherited
wild |
public function getReturnType()Inherited
wild |
public function getErrorTypes()Inherited
wild |
public function getID()Inherited
This is mostly for compatibility with PhabricatorCursorPagedPolicyAwareQuery.
wild |
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".
const | METHOD_STATUS_* constant. |
public function getMethodStatusDescription()Inherited
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.
string|null | Description of the method status, if available. |
public function getErrorDescription($error_code)Inherited
$error_code |
wild |
public function getRequiredScope()Inherited
wild |
public function executeMethod($request)Inherited
ConduitAPIRequest | $request |
wild |
abstract public function getAPIMethodName()Inherited
wild |
public function getSortOrder()Inherited
Return a key which sorts methods by application name, then method status, then method name.
wild |
public static function getMethodStatusMap()Inherited
wild |
public function getApplicationName()Inherited
wild |
public static function loadAllConduitMethods()Inherited
wild |
private static function newClassMapQuery()Inherited
wild |
public static function getConduitMethod($method_name)Inherited
$method_name |
wild |
public function shouldRequireAuthentication()Inherited
wild |
public function shouldAllowPublic()Inherited
wild |
public function shouldAllowUnguardedWrites()Inherited
wild |
final public function getApplication()
Optionally, return a PhabricatorApplication which this call is part of. The call will be disabled when the application is uninstalled.
PhabricatorApplication|null | Related application. |
protected function formatStringConstants($constants)Inherited
$constants |
wild |
public static function getParameterMetadataKey($key)Inherited
$key |
wild |
final public function setViewer($viewer)Inherited
PhabricatorUser | $viewer |
wild |
final public function getViewer()Inherited
wild |
protected function getPagerParamTypes()Inherited
wild |
protected function newPager($request)Inherited
ConduitAPIRequest | $request |
wild |
protected function addPagerResults($results, $pager)Inherited
array | $results | |
AphrontCursorPagerView | $pager |
wild |
public function newQueryObject()Inherited
wild |
protected function newQueryForRequest($request)Inherited
ConduitAPIRequest | $request |
wild |
public function getPHID()Inherited
wild |
public function getCapabilities()Inherited
wild |
public function getPolicy($capability)Inherited
$capability |
wild |
public function hasAutomaticCapability($capability, $viewer)Inherited
$capability | ||
PhabricatorUser | $viewer |
wild |
protected function hasApplicationCapability($capability, $viewer)Inherited
$capability | ||
PhabricatorUser | $viewer |
wild |
protected function requireApplicationCapability($capability, $viewer)Inherited
$capability | ||
PhabricatorUser | $viewer |
wild |
final protected function newRemarkupDocumentationView($remarkup)Inherited
$remarkup |
wild |
public function buildTokenDicts($tokens)
array | $tokens |
wild |
public function buildTokenGivenDicts($tokens_given)
array | $tokens_given |
wild |