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.
/message/output/popup/ -> externallib.php (source)

[Source view]

Differences Between: [Versions 401 and 402] [Versions 401 and 403]

External message popup API

Copyright: 2016 Ryan Wyllie <ryan@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 239 lines (10 kb)
Included or required:0 times
Referenced: 1 time
Includes or requires: 0 files

Defines 1 class

message_popup_external:: (6 methods):
  get_popup_notifications_parameters()
  get_popup_notifications()
  get_popup_notifications_returns()
  get_unread_popup_notification_count_parameters()
  get_unread_popup_notification_count()
  get_unread_popup_notification_count_returns()


Class: message_popup_external  - X-Ref

Message external functions

get_popup_notifications_parameters()   X-Ref
Get popup notifications parameters description.

return: external_function_parameters

get_popup_notifications($useridto, $newestfirst, $limit, $offset)   X-Ref
Get notifications function.

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

get_popup_notifications_returns()   X-Ref
Get notifications return description.

return: external_single_structure

get_unread_popup_notification_count_parameters()   X-Ref
Get unread notification count parameters description.

return: external_function_parameters

get_unread_popup_notification_count($useridto)   X-Ref
Get unread notification count function.

param: int      $useridto       the user id who received the message
return: external_description

get_unread_popup_notification_count_returns()   X-Ref
Get unread popup notification count return description.

return: external_single_structure