Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
message_airnotifier_external Class Reference
Inheritance diagram for message_airnotifier_external:

Static Public Member Functions

static are_notification_preferences_configured ($userids)
 Check if the users have notification preferences configured for the airnotifier plugin.
 
static are_notification_preferences_configured_parameters ()
 Returns description of method parameters.
 
static are_notification_preferences_configured_returns ()
 Returns description of method result value.
 
static enable_device ($deviceid, $enable)
 Enables or disables a registered user device so it can receive Push notifications.
 
static enable_device_parameters ()
 Returns description of method parameters.
 
static enable_device_returns ()
 Returns description of method result value.
 
static get_user_devices ($appid, $userid=0)
 Return the list of mobile devices that are registered in Moodle for the given user.
 
static get_user_devices_parameters ()
 Returns description of method parameters.
 
static get_user_devices_returns ()
 Returns description of method result value.
 
static is_system_configured ()
 Tests whether the airnotifier settings have been configured.
 
static is_system_configured_parameters ()
 Returns description of method parameters.
 
static is_system_configured_returns ()
 Returns description of method result value.
 

Detailed Description

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
Since
Moodle 2.7

Member Function Documentation

◆ are_notification_preferences_configured()

static message_airnotifier_external::are_notification_preferences_configured ( $userids)
static

Check if the users have notification preferences configured for the airnotifier plugin.

Parameters
array$useridsArray of user ids
Since
Moodle 2.7

◆ are_notification_preferences_configured_parameters()

static message_airnotifier_external::are_notification_preferences_configured_parameters ( )
static

Returns description of method parameters.

Since
Moodle 2.7

◆ are_notification_preferences_configured_returns()

static message_airnotifier_external::are_notification_preferences_configured_returns ( )
static

Returns description of method result value.

Return values
external_single_structure
Since
Moodle 2.7

◆ enable_device()

static message_airnotifier_external::enable_device ( $deviceid,
$enable )
static

Enables or disables a registered user device so it can receive Push notifications.

Parameters
integer$deviceidthe device id
bool$enablewhether to enable the device
Return values
arraywarnings and success status
Exceptions
moodle_exception
Since
Moodle 3.2

◆ enable_device_parameters()

static message_airnotifier_external::enable_device_parameters ( )
static

Returns description of method parameters.

Since
Moodle 3.2

◆ enable_device_returns()

static message_airnotifier_external::enable_device_returns ( )
static

Returns description of method result value.

Return values
external_single_structure
Since
Moodle 3.2

◆ get_user_devices()

static message_airnotifier_external::get_user_devices ( $appid,
$userid = 0 )
static

Return the list of mobile devices that are registered in Moodle for the given user.

Parameters
string$appidapp unique id (usually a reversed domain)
integer$useridthe user id, 0 for current user
Return values
arraywarnings and devices
Exceptions
moodle_exception
Since
Moodle 3.2

◆ get_user_devices_parameters()

static message_airnotifier_external::get_user_devices_parameters ( )
static

Returns description of method parameters.

Since
Moodle 3.2

◆ get_user_devices_returns()

static message_airnotifier_external::get_user_devices_returns ( )
static

Returns description of method result value.

Return values
external_single_structure
Since
Moodle 3.2

◆ is_system_configured()

static message_airnotifier_external::is_system_configured ( )
static

Tests whether the airnotifier settings have been configured.

Since
Moodle 2.7

◆ is_system_configured_parameters()

static message_airnotifier_external::is_system_configured_parameters ( )
static

Returns description of method parameters.

Since
Moodle 2.7

◆ is_system_configured_returns()

static message_airnotifier_external::is_system_configured_returns ( )
static

Returns description of method result value.

Return values
external_single_structure
Since
Moodle 2.7

The documentation for this class was generated from the following file: