Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
message_popup

Topics

 external
 
 
 test
 
 

Namespaces

namespace  message_popup
 Contains class used to return information to display for the message popup.
 
namespace  message_popup\output
 Contains class used to prepare a popup notification for display.
 
namespace  message_popup\privacy
 Privacy Subsystem implementation for message_popup.
 

Classes

class  message_popup\api
 Class used to return information to display for the message popup. More...
 
class  message_popup\output\popup_notification
 Class to prepare a popup notification for display. More...
 
class  message_popup\privacy\provider
 Privacy Subsystem for message_popup implementing null_provider. More...
 

Functions

 message_popup_render_navbar_output (\renderer_base $renderer)
 Renders the popup.
 
 xmldb_message_popup_install ()
 Installation code for the popup message processor.
 
 xmldb_message_popup_upgrade ($oldversion)
 Upgrade code for the popup message processor.
 

Variables

 $functions
 External functions and service definitions.
 
 $plugin = 2023100400
 
$plugin component = 'message_popup'
 
$plugin version = 2023100900
 

Detailed Description

Function Documentation

◆ message_popup_render_navbar_output()

message_popup_render_navbar_output ( \renderer_base $renderer)

Renders the popup.

Parameters
renderer_base$renderer
Return values
stringThe HTML

◆ xmldb_message_popup_install()

xmldb_message_popup_install ( )

Installation code for the popup message processor.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later Install the popup message processor

◆ xmldb_message_popup_upgrade()

xmldb_message_popup_upgrade ( $oldversion)

Upgrade code for the popup message processor.

Parameters
int$oldversionThe version that we are upgrading from

Variable Documentation

◆ $functions

$functions
Initial value:
= array(
'message_popup_get_popup_notifications' => array(
'classname' => 'message_popup_external',
'methodname' => 'get_popup_notifications',
'classpath' => 'message/output/popup/externallib.php',
'description' => 'Retrieve a list of popup notifications for a user',
'type' => 'read',
'ajax' => true,
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
),
'message_popup_get_unread_popup_notification_count' => array(
'classname' => 'message_popup_external',
'methodname' => 'get_unread_popup_notification_count',
'classpath' => 'message/output/popup/externallib.php',
'description' => 'Retrieve the count of unread popup notifications for a given user',
'type' => 'read',
'ajax' => true,
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
'readonlysession' => true,
),
)
const MOODLE_OFFICIAL_MOBILE_SERVICE
Moodle mobile app service name.
Definition moodlelib.php:535

External functions and service definitions.

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