Difference between revisions of "Moodle Mobile additional features"

Jump to: navigation, search

Note: You are currently viewing documentation for Moodle 3.1. Up-to-date documentation for the latest stable version of Moodle is probably available here: Moodle Mobile additional features.

(mobile template)
m (Text replacement - "<mediaplayer>(.*)<\/mediaplayer>" to "{{MediaPlayer | url = $1}}")
 
(21 intermediate revisions by 7 users not shown)
Line 4: Line 4:
 
|entry = http://moodle.org/plugins/view.php?plugin=local_mobile
 
|entry = http://moodle.org/plugins/view.php?plugin=local_mobile
 
|tracker = https://tracker.moodle.org/browse/CONTRIB/component/13930
 
|tracker = https://tracker.moodle.org/browse/CONTRIB/component/13930
|discussion = http://moodle.org/mod/forum/view.php?id=
+
|discussion = https://moodle.org/mod/forum/view.php?id=7798
 
|maintainer = [[User:Juan Leyva|Juan Leyva]]
 
|maintainer = [[User:Juan Leyva|Juan Leyva]]
 
}}
 
}}
  
Local plugin for adding new features to the current Moodle Mobile app ([https://moodle.org/plugins/view.php?plugin=local_mobile Plugin download link])
+
The Moodle Mobile additional features plugin provides new features and web services for the Moodle Mobile app which are currently only available in the latest Moodle version.
  
This add-on provides new features and web services which are currently only available in the latest Moodle version.
+
This plugin is officially developed and maintained by Moodle HQ
  
 
== How it works ==
 
== How it works ==
  
Once installed the plugin creates a new service "Moodle Mobile additional features".
+
Once installed the plugin creates a new service "Moodle Mobile additional features". The Mobile app checks if this service is enabled. If not, the Mobile app falls backs to the standard core Mobile app service.
  
The Mobile app checks if this service is enabled. If not, the Mobile app falls backs to the standard core Mobile app service.
+
Please, open [[Moodle Mobile features]] to check what new features are added to your site depending on your Moodle version.
  
 
== Features ==
 
== Features ==
  
* Support for sites using SSO authentication methods (Shibboleth and CAS)
+
* Support for sites using SSO authentication methods (Shibboleth, CAS and Google OAuth 2)
* Push notifications
+
* Support for sites using MNet authentication (Moodle Network authentication)
* Retrieval of private messages and notifications from the site
+
* Support for push notifications in Moodle sites prior to version 2.6
* Retrieval of calendar events from the site
 
  
 
=== Enable authentication for sites using SSO methods (like Shibboleth and CAS) ===
 
=== Enable authentication for sites using SSO methods (like Shibboleth and CAS) ===
 +
 +
VERY IMPORTANT NOTE: You need to disable the "Auto login guest" option "autologinguests". This setting is not compatible with the SSO via app.
 +
 +
SSO and MNet authentication is not supported in the Windows 8 and Windows Phone 8 apps
  
 
Once the plugin is installed, you need to go to Site administration > Plugins > Local plugins > Moodle Mobile additional features
 
Once the plugin is installed, you need to go to Site administration > Plugins > Local plugins > Moodle Mobile additional features
  
 
There you can choose the "Type of login":
 
There you can choose the "Type of login":
 +
; '''Via the app''' : Is the default login, the user must introduce his credentials in the app
 +
; '''Via a browser window''' : A new browser instance is open in the mobile device pointing to the login form in the Moodle site (which may again redirect to external identity providers if required). The user must introduce his credentials there. This is the option that must be selected for sites using SSO methods (or for sites that wants to force the user to authenticate in the site, not in the app)
  
- Via the app: Is the default login, the user must introduce his credentials in the app
 
  
- Via a browser window: A new browser instance is open in the mobile device pointing to the login form in the Moodle site. The user must introduce his credentials there. This is the option that must be selected for sites using SSO methods (or for sites that wants to force the user to authenticate in the site, not in the app)
+
{{MediaPlayer | url = https://www.youtube.com/watch?v=cl8rsyyyg9g}}
  
<mediaplayer>https://www.youtube.com/watch?v=cl8rsyyyg9g</mediaplayer>
 
  
=== Push notifications ===
+
When using the "Via a browser window" option, you can optionally specify an URL scheme to be used by the system to open the Mobile app. By default, the URL scheme used to open the app will be the one indicated by the own app during the SSO process. If you've developed a custom app using its own URL scheme and you want to allow only SSO logins via your app, you can indicate there an URL scheme. The site will detect that setting and will use it instead of the value indicated by the app.
 
 
If you want to enable Push notifications in Moodle sites prior to version 2.6 this plugin must be installed.
 
 
 
See [[Mobile app Push Notifications]] for more information
 
  
 
== Installation ==
 
== Installation ==
  
1. Unpack the zip file into the local/ directory. A new directory will be created called local/mobile.
+
# Unpack the zip file into the local/ directory. A new directory will be created called local/mobile.
 
+
# Go to ''Site administration > Notifications'' to complete the plugin installation.
2. Go to Site administration > Notifications to complete the plugin installation.
+
# Go to ''Site administration > Plugins > Web services > Mobile'' and enable web services for mobile devices (Remember to save the changes)
 
+
# Go to ''Site administration > Plugins > Web services > External services'', edit "Moodle Mobile additional features" and check the "Enabled" field, then save changes.
3. Go to Site administration > Plugins > Web services > Mobile, enable "Enable web services for mobile devices" (Remember to save the changes)
+
# Go to ''Site administration > Users > Permissions > Define roles'', edit the Authenticated user role and allow the capability moodle/webservice:createtoken.
 
 
4. Go to Site administration > Plugins > Web services > External services, edit "Moodle Mobile additional features" and check the "Enabled" field, then save changes.
 
 
 
5. Go to Site administration > Users > Define roles, edit the Authenticated user role and allow the capability moodle/webservice:createtoken.
 
  
 
Note: You need to have upgraded the Moodle Mobile app to version 1.4.4.
 
Note: You need to have upgraded the Moodle Mobile app to version 1.4.4.
Line 63: Line 58:
 
This plugin installs a new service in your Moodle installation, the automatic token creation for this type of services is forbidden for admin users. This means that admin users will not be able to use the Mobile app.
 
This plugin installs a new service in your Moodle installation, the automatic token creation for this type of services is forbidden for admin users. This means that admin users will not be able to use the Mobile app.
  
This can be solved easily, administrators must create a token manually in Moodle (Plugins > Web Services > Manage tokens) for the local_mobile service.
+
This can be solved easily, administrators must create a token manually in Moodle (''Plugins > Web Services > Manage tokens'') for the local_mobile service. '''Note:''' Be sure to toggle the default "Moodle mobile web services" setting to "Moodle mobile additional features service" before creating the token.
 
 
== See also ==
 
 
 
* [https://moodle.org/plugins/view.php?plugin=local_mobile Moodle Mobile additional plugin]
 
  
[[de:Mobile App - Zusatzfeatures]]
+
[[de:Moodle Mobile - Zusatzfunktionen]]
 
[[es:Características adicionales de Moodle Mobile]]
 
[[es:Características adicionales de Moodle Mobile]]
 +
[[fr:Fonctionnalités additionnelles de l'app mobile]]

Latest revision as of 13:39, 26 October 2017

The Moodle Mobile additional features plugin provides new features and web services for the Moodle Mobile app which are currently only available in the latest Moodle version.

This plugin is officially developed and maintained by Moodle HQ

How it works

Once installed the plugin creates a new service "Moodle Mobile additional features". The Mobile app checks if this service is enabled. If not, the Mobile app falls backs to the standard core Mobile app service.

Please, open Moodle Mobile features to check what new features are added to your site depending on your Moodle version.

Features

  • Support for sites using SSO authentication methods (Shibboleth, CAS and Google OAuth 2)
  • Support for sites using MNet authentication (Moodle Network authentication)
  • Support for push notifications in Moodle sites prior to version 2.6

Enable authentication for sites using SSO methods (like Shibboleth and CAS)

VERY IMPORTANT NOTE: You need to disable the "Auto login guest" option "autologinguests". This setting is not compatible with the SSO via app.

SSO and MNet authentication is not supported in the Windows 8 and Windows Phone 8 apps

Once the plugin is installed, you need to go to Site administration > Plugins > Local plugins > Moodle Mobile additional features

There you can choose the "Type of login":

Via the app 
Is the default login, the user must introduce his credentials in the app
Via a browser window 
A new browser instance is open in the mobile device pointing to the login form in the Moodle site (which may again redirect to external identity providers if required). The user must introduce his credentials there. This is the option that must be selected for sites using SSO methods (or for sites that wants to force the user to authenticate in the site, not in the app)



When using the "Via a browser window" option, you can optionally specify an URL scheme to be used by the system to open the Mobile app. By default, the URL scheme used to open the app will be the one indicated by the own app during the SSO process. If you've developed a custom app using its own URL scheme and you want to allow only SSO logins via your app, you can indicate there an URL scheme. The site will detect that setting and will use it instead of the value indicated by the app.

Installation

  1. Unpack the zip file into the local/ directory. A new directory will be created called local/mobile.
  2. Go to Site administration > Notifications to complete the plugin installation.
  3. Go to Site administration > Plugins > Web services > Mobile and enable web services for mobile devices (Remember to save the changes)
  4. Go to Site administration > Plugins > Web services > External services, edit "Moodle Mobile additional features" and check the "Enabled" field, then save changes.
  5. Go to Site administration > Users > Permissions > Define roles, edit the Authenticated user role and allow the capability moodle/webservice:createtoken.

Note: You need to have upgraded the Moodle Mobile app to version 1.4.4.

If you are currently using the Moodle Mobile app, you will need to log out of all your sites in order for the app to detect the new service.

Admin users, please read

This plugin installs a new service in your Moodle installation, the automatic token creation for this type of services is forbidden for admin users. This means that admin users will not be able to use the Mobile app.

This can be solved easily, administrators must create a token manually in Moodle (Plugins > Web Services > Manage tokens) for the local_mobile service. Note: Be sure to toggle the default "Moodle mobile web services" setting to "Moodle mobile additional features service" before creating the token.