Note: You are currently viewing documentation for Moodle 3.4. Up-to-date documentation for the latest stable version of Moodle is likely available here: Mobile app notifications.

Mobile app notifications: Difference between revisions

From MoodleDocs
(wording improvements)
Line 1: Line 1:
{{Mobile}}
{{Mobile}}


The app supports two types of notifications: Local and Push.
==Types of notification==


Local notifications are only for events in your Moodle calendar. Push notifications are connected to the messaging system in Moodle, so you receive notifications for internal messages, new forum posts, submitted assignments and every message sent by any Moodle module that can be configured in your Messaging profile option.
The Moodle Mobile app has two types of notifications: local and push.  


Local notifications are enabled by default and you don't have to configure anything, Push notifications need to be enabled by your site administrator and configured in your message profile.
== Local notifications ==


== Local notifications ==
Local notifications are [[Calendar|Moodle calendar]] event notifications only.


Local notifications are enabled by default: the app creates local notifications based in your calendar events (every time you open the app, the events are re-synchronized deleting the old ones). Note that groups events are not currently supported.
Local notifications are enabled by default and you don't have to configure anything. Every time you open the Moodle Mobile app, events are re-synchronized and old events are deleted. Note that groups events are not yet supported.


You can disable local notifications in the app (go to the “Settings > General” section) or individually for each event via the "Calendar events" option in the main menu.
Local notifications may be disabled in the app via ''Settings > General'' or individually for each event via the 'Calendar events' option in the main menu.


== Push notifications ==
== Push notifications ==


Push notifications are connected to the messaging system in Moodle so you receive notifications for internal messages, new forum posts, submitted assignments and every message sent by any Moodle module that can be configured in your Messaging profile option.
Push notifications are all notifications related to the [[Messaging|messaging system]] in Moodle, such as notifications of [[Using Messaging|instant messages]], new forum posts, submitted assignments etc.


Enabling push notifications:
Push notifications need to be enabled by a site administrator and configured by users in their messaging profile settings (''Administration > My profile settings > Messaging'').


1.  (Optional step) If your Moodle installation is 2.6 or below, you will need to install the [https://moodle.org/plugins/view.php?plugin=message_airnotifier Mobile notifications plugin]. For Moodle 2.7 and onwards you need to enable the plugin. For Moodle versions 2.4 and 2.5 the [[Moodle Mobile additional features]] plugin must also be installed.  *
===Enabling push notifications===


2.  Connect it to a messaging server (you can use ours if your Moodle site is registered). Go to ''Site administration > Plugins > Message outputs > Mobile Notifications'' and click in ''Request access key''. If you have problems requesting the access key, please fill in this form: http://goo.gl/forms/WLwkbe8b7c (your site registration will be checked and we will send you an access key in a few days if everything is correct).
Note: If your Moodle installation is 2.6 or below, you will need to install the [https://moodle.org/plugins/view.php?plugin=message_airnotifier Mobile notifications plugin]. For Moodle 2.7 and onwards you just need to enable the plugin. For Moodle versions 2.4 and 2.5 the [[Moodle Mobile additional features]] plugin must also be installed. (See note marked * below.)


3. Users need to connect at least once with the latest version of the app in order to register their phones with your site.
Push notifications can be enabled by an administrator by connecting their Moodle site to a messaging server such https://messages.moodle.net (available for [[Site registration|registered Moodle sites]] only). An access key can be obtained via ''Administration > Site administration > Plugins > Message outputs > Mobile Notifications''. (If you have problems requesting the access key, please fill in the [http://goo.gl/forms/WLwkbe8b7c  Airnotifier access key manual request form]. Your site registration will be checked and you will be sent an access key in a few days if everything is correct.)


4.  Users must configure notifications in the Moodle messaging preferences (''Administration > My profile settings > Messaging'').
Users then need to connect at least once with the latest version of the Moodle Mobile app in order to register their phones with the Moodle site.


<nowiki>*</nowiki> Only for Moodle from 2.7 and onwards: If you upgrade your Moodle installation, you will have to reinstall the plugin since it adds a couple of functions to the core Moodle Mobile service. See https://tracker.moodle.org/browse/MDLSITE-2815?focusedCommentId=273741&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-273741 for more information.
<nowiki>*</nowiki> Only for Moodle from 2.7 and onwards: If you upgrade your Moodle installation, you will have to reinstall the plugin since it adds a couple of functions to the core Moodle Mobile service. See https://tracker.moodle.org/browse/MDLSITE-2815?focusedCommentId=273741&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-27374 for more information.


=== Receiving calendar notifications via Push messages ===
=== Event Reminders plugin===


You can receive calendar notifications via Push messages, it requires a plugin to be installed in your Moodle site: [https://moodle.org/plugins/view/local_reminders Event Reminders]
Push notifications can also include calendar event notifications, however this requires the [https://moodle.org/plugins/view/local_reminders Event Reminders plugin] to be installed on the Moodle site.


This plugin will automatically send reminders for Moodle calendar events in a timely manner via Moodle message interface. It also allows users to control how they receive messages for each type of event in Moodle calendar.
The Event Reminders plugin will automatically send reminders for Moodle calendar events in a timely manner via Moodle message interface. It also allows users to control how they receive messages for each type of event in the Moodle calendar.


=== Installing your own Notifications infrastructure ===
=== Installing your own notifications infrastructure ===


If you have a customized version of the Mobile app, or you want to use your own Notifications infrastructure, then you will have to install a private [http://airnotifier.github.io AirNotifier] (backend server for notifications).
If you have a customized version of the Moodle Mobile app, or you want to use your own notifications infrastructure, you will have to install a private [http://airnotifier.github.io AirNotifier] (backend server for notifications).


We use a slightly modified version of Airnotifier: https://github.com/jleyva/airnotifier/tree/moodle2.  
https://messages.moodle.net uses a slightly modified version of Airnotifier: https://github.com/jleyva/airnotifier/tree/moodle2.  


You will have to add your app certificates there, see https://github.com/airnotifier/airnotifier/wiki/Installation.
You will have to add your app certificates - see https://github.com/airnotifier/airnotifier/wiki/Installation for further information.


The AirNotifier message plugin allows you to point to your custom AirNotifier instance using your own access keys.
The Airnotifier message plugin allows you to point to your custom Airnotifier instance using your own access keys.


Remember to install using GIT (repository https://github.com/jleyva/airnotifier.git branch ''moodle2'').
Remember to install using GIT (repository https://github.com/jleyva/airnotifier.git branch ''moodle2'').

Revision as of 17:32, 6 February 2015


Types of notification

The Moodle Mobile app has two types of notifications: local and push.

Local notifications

Local notifications are Moodle calendar event notifications only.

Local notifications are enabled by default and you don't have to configure anything. Every time you open the Moodle Mobile app, events are re-synchronized and old events are deleted. Note that groups events are not yet supported.

Local notifications may be disabled in the app via Settings > General or individually for each event via the 'Calendar events' option in the main menu.

Push notifications

Push notifications are all notifications related to the messaging system in Moodle, such as notifications of instant messages, new forum posts, submitted assignments etc.

Push notifications need to be enabled by a site administrator and configured by users in their messaging profile settings (Administration > My profile settings > Messaging).

Enabling push notifications

Note: If your Moodle installation is 2.6 or below, you will need to install the Mobile notifications plugin. For Moodle 2.7 and onwards you just need to enable the plugin. For Moodle versions 2.4 and 2.5 the Moodle Mobile additional features plugin must also be installed. (See note marked * below.)

Push notifications can be enabled by an administrator by connecting their Moodle site to a messaging server such https://messages.moodle.net (available for registered Moodle sites only). An access key can be obtained via Administration > Site administration > Plugins > Message outputs > Mobile Notifications. (If you have problems requesting the access key, please fill in the Airnotifier access key manual request form. Your site registration will be checked and you will be sent an access key in a few days if everything is correct.)

Users then need to connect at least once with the latest version of the Moodle Mobile app in order to register their phones with the Moodle site.

* Only for Moodle from 2.7 and onwards: If you upgrade your Moodle installation, you will have to reinstall the plugin since it adds a couple of functions to the core Moodle Mobile service. See https://tracker.moodle.org/browse/MDLSITE-2815?focusedCommentId=273741&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-27374 for more information.

Event Reminders plugin

Push notifications can also include calendar event notifications, however this requires the Event Reminders plugin to be installed on the Moodle site.

The Event Reminders plugin will automatically send reminders for Moodle calendar events in a timely manner via Moodle message interface. It also allows users to control how they receive messages for each type of event in the Moodle calendar.

Installing your own notifications infrastructure

If you have a customized version of the Moodle Mobile app, or you want to use your own notifications infrastructure, you will have to install a private AirNotifier (backend server for notifications).

https://messages.moodle.net uses a slightly modified version of Airnotifier: https://github.com/jleyva/airnotifier/tree/moodle2.

You will have to add your app certificates - see https://github.com/airnotifier/airnotifier/wiki/Installation for further information.

The Airnotifier message plugin allows you to point to your custom Airnotifier instance using your own access keys.

Remember to install using GIT (repository https://github.com/jleyva/airnotifier.git branch moodle2).