core/check

Check API result functions

Source:
Author:
License:
  • http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
Source:
Author:
License:
  • http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Members

(static, constant) getCheckResult

Source:

Call check_get_result webservice function

Methods

(inner) getAndRender(domSelector, adminTreeId, settingName, includeDetails)

Source:

Get the result of a check and replace a given DOM element with the result.

Parameters:
Name Type Description
domSelector String

A CSS selector for a dom element to replace the the HTML for.

adminTreeId String

Id of the admin_setting that called this webservice. Used to retrieve the check registered to it.

settingName String

Name of setting (used to find the parent node in the admin tree)

includeDetails Boolean

If true, details will be included in the check. By default only the status and the summary is returned.

Check API webservice repository

Source:
Author:
License:
  • http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
Source:
Author:
License:
  • http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Members

(static, constant) getCheckResult

Source:

Call check_get_result webservice function

Methods

(inner) getAndRender(domSelector, adminTreeId, settingName, includeDetails)

Source:

Get the result of a check and replace a given DOM element with the result.

Parameters:
Name Type Description
domSelector String

A CSS selector for a dom element to replace the the HTML for.

adminTreeId String

Id of the admin_setting that called this webservice. Used to retrieve the check registered to it.

settingName String

Name of setting (used to find the parent node in the admin tree)

includeDetails Boolean

If true, details will be included in the check. By default only the status and the summary is returned.