message_popup_external Class Reference

External message popup API. More...

Inheritance diagram for message_popup_external:

Static Public Member Functions
static	get_popup_notifications ($useridto, $newestfirst, $limit, $offset)
	Get notifications function.
static	get_popup_notifications_parameters ()
	Get popup notifications parameters description.
static	get_popup_notifications_returns ()
	Get notifications return description.
static	get_unread_popup_notification_count ($useridto)
	Get unread notification count function.
static	get_unread_popup_notification_count_parameters ()
	Get unread notification count parameters description.
static	get_unread_popup_notification_count_returns ()
	Get unread popup notification count return description.

Detailed Description

External message popup API.

Copyright

2016 Ryan Wyllie ryan@.nosp@m.mood.nosp@m.le.co.nosp@m.m

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later Message external functions

Copyright

2016 Ryan Wyllie ryan@.nosp@m.mood.nosp@m.le.co.nosp@m.m

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

get_popup_notifications()

static message_popup_external::get_popup_notifications ( $useridto, $newestfirst, $limit, $offset )

static

Get notifications function.

Since

3.2

Exceptions

invalid_parameter_exception
moodle_exception

Parameters

int	$useridto	the user id who received the message
bool	$newestfirst	true for ordering by newest first, false for oldest first
int	$limit	the number of results to return
int	$offset	offset the result set by a given amount

Return values

core_external\external_description

get_popup_notifications_parameters()

static message_popup_external::get_popup_notifications_parameters ( )

static

Get popup notifications parameters description.

Return values

external_function_parameters

Since

3.2

get_popup_notifications_returns()

static message_popup_external::get_popup_notifications_returns ( )

static

Get notifications return description.

Return values

external_single_structure

Since

3.2

get_unread_popup_notification_count()

static message_popup_external::get_unread_popup_notification_count ( $useridto )

static

Get unread notification count function.

Since

3.2

Exceptions

invalid_parameter_exception
moodle_exception

Parameters

int

$useridto

the user id who received the message

Return values

core_external\external_description

get_unread_popup_notification_count_parameters()

static message_popup_external::get_unread_popup_notification_count_parameters ( )

static

Get unread notification count parameters description.

Return values

external_function_parameters

Since

3.2

get_unread_popup_notification_count_returns()

static message_popup_external::get_unread_popup_notification_count_returns ( )

static

Get unread popup notification count return description.

Return values

external_single_structure

Since

3.2

---

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

• message/output/popup/externallib.php