Search moodle.org's
Developer Documentation
Developer Documentation
See Release Notes
Long Term Support Release
- Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
- Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
- PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/admin/tool/mobile/classes/ -> external.php (source)
Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401] [Versions 401 and 402] [Versions 401 and 403]
This is the external API for this tool.
| Copyright: | 2016 Juan Leyva |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 761 lines (33 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 2 classes
external:: (13 methods):
get_plugins_supporting_mobile_parameters()
get_plugins_supporting_mobile()
get_plugins_supporting_mobile_returns()
get_public_config_parameters()
get_public_config()
get_public_config_returns()
get_config_parameters()
get_config()
get_config_returns()
get_autologin_key_parameters()
get_autologin_key()
get_autologin_key_returns()
get_content_parameters()
is:: (11 methods):
get_content()
get_content_returns()
call_external_functions_parameters()
call_external_functions()
call_external_functions_returns()
get_tokens_for_qr_login_parameters()
get_tokens_for_qr_login()
get_tokens_for_qr_login_returns()
validate_subscription_key_parameters()
validate_subscription_key()
validate_subscription_key_returns()
This is the external API for this tool.
| get_plugins_supporting_mobile_parameters() X-Ref |
| Returns description of get_plugins_supporting_mobile() parameters. return: external_function_parameters |
| get_plugins_supporting_mobile() X-Ref |
| Returns a list of Moodle plugins supporting the mobile app. return: array an array of warnings and objects containing the plugin information |
| get_plugins_supporting_mobile_returns() X-Ref |
| Returns description of get_plugins_supporting_mobile() result value. return: external_description |
| get_public_config_parameters() X-Ref |
| Returns description of get_public_config() parameters. return: external_function_parameters |
| get_public_config() X-Ref |
| Returns a list of the site public settings, those not requiring authentication. return: array with the settings and warnings |
| get_public_config_returns() X-Ref |
| Returns description of get_public_config() result value. return: external_description |
| get_config_parameters() X-Ref |
| Returns description of get_config() parameters. return: external_function_parameters |
| get_config($section = '') X-Ref |
| Returns a list of site settings, filtering by section. param: string $section settings section name return: array with the settings and warnings |
| get_config_returns() X-Ref |
| Returns description of get_config() result value. return: external_description |
| get_autologin_key_parameters() X-Ref |
| Returns description of get_autologin_key() parameters. return: external_function_parameters |
| get_autologin_key($privatetoken) X-Ref |
| Creates an auto-login key for the current user. Is created only in https sites and is restricted by time and ip address. Please note that it only works if the request comes from the Moodle mobile or desktop app. param: string $privatetoken the user private token for validating the request return: array with the settings and warnings |
| get_autologin_key_returns() X-Ref |
| Returns description of get_autologin_key() result value. return: external_description |
| get_content_parameters() X-Ref |
| Returns description of get_content() parameters return: external_function_parameters |
| get_content($component, $method, $args = array() X-Ref |
| Returns a piece of content to be displayed in the Mobile app, it usually returns a template, javascript and other structured data that will be used to render a view in the Mobile app. Callbacks (placed in \$component\output\mobile) that are called by this web service are responsible for doing the appropriate security checks to access the information to be returned. param: string $component name of the component. param: string $method function method name in class \$component\output\mobile. param: array $args optional arguments for the method. return: array HTML, JavaScript and other required data and information to create a view in the app. |
| get_content_returns() X-Ref |
| Returns description of get_content() result value return: array |
| call_external_functions_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| call_external_functions($requests) X-Ref |
| Call multiple external functions and return all responses. param: array $requests List of requests. return: array Responses. |
| call_external_functions_returns() X-Ref |
| Returns description of method result value return: external_single_structure |
| get_tokens_for_qr_login_parameters() X-Ref |
| Returns description of get_tokens_for_qr_login() parameters. return: external_function_parameters |
| get_tokens_for_qr_login($qrloginkey, $userid) X-Ref |
| Returns a WebService token (and private token) for QR login param: string $qrloginkey the user key generated and embedded into the QR code for validating the request param: int $userid the user the key belongs to return: array with the tokens and warnings |
| get_tokens_for_qr_login_returns() X-Ref |
| Returns description of get_tokens_for_qr_login() result value. return: external_description |
| validate_subscription_key_parameters() X-Ref |
| Returns description of validate_subscription_key() parameters. return: external_function_parameters |
| validate_subscription_key(string $key) X-Ref |
| Check if the given site subscription key is valid param: string $key subscriptiion temporary key return: array with the settings and warnings |
| validate_subscription_key_returns() X-Ref |
| Returns description of validate_subscription_key() result value. return: external_description |
