Page MenuHomeIsabelle/Phabricator

abstract class ConduitAPIMethod
Phabricator Technical Documentation (Conduit)

This class is not documented.

Tasks

Method Information

  • public function getMethodSummary() — Get a short, human-readable text summary of the method.
  • abstract public function getMethodDescription() — Get a detailed description of the method.

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

Other Methods

Methods

public function getMethodSummary()

Get a short, human-readable text summary of the method.

Return
stringShort summary of method.

abstract public function getMethodDescription()

Get a detailed description of the method.

This method should return remarkup.

Return
stringDetailed description of the method.

public function getMethodDocumentation()

This method is not documented.
Return
wild

abstract protected function defineParamTypes()

This method is not documented.
Return
wild

abstract protected function defineReturnType()

This method is not documented.
Return
wild

protected function defineErrorTypes()

This method is not documented.
Return
wild

abstract protected function execute($request)

This method is not documented.
Parameters
ConduitAPIRequest$request
Return
wild

public function isInternalAPI()

This method is not documented.
Return
wild

public function getParamTypes()

This method is not documented.
Return
wild

public function getReturnType()

This method is not documented.
Return
wild

public function getErrorTypes()

This method is not documented.
Return
wild

public function getID()

This is mostly for compatibility with PhabricatorCursorPagedPolicyAwareQuery.

Return
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".

Return
constMETHOD_STATUS_* constant.

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.

Return
string|nullDescription of the method status, if available.

public function getErrorDescription($error_code)

This method is not documented.
Parameters
$error_code
Return
wild

public function getRequiredScope()

This method is not documented.
Return
wild

public function executeMethod($request)

This method is not documented.
Parameters
ConduitAPIRequest$request
Return
wild

abstract public function getAPIMethodName()

This method is not documented.
Return
wild

public function getSortOrder()

Return a key which sorts methods by application name, then method status, then method name.

Return
wild

public static function getMethodStatusMap()

This method is not documented.
Return
wild

public function getApplicationName()

This method is not documented.
Return
wild

public static function loadAllConduitMethods()

This method is not documented.
Return
wild

private static function newClassMapQuery()

This method is not documented.
Return
wild

public static function getConduitMethod($method_name)

This method is not documented.
Parameters
$method_name
Return
wild

public function shouldRequireAuthentication()

This method is not documented.
Return
wild

public function shouldAllowPublic()

This method is not documented.
Return
wild

public function shouldAllowUnguardedWrites()

This method is not documented.
Return
wild

public function getApplication()

Optionally, return a PhabricatorApplication which this call is part of. The call will be disabled when the application is uninstalled.

Return
PhabricatorApplication|nullRelated application.

protected function formatStringConstants($constants)

This method is not documented.
Parameters
$constants
Return
wild

public static function getParameterMetadataKey($key)

This method is not documented.
Parameters
$key
Return
wild

final public function setViewer($viewer)

This method is not documented.
Parameters
PhabricatorUser$viewer
Return
wild

final public function getViewer()

This method is not documented.
Return
wild

protected function getPagerParamTypes()

This method is not documented.
Return
wild

protected function newPager($request)

This method is not documented.
Parameters
ConduitAPIRequest$request
Return
wild

protected function addPagerResults($results, $pager)

This method is not documented.
Parameters
array$results
AphrontCursorPagerView$pager
Return
wild

public function newQueryObject()

This method is not documented.
Return
wild

protected function newQueryForRequest($request)

This method is not documented.
Parameters
ConduitAPIRequest$request
Return
wild

public function getPHID()

This method is not documented.
Return
wild

public function getCapabilities()

This method is not documented.
Return
wild

public function getPolicy($capability)

This method is not documented.
Parameters
$capability
Return
wild

public function hasAutomaticCapability($capability, $viewer)

This method is not documented.
Parameters
$capability
PhabricatorUser$viewer
Return
wild

protected function hasApplicationCapability($capability, $viewer)

This method is not documented.
Parameters
$capability
PhabricatorUser$viewer
Return
wild

protected function requireApplicationCapability($capability, $viewer)

This method is not documented.
Parameters
$capability
PhabricatorUser$viewer
Return
wild

final protected function newRemarkupDocumentationView($remarkup)

This method is not documented.
Parameters
$remarkup
Return
wild