message_popup

Files
file	api.php
	Contains class used to return information to display for the message popup.
file	base.php
	Base trait for message popup tests.
file	behat_message_popup.php
	Behat message popup related steps definitions.
file	externallib.php
	External message popup API.
file	install.php
	Installation code for the popup message processor.
file	lib.php
	Contains standard functions for message_popup.
file	popup_notification.php
	Contains class used to prepare a popup notification for display.
file	provider.php
	Privacy Subsystem implementation for message_popup.
file	services.php
	External functions and service definitions.
file	upgrade.php
	Upgrade code for popup message processor.
file	version.php
	Popup message processor version information.

Namespaces
namespace	message_popup
namespace	message_popup\output
namespace	message_popup\privacy

Classes
class	behat_message_popup
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...
class	message_popup_external

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

Variables
	$functions
	$plugin = 2020060900
$plugin	component = 'message_popup'
$plugin	version = 2020061500

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

string

The HTML

xmldb_message_popup_upgrade()

xmldb_message_popup_upgrade

(

$oldversion

)

Upgrade code for the popup message processor.

Parameters

int

$oldversion

The 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,
    ),
)