Search moodle.org's
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.
   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  
  18  /**
  19   * Airnotifier external functions and service definitions.
  20   *
  21   * @package    message_airnotifier
  22   * @category   webservice
  23   * @copyright  2012 Jerome Mouneyrac
  24   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  25   */
  26  
  27  $functions = array(
  28      'message_airnotifier_is_system_configured' => array(
  29          'classname'   => 'message_airnotifier_external',
  30          'methodname'  => 'is_system_configured',
  31          'classpath'   => 'message/output/airnotifier/externallib.php',
  32          'description' => 'Check whether the airnotifier settings have been configured',
  33          'type'        => 'read',
  34          'services'    => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
  35      ),
  36  
  37      'message_airnotifier_are_notification_preferences_configured' => array(
  38          'classname'   => 'message_airnotifier_external',
  39          'methodname'  => 'are_notification_preferences_configured',
  40          'classpath'   => 'message/output/airnotifier/externallib.php',
  41          'description' => 'Check if the users have notification preferences configured yet',
  42          'type'        => 'read',
  43          'services'    => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
  44      ),
  45      'message_airnotifier_get_user_devices' => array(
  46          'classname'   => 'message_airnotifier_external',
  47          'methodname'  => 'get_user_devices',
  48          'classpath'   => 'message/output/airnotifier/externallib.php',
  49          'description' => 'Return the list of mobile devices that are registered in Moodle for the given user',
  50          'type'        => 'read',
  51          'services'    => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
  52      ),
  53      'message_airnotifier_enable_device' => array(
  54          'classname'    => 'message_airnotifier_external',
  55          'methodname'   => 'enable_device',
  56          'classpath'    => 'message/output/airnotifier/externallib.php',
  57          'description'  => 'Enables or disables a registered user device so it can receive Push notifications',
  58          'type'         => 'write',
  59          'capabilities' => 'message/airnotifier:managedevice',
  60          'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
  61      ),
  62  );