Page MenuHomeClusterLabs Projects
Diviner Tech Docs AlmanacDeviceEditConduitAPIMethod

final class AlmanacDeviceEditConduitAPIMethod
Phorge Technical Documentation (Almanac)

This class is not documented.

Tasks

Method Information

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()

ConduitAPIMethod

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

AlmanacDeviceEditConduitAPIMethod
This method is not documented.
Return
stringShort summary of method.

final public function getMethodDescription()
Inherited

ConduitAPIMethod

Get a detailed description of the method.

This method should return remarkup.

Return
stringDetailed description of the method.

final public function getDocumentationPages($viewer)
Inherited

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

final protected function newDocumentationPages($viewer)
Inherited

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

final protected function newDocumentationPage($viewer)
Inherited

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

final protected function newDocumentationBoxPage($viewer, $title, $content)
Inherited

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

final protected function defineParamTypes()
Inherited

This method is not documented.
Return
wild

final protected function defineReturnType()
Inherited

This method is not documented.
Return
wild

protected function defineErrorTypes()
Inherited

This method is not documented.
Return
wild

final protected function execute($request)
Inherited

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

public function isInternalAPI()
Inherited

This method is not documented.
Return
wild

public function getParamTypes()
Inherited

This method is not documented.
Return
wild

public function getReturnType()
Inherited

This method is not documented.
Return
wild

public function getErrorTypes()
Inherited

This method is not documented.
Return
wild

public function getID()
Inherited

ConduitAPIMethod

This is mostly for compatibility with PhabricatorCursorPagedPolicyAwareQuery.

Return
wild

public function getMethodStatus()
Inherited

ConduitAPIMethod

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()
Inherited

ConduitAPIMethod

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)
Inherited

This method is not documented.
Parameters
$error_code
Return
wild

public function getRequiredScope()
Inherited

This method is not documented.
Return
wild

public function executeMethod($request)
Inherited

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

protected function newConduitCallProxyClient($request)
Inherited

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

public function getAPIMethodName()

This method is not documented.
Return
wild

public function getSortOrder()
Inherited

ConduitAPIMethod

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

Return
wild

public static function getMethodStatusMap()
Inherited

This method is not documented.
Return
wild

public function getApplicationName()
Inherited

This method is not documented.
Return
wild

public static function loadAllConduitMethods()
Inherited

This method is not documented.
Return
wild

private static function newClassMapQuery()
Inherited

This method is not documented.
Return
wild

public static function getConduitMethod($method_name)
Inherited

This method is not documented.
Parameters
$method_name
Return
wild

public function shouldRequireAuthentication()
Inherited

This method is not documented.
Return
wild

public function shouldAllowPublic()
Inherited

This method is not documented.
Return
wild

public function shouldAllowUnguardedWrites()
Inherited

This method is not documented.
Return
wild

public function getApplication()
Inherited

ConduitAPIMethod

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)
Inherited

This method is not documented.
Parameters
$constants
Return
wild

public static function getParameterMetadataKey($key)
Inherited

This method is not documented.
Parameters
$key
Return
wild

final public function setViewer($viewer)
Inherited

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

final public function getViewer()
Inherited

This method is not documented.
Return
wild

protected function getPagerParamTypes()
Inherited

This method is not documented.
Return
wild

protected function newPager($request)
Inherited

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

protected function addPagerResults($results, $pager)
Inherited

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

public function newQueryObject()
Inherited

This method is not documented.
Return
wild

protected function newQueryForRequest($request)
Inherited

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

public function getPHID()
Inherited

This method is not documented.
Return
wild

public function getCapabilities()
Inherited

This method is not documented.
Return
wild

public function getPolicy($capability)
Inherited

This method is not documented.
Parameters
$capability
Return
wild

public function hasAutomaticCapability($capability, $viewer)
Inherited

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

protected function hasApplicationCapability($capability, $viewer)
Inherited

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

protected function requireApplicationCapability($capability, $viewer)
Inherited

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

final protected function newRemarkupDocumentationView($remarkup)
Inherited

This method is not documented.
Parameters
$remarkup
Return
wild

public function newEditEngine()

This method is not documented.
Return
wild

private function buildEditTypesDocumentationPages($viewer, $engine, $types)
Inherited

This method is not documented.
Parameters
PhabricatorUser$viewer
PhabricatorEditEngine$engine
array$types
Return
wild

private function buildRemarkup($remarkup)
Inherited

This method is not documented.
Parameters
$remarkup
Return
wild