MoodleDocs - User contributions [en]

Moodle App Translation

2023-01-12T17:27:06Z

Jleyva:

This page is now located in the user docs: [[:en:Translating the Moodle App|Translating the Moodle app]]

Moodle App Translation

2023-01-12T17:25:29Z

Jleyva:

This page is now located in the user docs: [[:en:Translating the Moodle App|Translating the Moodle App]]

Moodle App Translation

2023-01-12T17:24:53Z

Jleyva:

This page is now located in the user docs: [[:en:Translating the Moodle App|Translating the Moodle app]]

Moodle App 4.0.1 release notes

2022-05-26T08:03:53Z

Jleyva:

[[Moodle App Release Notes|Moodle App release notes]] > {{FULLPAGENAME}}

Release date: 26 May 2022

This is a maintenance release, only with minor improvements and bug fixes indicated below.

==Complete list of issues==

=== Bug ===
* MOBILE-4060 - Moodle Mobile 4.0.0 External URL Android Portrait visibility issue
* MOBILE-4079 - Handling urls with create site does not wait the site to login

=== Improvement ===
* MOBILE-4067 - Avoid empty Dashboard or My courses when no blocks are returned because of an exception
* MOBILE-4080 - Improve development settings usage

[[Category:Mobile]]
[[Category:Release notes]]

Moodle App 4.0.1 release notes

2022-05-26T07:57:49Z

Jleyva: Created page with "Moodle App release notes > {{FULLPAGENAME}} Release date: 26 May 2022 This is a maintenance release, only with minor improvements and bug fixes..."

Moodle App Release Notes

2022-05-26T07:55:45Z

Jleyva: /* Moodle App */

== Moodle App ==
{| class="wikitable"
|-
! Version name
! Date
! Version code
!
|-
!Moodle App 4.0.1
|26 May 2022
|40100
|[[Moodle App 4.0.1 release notes|Release Notes]]
|-
!Moodle App 4.0.0
|22 April 2022
|40000
|[[Moodle App 4.0.0 release notes|Release Notes]]
|-
! Moodle App 3.9.5
| 27 August 2021
| 39500
| [[Moodle Mobile 3.9.5 release notes|Release Notes]]
|-
! Moodle App 3.9.4
| 28 December 2020
| 39400
|[[Moodle Mobile 3.9.4 release notes|Release Notes]]
|-
! Moodle App 3.9.3
| 30 November 2020
| 39300
| [[Moodle Mobile 3.9.3 release notes|Release Notes]]
|-
! Moodle App 3.9.2
| 16 July 2020
| 39200
| [[Moodle Mobile 3.9.2 release notes|Release Notes]]
|-
! Moodle App 3.9.1
| 3 July 2020
| 39100
| [[Moodle Mobile 3.9.1 release notes|Release Notes]]
|-
! Moodle App 3.9.0
| 26 June 2020
| 39000
| [[Moodle Mobile 3.9.0 release notes|Release Notes]]
|-
! Moodle App 3.8.2
| 2 April 2020
| 38200
| [[Moodle Mobile 3.8.2 release notes|Release Notes]]
|-
! Moodle App 3.8.1
| 25 March 2020
| 38100
| [[Moodle Mobile 3.8.1 release notes|Release Notes]]
|-
! Moodle App 3.8.0
| 20 December 2019
| 38000
| [[Moodle Mobile 3.8.0 release notes|Release Notes]]
|-
! Moodle App 3.7.2
| 20 September 2019
| 37200
| [[Moodle Mobile 3.7.2 release notes|Release Notes]]
|-
! Moodle App 3.7.1
| 30 August 2019
| 37100
| [[Moodle Mobile 3.7.1 release notes|Release Notes]]
|-
! Moodle App 3.7.0
| 7 June 2019
| 37000
| [[Moodle Mobile 3.7.0 release notes|Release Notes]]
|-
! Moodle App 3.6.1
| 29 March 2019
| 36100
| [[Moodle Mobile 3.6.1 release notes|Release Notes]]
|-
! Moodle App 3.6.0
| 11 January 2019
| 36000
| [[Moodle Mobile 3.6.0 release notes|Release Notes]]
|-
! Moodle App 3.5.2
| 10 September 2018
| 35200
| [[Moodle Mobile 3.5.2 release notes|Release Notes]]
|-
! Moodle App 3.5.1
| 6 July 2018
| 35100
| [[Moodle Mobile 3.5.1 release notes|Release Notes]]
|-
! Moodle App 3.5.0
| 25 June 2018
| 35000
| [[Moodle Mobile 3.5.0 release notes|Release Notes]]
|}

== Moodle Mobile ==
Versions with support or 3.0 and previous versions, based on Ionic 1.
{| class="wikitable"
|-
! Version name
! Date
! Version code
!
|-
! Moodle Mobile 3.4.2
| 19 March 2018
| 20230
| [[Moodle Mobile 3.4.2 release notes|Release Notes]]
|-
! Moodle Mobile 3.4.1
| 28 February 2018
| 20220
| [[Moodle Mobile 3.4.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.4.0
| 30 November 2017
| 20210
| [[Moodle Mobile 3.4.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.3.2
| 29 September 2017
| 20200
| [[Moodle Mobile 3.3.2 release notes|Release Notes]]
|-
! Moodle Mobile 3.3.1
| 28 July 2017
| 20190
| [[Moodle Mobile 3.3.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.3.0
| 26 May 2017
| 20180
| [[Moodle Mobile 3.3.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.2.1
| 28 February 2017
| 20170
| [[Moodle Mobile 3.2.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.2.0
| 12 December 2016
| 20160
| [[Moodle Mobile 3.2.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.1.3
| 19 October 2016
| 20150
| [[Moodle Mobile 3.1.3 release notes|Release Notes]]
|-
! Moodle Mobile 3.1.2
| 27 July 2016
| 2014
| [[Moodle Mobile 3.1.2 release notes|Release Notes]]
|-
! Moodle Mobile 3.1.1
| 14 June 2016
| 2013
| [[Moodle Mobile 3.1.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.1.0
| 23 May 2016
| 2012
| [[Moodle Mobile 3.1.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.0.0
| 15 April 2016
| 2011
| [[Moodle Mobile 3.0.0 release notes|Release Notes]]
|-
! Moodle Mobile 2.9
| 29 February 2016
| 2010
| [[Moodle Mobile 2.9 release notes|Release Notes]]
|-
! Moodle Mobile 2.8
| 22 January 2016
| 2009
| [[Moodle Mobile 2.8 release notes|Release Notes]]
|-
! Moodle Mobile 2.7
| 29 December 2015
| 2008
| [[Moodle Mobile 2.7 release notes|Release Notes]]
|-
! Moodle Mobile 2.6
| 27 November 2015
| 2007
| [[Moodle Mobile 2.6 release notes|Release Notes]]
|-
! Moodle Mobile 2.5
| 6 November 2015
| 2006
| [[Moodle Mobile 2.5 release notes|Release Notes]]
|-
! Moodle Mobile 2.4
| 21 October 2015
| 2005
| [[Moodle Mobile 2.4 release notes|Release Notes]]
|-
! Moodle Mobile 2.3
| 8 October 2015
| 2004
| [[Moodle Mobile 2.3 release notes|Release Notes]]
|-
! Moodle Mobile 2.2
| 10 September 2015
| 2003
| [[Moodle Mobile 2.2 release notes|Release Notes]]
|-
! Moodle Mobile 2.1
| 28 August 2015
| 2002
| [[Moodle Mobile 2.1 release notes|Release Notes]]
|-
! Moodle Mobile 2.0
| 31 July 2015
| 2000
| [[Moodle Mobile 2.0 release notes|Release Notes]]
|}
== Moodle Mobile 1 ==
See [[Moodle Mobile 1 release notes]]
== See also ==
* [[Moodle Desktop release notes]]
* [[Moodle Mobile Roadmap]]
[[Category: Mobile]]
[[Category:Release notes]]

Moodle App Release Process

2022-05-02T15:08:05Z

Jleyva: /* The following days */

{{Template:Migrated|newDocId=/docs/guides/moodleapp/development/release-process}}
== Two weeks before (Code freeze) ==
{| class="table table-striped table-bordered"
|-
! style="width:20px" | #
! Task
! style="width:12%" | Responsibility
|-
| 1.
| Create an issue in the tracker for the release, like: MOBILE-1248
| Integration Lead
|-
| 2.
| Force an update of the [https://moodle.org/plugins/view.php?id=997 local_moodlemobileapp] plugin (as release candidate) with new strings in moodle.org/plugins (only for Moodle version 2.6).
| Dev
|-
| 3.
| Ask someone from sites or community team to review the new English strings.
| Community or Sites team
|-
| 4.
| Announce in the moodletranslation forums the new strings available: https://lang.moodle.org/mod/forum/view.php?id=5. This will allow translators to add the new strings during the days prior to the release.
| Integration Lead
|-
| 5.
| Add the release notes in the release issue created (search for the [https://tracker.moodle.org/issues/?jql=project%20%3D%20MOBILE%20AND%20labels%20%3D%20release_notes release_notes tag]). Ask someone from the documentation team or Martin to review the release notes.
| Integration Lead
|-
| 6.
| Contact the marketing team announcing the new release and highlights.
| Integration Lead
|-
| 7.
| Add new QA tests to the “Testing cases” document. New QA tests should be labeled with [https://tracker.moodle.org/issues/?jql=project%20%3D%20MOBILE%20AND%20resolution%20in%20(Unresolved%2C%20Fixed)%20AND%20labels%20%3D%20qa_test_required%20ORDER%20BY%20priority%20DESC%2C%20updated%20DESC qa_test_required]. Remove that label once are added to the document.
| Tester
|-
| 8.
| Run npm audit to ensure all the dependencies are OK.
| Developer
|-
| 9.
| Freeze Cordova plugins and Javascript libraries versions (node modules) in the integration branch.
| Developer
|-
| 10.
| '''Start testing'''
| Tester
|}
== The release day ==
{| class="table table-striped table-bordered"
|-
! style="width:20px" | #
! Task
! style="width:12%" | Responsibility
|-
| 1.
| Fix the version name in integration/config.xml, integration/package.json and integration:src/config.json (remove the -dev).
| Integration Lead
|-
| 2.
| Integrate the [https://github.com/moodlehq/moodleapp/compare/master...integration integration branch onto the master one].
| Integration Lead
|-
| 3.
| Do some testing with the production builds before sending the application to the stores (overall testing to see that nothing is broken because of the branch merge done in step 2):
* Correct definitive version name displayed (and commit)
* AOT compiling worked
* Language strings synchronised from lang.moodle.net
* New language packs added
| All the team
|-
| 4.
| Send the applications to the stores for review.
| Integration Lead
|-
| 5.
| Create a TAG/Release in github ([https://github.com/moodlehq/moodleapp/releases moodlehq/moodleapp]) with the version number.
| Integration Lead
|-
| 6.
| Mark the issue and the [https://tracker.moodle.org/projects/MOBILE?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page version] as released in the tracker.
| Integration Lead
|-
| 7.
| Update release notes [[Moodle_Mobile_Release_Notes]] .
| Integration Lead
|}
== The following days ==
{| class="table table-striped table-bordered"
|-
! style="width:20px" | #
! Task
! style="width:12%" | Responsibility
|-
| 1.
| Social media announcements (Forum and Twitter).
| All the team & Marketing team
|-
| 2.
| Post in moodle.org/news.
| Team Lead
|-
| 3.
| Review the users and developers documentation (check that everything is in order). Review the [https://tracker.moodle.org/issues/?jql=project%20%3D%20MOBILE%20AND%20labels%20in%20%28docs_required%2C%20dev_docs_required%29 docs_required and dev_docs_required_tags]. Review the [https://docs.moodle.org/en/Moodle_Mobile_features Mobile features wiki documentation].
| All the team
|-
| 4.
| Delete the integration and desktop branches and create it again based on master.
| Team Lead
|-
| 5.
| Bump version numbers in the following files in the integration branch: config.xml (version), package.json (version), moodle.config.json (versionname) appending a -dev to indicate that is a development version).
| Integration Lead
|-
| 6.
| Unfreeze Cordova plugins and Javascript libraries versions (node modules).
| Developer
|-
| 7.
| Check that the [https://cloud.docker.com/u/moodlehq/repository/docker/moodlehq/moodleapp/general Docker image] for the new version was successfully built.
| Integration Lead
|-
| 8.
| Update of the [https://moodle.org/plugins/view.php?id=997 local_moodlemobileapp] plugin (as final release) in moodle.org/plugins.
| Developer
|}

== See also ==
* [[Moodle App Release Notes]]
[[Category:Processes]]
[[Category:Mobile]]
{{DISPLAYTITLE:Moodle app release process}}

Moodle App 4.0.0 release notes

2022-05-02T13:16:10Z

Jleyva: /* Complete list of issues */

[[Moodle App Release Notes|Moodle App release notes]] > {{FULLPAGENAME}}

Release date: 22 April 2022

Please notice this new version will only connect Moodle sites version >= 3.5 and that it won't work if your site is using the deprecated local_mobile (Mobile app additional features) plugin.
==New features and improvements==
* Support Moodle 4.0 LMS new "My courses" page
* User profile repositioned to match LMS
* Design updated to Material design 3 matching overall Moodle style
* Some pages now support swipe (participants, book module, grades, forum discussions,...)
* Resuming a course or a book is now easier
* Course main page additional options menu redesigned
* Navigation between sections and activities improved
* SCORM, H5P automatic full-screen mode
* Thumbnails for videos are automatically generated
* Content and activities pages with fewer distractions for users so they can focus on learning
* General performance improvements
* New notifications page (capturing all the notifications received by the user)
* The enrolment fee plugin is now supported (launched in a browser outside the app to complete the process)
* New 4.0 assignment time-limited submissions supported
* Teachers can now see H5P attempt reports

Moodle.com announcement: https://moodle.com/news/moodle-app-4-0/

[[File:MoodleApp40Store.png|800px]]

==Complete list of issues==

=== New Feature ===
* MOBILE-3688 - Create index&list link handlers for mod site plugins
* MOBILE-3799 - Let teachers view attempts in H5P activity
* MOBILE-3800 - Log report_viewed when viewing H5P activity report
* MOBILE-3873 - Support BigBlueButton (bigbluebuttonbn) activity in the app
* MOBILE-3889 - Add development settings page
* MOBILE-3919 - Support time-limited submission assignments (LMS 4.0)
* MOBILE-4022 - Support new tool_mobile_autologinmintimebetweenreq setting for auto-login requests

=== Improvement ===
* MOBILE-2848 - Language handling improvements for the mobile app
* MOBILE-3306 - Show the titles of blocks as if they had icons
* MOBILE-3316 - Handle user suspended use-case
* MOBILE-3729 - Let plugins refresh the course page method data of a single module
* MOBILE-3779 - Wiki: clicking a link to a wiki index page doesn't select the right subwiki or page
* MOBILE-3782 - Change the string 'Download course' once the course is downloaded
* MOBILE-3786 - Add a new setting to enable display the Course and Courses (Dashboard) download options
* MOBILE-3792 - Use npm v7 to allow audit fix work
* MOBILE-3793 - Forum reply/edit reply: make it more consistent
* MOBILE-3831 - Publish cordova plugin forks in npm
* MOBILE-3846 - Logout user if site URL is no longer one of the allowed URLs
* MOBILE-3847 - Detect if resources are no longer accessible when offline use is disabled
* MOBILE-3848 - Recent accessed courses block doesn't display guest access courses
* MOBILE-3859 - Improve error message for invalid certificates
* MOBILE-3860 - Remove calls to login/token.php just to check if site exists
* MOBILE-3863 - Make CSP less strict to match behaviour in native devices
* MOBILE-3881 - Timeline block improvements for 4.0
* MOBILE-3897 - Links (<a>) to files: first time opened in browser
* MOBILE-3898 - Remove overly generic Behat transformers
* MOBILE-3901 - Support insights action URL
* MOBILE-3910 - Change text to accept site policy
* MOBILE-3913 - Add search box to timeline block
* MOBILE-3916 - Ionic5 - header to have same color than system bar
* MOBILE-3917 - Display a better error if a dependency isn't found when deploying an H5P package
* MOBILE-3922 - Check userhomepage setting to show default landing page
* MOBILE-3935 - Allow changing the InAppBrowser toolbar colors
* MOBILE-3940 - Use new webservice on My courses page
* MOBILE-3941 - Don't open browser automatically if URL is set and displayqroncredentialscreen is true
* MOBILE-3950 - Restore Ionic1 Image viewer with zoom
* MOBILE-3951 - Always handle scheduling notifications in service instead of pages
* MOBILE-3954 - Move prefetch module and section options to storage manager
* MOBILE-3959 - Update cordova-android to 10.1.1
* MOBILE-3960 - New config.json setting to skip the Sites page
* MOBILE-3961 - Include the app version number in the user agent
* MOBILE-3962 - Support the course_list block
* MOBILE-3966 - Adapt disabled features to changes in 4.0
* MOBILE-3967 - Add setting to show legacy completion
* MOBILE-3968 - Ignore fake course overview block
* MOBILE-3971 - Optimize database usage for reading the config DB table
* MOBILE-3975 - Move the default notification time for calendar events to config.json
* MOBILE-3976 - Remove online-offline options on notifications
* MOBILE-3977 - Cache database tables with different strategies
* MOBILE-3980 - New index page for book module
* MOBILE-3981 - Use optimized database adapter for tables used during startup
* MOBILE-3990 - Add missing handler for notification preferences, for example: /message/notificationpreferences.php?userid=6
* MOBILE-3993 - Identify with a class or ID all the elements displaying group info
* MOBILE-3996 - Fix navigation bar positioning
* MOBILE-3998 - Create a new IMSCP index/contents page to avoid having 2 nav bars
* MOBILE-4002 - Support new option to enable/disable the Dashboard in LMS
* MOBILE-4008 - Timeline block views should display consistent information (mobile app)
* MOBILE-4012 - Support enrol_fee on the app
* MOBILE-4015 - Support fallbacks for javascript click actions on the app via data-app-url
* MOBILE-4017 - Unit tests and lint should work correctly on Windows

=== Task ===
* MOBILE-3802 - Moodle App navigation improvements for 4.0
* MOBILE-3803 - Moodle App performance improvements for 4.0
* MOBILE-3804 - Moodle App User Interface (UI) improvements for 4.0
* MOBILE-3805 - Moodle App notifications improvements for 4.0
* MOBILE-3865 - Add link to the "Accessibility Statement for Moodle App"
* MOBILE-3883 - Force ITSAppUsesNonExemptEncryption to NO (false) for iOS
* MOBILE-3926 - Add swipe navigation to pages using split view
* MOBILE-3927 - Add swipe navigation to non-split view pages
* MOBILE-3934 - Refactor pages with nested split views
* MOBILE-3939 - Refactor feedback respondents navigation
* MOBILE-3974 - Disable Paypal in the app
* MOBILE-4010 - In-app Moodle app survey should be available only for logged-in users

=== Sub-task ===
* MOBILE-2282 - App takes a lot to start if site is down or unreachable
* MOBILE-2748 - Improve how activity icons are supported now
* MOBILE-3099 - Navigation within courses in the mobile app
* MOBILE-3103 - SCORM full screen. Full screen button to remove top and bottom bar
* MOBILE-3148 - Switch user account should not logout until new account is selected
* MOBILE-3149 - Main activity action should be stuck at the bottom
* MOBILE-3153 - Support User tours in app (onboarding in screens)
* MOBILE-3415 - Support finger/swipe gestures for browsing course contents and activities with multiple pages
* MOBILE-3726 - Display page before opening links in the browser
* MOBILE-3773 - Automatically display thumbnail using Media Fragments for videos without poster
* MOBILE-3794 - Accept site policy: iframe height is too small
* MOBILE-3798 - Duplicated "My learning plans" in "More" menu and the user profile
* MOBILE-3806 - "My courses" option in the app
* MOBILE-3807 - New "User profile" menu
* MOBILE-3808 - Navigation between courses sections
* MOBILE-3810 - Main activity/resource content visualisation
* MOBILE-3811 - Update icons to use Moodle 4.0
* MOBILE-3814 - Update apps design to match 4.0 overal styling and components
* MOBILE-3819 - Moodle 3.1 and local_mobile deprecation
* MOBILE-3821 - Review offline app
* MOBILE-3823 - Ensure H5P, SCORM and similar packages (IMSCP) do not display the description box in lanscape mode (mobile)
* MOBILE-3828 - Evaluate if we could display the HTML version of popup notifications in the app
* MOBILE-3829 - Default fallback for Push Notifications should also display the nofitication message
* MOBILE-3875 - Integrate performance tests in CI
* MOBILE-3876 - Improve production bundles optimization
* MOBILE-3887 - Use core_message_get_messages to display list of notifications
* MOBILE-3899 - Only show main menu when navigation is at level 1
* MOBILE-3902 - In-app notification for site admins when Push Notifications are not enabled for a site
* MOBILE-3905 - Add swipe navigation to course participants
* MOBILE-3909 - Allow users to set the reminder at the same time the event is created
* MOBILE-3914 - Support new block drawer
* MOBILE-3915 - New course index menu and fab button
* MOBILE-3930 - Start and Resume course
* MOBILE-3931 - Re-think the activity contextual menu
* MOBILE-3932 - File resource should display the file media type, size and other useful information in their own page
* MOBILE-3965 - Change "Logout" and "Switch account" behaviour
* MOBILE-3970 - Open course information on a lateral menu

=== Bug ===
* MOBILE-3060 - Group image isn't seen in push notifications in Android 9
* MOBILE-3289 - H5P fullscreen does not work for Mobile App
* MOBILE-3552 - H5P ignores TEX-Formulas in App but not in Browser
* MOBILE-3667 - "Last accessed" sort choice on the module dashboard doesn't work unless refresh the page
* MOBILE-3676 - QR reader button should not be displayed in the credentials screen for sites that disabled it
* MOBILE-3686 - Long lists in "Available Courses" can crash app.
* MOBILE-3695 - Delete a site: cannot unregister device if site is configured to logout
* MOBILE-3711 - Access rules error messages should include as part of the string (variable) the access rule name (instead concatenating it hardcoded)
* MOBILE-3715 - Launch external app from InAppBrowser: ERR_FILE_NOT_FOUND
* MOBILE-3763 - H5P embedded directly (using embed code) have height=0 in the app
* MOBILE-3775 - PTR on a page doesn't update the page contents
* MOBILE-3780 - Max size of attachment is not correctly detected (Forum and Assignment)
* MOBILE-3785 - Assignment - visible groups: teachers on browser can select 'All participants' whereas on the app they need to select a specific group
* MOBILE-3787 - Assignment - Submission in group status are not correct
* MOBILE-3822 - Disable click in links in MathJax
* MOBILE-3825 - npm run dev:ios fails with Unknown option: '--platform'
* MOBILE-3844 - Download mp3 file outside of app's folder
* MOBILE-3849 - Revise kebab icon being shown when loading app and show download options on site home
* MOBILE-3855 - Manual completion cannot be changed when accessing activity via recent accessed items
* MOBILE-3857 - Course overview selector not displayed in old Moodle sites
* MOBILE-3868 - Badges are empty when navigating to own user profile from online users block
* MOBILE-3877 - Revise Quiz offline - when user finishes they see the summary instead of the review
* MOBILE-3886 - Android app can no longer connect to HTTP sites
* MOBILE-3895 - Long MathJax equations cut off in quiz feedback and no way to scroll
* MOBILE-3896 - Links to tokenpluginfile are opened in browser
* MOBILE-3900 - Course overview block does not honour "coursegraceperiodbefore" and "coursegraceperiodafter"
* MOBILE-3903 - Link to a course with self enrol doesn't work
* MOBILE-3906 - App laggs after accepting policy
* MOBILE-3912 - Remove needs help from login error modal
* MOBILE-3918 - Some H5P packages display "undefined" instead of title
* MOBILE-3923 - Courses are not correctly sorted on Starred courses block
* MOBILE-3924 - Revise license.json generation
* MOBILE-3944 - User interests in the user profile is not linking to tags
* MOBILE-3946 - Automatic completion of H5P activity isn't automatically detected by the app
* MOBILE-3948 - H5P: Apply MDL code to fix issue when users have same email address
* MOBILE-3949 - Fix Zip Path Traversal vulnerability in Android
* MOBILE-3952 - Kebab icon should be hidden if options menu is empty
* MOBILE-3953 - Site plugins: override handler properties isn't working as expected
* MOBILE-3956 - URL to Feedback on mainpage and courseid returns "module not found"
* MOBILE-3958 - Support gradeformatted with icons in the app
* MOBILE-3982 - Follow-up with Collapsible header issues
* MOBILE-3997 - Revise message when links with autologin
* MOBILE-4001 - Quiz Result percentage shown in the app should apply the same rounding as the other grades
* MOBILE-4005 - Support domain restricted Vimeo videos new security hash parameters

[[Category:Mobile]]
[[Category:Release notes]]

Moodle App 4.0.0 release notes

2022-04-29T12:14:38Z

Jleyva: /* New features and improvements */

Moodle App 4.0.0 release notes

2022-04-29T12:13:05Z

Jleyva: /* New features and improvements */

File:MoodleApp40Store.png

2022-04-29T12:12:32Z

Jleyva:

Moodle App 4.0 screenshots

Moodle App 4.0.0 release notes

2022-04-29T12:10:02Z

Jleyva:

Moodle App Release Notes

2022-04-29T12:08:51Z

Jleyva:

== Moodle App ==
{| class="wikitable"
|-
! Version name
! Date
! Version code
!
|-
!Moodle App 4.0.0
|22 April 2022
|40000
|[[Moodle App 4.0.0 release notes|Release Notes]]
|-
! Moodle App 3.9.5
| 27 August 2021
| 39500
| [[Moodle Mobile 3.9.5 release notes|Release Notes]]
|-
! Moodle App 3.9.4
| 28 December 2020
| 39400
|[[Moodle Mobile 3.9.4 release notes|Release Notes]]
|-
! Moodle App 3.9.3
| 30 November 2020
| 39300
| [[Moodle Mobile 3.9.3 release notes|Release Notes]]
|-
! Moodle App 3.9.2
| 16 July 2020
| 39200
| [[Moodle Mobile 3.9.2 release notes|Release Notes]]
|-
! Moodle App 3.9.1
| 3 July 2020
| 39100
| [[Moodle Mobile 3.9.1 release notes|Release Notes]]
|-
! Moodle App 3.9.0
| 26 June 2020
| 39000
| [[Moodle Mobile 3.9.0 release notes|Release Notes]]
|-
! Moodle App 3.8.2
| 2 April 2020
| 38200
| [[Moodle Mobile 3.8.2 release notes|Release Notes]]
|-
! Moodle App 3.8.1
| 25 March 2020
| 38100
| [[Moodle Mobile 3.8.1 release notes|Release Notes]]
|-
! Moodle App 3.8.0
| 20 December 2019
| 38000
| [[Moodle Mobile 3.8.0 release notes|Release Notes]]
|-
! Moodle App 3.7.2
| 20 September 2019
| 37200
| [[Moodle Mobile 3.7.2 release notes|Release Notes]]
|-
! Moodle App 3.7.1
| 30 August 2019
| 37100
| [[Moodle Mobile 3.7.1 release notes|Release Notes]]
|-
! Moodle App 3.7.0
| 7 June 2019
| 37000
| [[Moodle Mobile 3.7.0 release notes|Release Notes]]
|-
! Moodle App 3.6.1
| 29 March 2019
| 36100
| [[Moodle Mobile 3.6.1 release notes|Release Notes]]
|-
! Moodle App 3.6.0
| 11 January 2019
| 36000
| [[Moodle Mobile 3.6.0 release notes|Release Notes]]
|-
! Moodle App 3.5.2
| 10 September 2018
| 35200
| [[Moodle Mobile 3.5.2 release notes|Release Notes]]
|-
! Moodle App 3.5.1
| 6 July 2018
| 35100
| [[Moodle Mobile 3.5.1 release notes|Release Notes]]
|-
! Moodle App 3.5.0
| 25 June 2018
| 35000
| [[Moodle Mobile 3.5.0 release notes|Release Notes]]
|}
== Moodle Mobile ==
Versions with support or 3.0 and previous versions, based on Ionic 1.
{| class="wikitable"
|-
! Version name
! Date
! Version code
!
|-
! Moodle Mobile 3.4.2
| 19 March 2018
| 20230
| [[Moodle Mobile 3.4.2 release notes|Release Notes]]
|-
! Moodle Mobile 3.4.1
| 28 February 2018
| 20220
| [[Moodle Mobile 3.4.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.4.0
| 30 November 2017
| 20210
| [[Moodle Mobile 3.4.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.3.2
| 29 September 2017
| 20200
| [[Moodle Mobile 3.3.2 release notes|Release Notes]]
|-
! Moodle Mobile 3.3.1
| 28 July 2017
| 20190
| [[Moodle Mobile 3.3.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.3.0
| 26 May 2017
| 20180
| [[Moodle Mobile 3.3.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.2.1
| 28 February 2017
| 20170
| [[Moodle Mobile 3.2.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.2.0
| 12 December 2016
| 20160
| [[Moodle Mobile 3.2.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.1.3
| 19 October 2016
| 20150
| [[Moodle Mobile 3.1.3 release notes|Release Notes]]
|-
! Moodle Mobile 3.1.2
| 27 July 2016
| 2014
| [[Moodle Mobile 3.1.2 release notes|Release Notes]]
|-
! Moodle Mobile 3.1.1
| 14 June 2016
| 2013
| [[Moodle Mobile 3.1.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.1.0
| 23 May 2016
| 2012
| [[Moodle Mobile 3.1.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.0.0
| 15 April 2016
| 2011
| [[Moodle Mobile 3.0.0 release notes|Release Notes]]
|-
! Moodle Mobile 2.9
| 29 February 2016
| 2010
| [[Moodle Mobile 2.9 release notes|Release Notes]]
|-
! Moodle Mobile 2.8
| 22 January 2016
| 2009
| [[Moodle Mobile 2.8 release notes|Release Notes]]
|-
! Moodle Mobile 2.7
| 29 December 2015
| 2008
| [[Moodle Mobile 2.7 release notes|Release Notes]]
|-
! Moodle Mobile 2.6
| 27 November 2015
| 2007
| [[Moodle Mobile 2.6 release notes|Release Notes]]
|-
! Moodle Mobile 2.5
| 6 November 2015
| 2006
| [[Moodle Mobile 2.5 release notes|Release Notes]]
|-
! Moodle Mobile 2.4
| 21 October 2015
| 2005
| [[Moodle Mobile 2.4 release notes|Release Notes]]
|-
! Moodle Mobile 2.3
| 8 October 2015
| 2004
| [[Moodle Mobile 2.3 release notes|Release Notes]]
|-
! Moodle Mobile 2.2
| 10 September 2015
| 2003
| [[Moodle Mobile 2.2 release notes|Release Notes]]
|-
! Moodle Mobile 2.1
| 28 August 2015
| 2002
| [[Moodle Mobile 2.1 release notes|Release Notes]]
|-
! Moodle Mobile 2.0
| 31 July 2015
| 2000
| [[Moodle Mobile 2.0 release notes|Release Notes]]
|}
== Moodle Mobile 1 ==
See [[Moodle Mobile 1 release notes]]
== See also ==
* [[Moodle Desktop release notes]]
* [[Moodle Mobile Roadmap]]
[[Category: Mobile]]
[[Category:Release notes]]

Moodle App Release Process

2022-04-22T12:34:52Z

Jleyva: /* The release day */

== Two weeks before (Code freeze) ==

{| class="table table-striped table-bordered"
|-
! style="width:20px" | #
! Task
! style="width:12%" | Responsibility
|-
| 1.
| Create an issue in the tracker for the release, like: MOBILE-1248
| Integration Lead
|-
| 2.
| Force an update of the [https://moodle.org/plugins/view.php?id=997 local_moodlemobileapp] plugin (as release candidate) with new strings in moodle.org/plugins (only for Moodle version 2.6).
| Dev
|-
| 3.
| Ask someone from sites or community team to review the new English strings.
| Community or Sites team
|-
| 4.
| Announce in the moodletranslation forums the new strings available: https://lang.moodle.org/mod/forum/view.php?id=5. This will allow translators to add the new strings during the days prior to the release.
| Integration Lead
|-
| 5.
| Add the release notes in the release issue created (search for the [https://tracker.moodle.org/issues/?jql=project%20%3D%20MOBILE%20AND%20labels%20%3D%20release_notes release_notes tag]). Ask someone from the documentation team or Martin to review the release notes.
| Integration Lead
|-
| 6.
| Contact the marketing team announcing the new release and highlights.
| Integration Lead
|-
| 7.
| Add new QA tests to the “Testing cases” document. New QA tests should be labeled with [https://tracker.moodle.org/issues/?jql=project%20%3D%20MOBILE%20AND%20resolution%20in%20(Unresolved%2C%20Fixed)%20AND%20labels%20%3D%20qa_test_required%20ORDER%20BY%20priority%20DESC%2C%20updated%20DESC qa_test_required]. Remove that label once are added to the document.
| Tester
|-
| 8.
| Run npm audit to ensure all the dependencies are OK.
| Developer
|-
| 9.
| Freeze Cordova plugins and Javascript libraries versions (node modules) in the integration branch.
| Developer
|-
| 10.
| '''Start testing'''
| Tester
|}

== The release day ==

{| class="table table-striped table-bordered"
|-
! style="width:20px" | #
! Task
! style="width:12%" | Responsibility
|-
| 1.
| Fix the version name in integration/config.xml, integration/package.json and integration:src/config.json (remove the -dev).
| Integration Lead
|-
| 2.
| Integrate the [https://github.com/moodlehq/moodleapp/compare/master...integration integration branch onto the master one].
| Integration Lead
|-
| 3.
| Do some testing with the production builds before sending the application to the stores (overall testing to see that nothing is broken because of the branch merge done in step 2):
* Correct definitive version name displayed (and commit)
* AOT compiling worked
* Language strings synchronised from lang.moodle.net
* New language packs added
| All the team
|-
| 4.
| Send the applications to the stores for review.
| Integration Lead
|-
| 5.
| Create a TAG/Release in github ([https://github.com/moodlehq/moodleapp/releases moodlehq/moodleapp]) with the version number.
| Integration Lead
|-
| 6.
| Mark the issue and the [https://tracker.moodle.org/projects/MOBILE?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page version] as released in the tracker.
| Integration Lead
|-
| 7.
| Update release notes [[Moodle_Mobile_Release_Notes]] .
| Integration Lead
|}

== The following days ==

{| class="table table-striped table-bordered"
|-
! style="width:20px" | #
! Task
! style="width:12%" | Responsibility
|-
| 1.
| Social media announcements (Forum and Twitter).
| All the team & Marketing team
|-
| 2.
| Post in moodle.org/news.
| Team Lead
|-
| 3.
| Review the users and developers documentation (check that everything is in order). Review the [https://tracker.moodle.org/issues/?jql=project%20%3D%20MOBILE%20AND%20labels%20in%20%28docs_required%2C%20dev_docs_required%29 docs_required and dev_docs_required_tags]. Review the [https://docs.moodle.org/en/Moodle_Mobile_features Mobile features wiki documentation].
| All the team
|-
| 4.
| Delete the integration and desktop branches and create it again based on master.
| Team Lead
|-
| 5.
| Bump version numbers in the following files in the integration branch: config.xml, src/config.json (appending a -dev to the versionname field to indicate that is a development version), package.json (including mac->bundleVersion) and desktop/assets/windows/AppXManifest.xml.
| Integration Lead
|-
| 6.
| Unfreeze Cordova plugins and Javascript libraries versions (node modules).
| Developer
|-
| 7.
| Execute the combine CSS gulp task to generate a new CSS file for the BMA designer.
| Developer
|-
| 8.
| Check that the [https://cloud.docker.com/u/moodlehq/repository/docker/moodlehq/moodleapp/general Docker image] for the new version was successfully built.
| Integration Lead
|-
| 9.
| Update of the [https://moodle.org/plugins/view.php?id=997 local_moodlemobileapp] plugin (as final release) in moodle.org/plugins (only for Moodle version 2.6).
| Dev
|}

== See also ==

* [[Moodle App Release Notes]]

[[Category:Processes]]
[[Category:Mobile]]
{{DISPLAYTITLE:Moodle app release process}}

Moodle App Release Process

2022-04-07T09:05:47Z

Jleyva: /* 1 day before */

== Two weeks before (Code freeze) ==

{| class="table table-striped table-bordered"
|-
! style="width:20px" | #
! Task
! style="width:12%" | Responsibility
|-
| 1.
| Create an issue in the tracker for the release, like: MOBILE-1248
| Integration Lead
|-
| 2.
| Force an update of the [https://moodle.org/plugins/view.php?id=997 local_moodlemobileapp] plugin (as release candidate) with new strings in moodle.org/plugins (only for Moodle version 2.6).
| Dev
|-
| 3.
| Ask someone from sites or community team to review the new English strings.
| Community or Sites team
|-
| 4.
| Announce in the moodletranslation forums the new strings available: https://lang.moodle.org/mod/forum/view.php?id=5. This will allow translators to add the new strings during the days prior to the release.
| Integration Lead
|-
| 5.
| Add the release notes in the release issue created (search for the [https://tracker.moodle.org/issues/?jql=project%20%3D%20MOBILE%20AND%20labels%20%3D%20release_notes release_notes tag]). Ask someone from the documentation team or Martin to review the release notes.
| Integration Lead
|-
| 6.
| Contact the marketing team announcing the new release and highlights.
| Integration Lead
|-
| 7.
| Add new QA tests to the “Testing cases” document. New QA tests should be labeled with [https://tracker.moodle.org/issues/?jql=project%20%3D%20MOBILE%20AND%20resolution%20in%20(Unresolved%2C%20Fixed)%20AND%20labels%20%3D%20qa_test_required%20ORDER%20BY%20priority%20DESC%2C%20updated%20DESC qa_test_required]. Remove that label once are added to the document.
| Tester
|-
| 8.
| Run npm audit to ensure all the dependencies are OK.
| Developer
|-
| 9.
| Freeze Cordova plugins and Javascript libraries versions (node modules) in the integration branch.
| Developer
|-
| 10.
| '''Start testing'''
| Tester
|}

== The release day ==

{| class="table table-striped table-bordered"
|-
! style="width:20px" | #
! Task
! style="width:12%" | Responsibility
|-
| 1.
| Fix the version name in integration/config.xml and integration:src/config.json (remove the -dev).
| Integration Lead
|-
| 2.
| Integrate the [https://github.com/moodlehq/moodleapp/compare/master...integration integration branch onto the master one].
| Integration Lead
|-
| 3.
| Do some testing with the production builds before sending the application to the stores (overall testing to see that nothing is broken because of the branch merge done in step 2):
* Correct definitive version name displayed (and commit)
* AOT compiling worked
* Language strings synchronised from lang.moodle.net
* New language packs added
| All the team
|-
| 4.
| Send the applications to the stores for review.
| Integration Lead
|-
| 5.
| Create a TAG/Release in github ([https://github.com/moodlehq/moodleapp/releases moodlehq/moodleapp]) with the version number.
| Integration Lead
|-
| 6.
| Mark the issue and the [https://tracker.moodle.org/projects/MOBILE?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page version] as released in the tracker.
| Integration Lead
|-
| 7.
| Update release notes [[Moodle_Mobile_Release_Notes]] .
| Integration Lead
|}

== The following days ==

{| class="table table-striped table-bordered"
|-
! style="width:20px" | #
! Task
! style="width:12%" | Responsibility
|-
| 1.
| Social media announcements (Forum and Twitter).
| All the team & Marketing team
|-
| 2.
| Post in moodle.org/news.
| Team Lead
|-
| 3.
| Review the users and developers documentation (check that everything is in order). Review the [https://tracker.moodle.org/issues/?jql=project%20%3D%20MOBILE%20AND%20labels%20in%20%28docs_required%2C%20dev_docs_required%29 docs_required and dev_docs_required_tags]. Review the [https://docs.moodle.org/en/Moodle_Mobile_features Mobile features wiki documentation].
| All the team
|-
| 4.
| Delete the integration and desktop branches and create it again based on master.
| Team Lead
|-
| 5.
| Bump version numbers in the following files in the integration branch: config.xml, src/config.json (appending a -dev to the versionname field to indicate that is a development version), package.json (including mac->bundleVersion) and desktop/assets/windows/AppXManifest.xml.
| Integration Lead
|-
| 6.
| Unfreeze Cordova plugins and Javascript libraries versions (node modules).
| Developer
|-
| 7.
| Execute the combine CSS gulp task to generate a new CSS file for the BMA designer.
| Developer
|-
| 8.
| Check that the [https://cloud.docker.com/u/moodlehq/repository/docker/moodlehq/moodleapp/general Docker image] for the new version was successfully built.
| Integration Lead
|-
| 9.
| Update of the [https://moodle.org/plugins/view.php?id=997 local_moodlemobileapp] plugin (as final release) in moodle.org/plugins (only for Moodle version 2.6).
| Dev
|}

== See also ==

* [[Moodle App Release Notes]]

[[Category:Processes]]
[[Category:Mobile]]
{{DISPLAYTITLE:Moodle app release process}}

Moodle App Release Process

2022-03-31T15:02:51Z

Jleyva: /* Two weeks before (Code freeze) */

== Two weeks before (Code freeze) ==

{| class="table table-striped table-bordered"
|-
! style="width:20px" | #
! Task
! style="width:12%" | Responsibility
|-
| 1.
| Create an issue in the tracker for the release, like: MOBILE-1248
| Integration Lead
|-
| 2.
| Force an update of the [https://moodle.org/plugins/view.php?id=997 local_moodlemobileapp] plugin (as release candidate) with new strings in moodle.org/plugins (only for Moodle version 2.6).
| Dev
|-
| 3.
| Ask someone from sites or community team to review the new English strings.
| Community or Sites team
|-
| 4.
| Announce in the moodletranslation forums the new strings available: https://lang.moodle.org/mod/forum/view.php?id=5. This will allow translators to add the new strings during the days prior to the release.
| Integration Lead
|-
| 5.
| Add the release notes in the release issue created (search for the [https://tracker.moodle.org/issues/?jql=project%20%3D%20MOBILE%20AND%20labels%20%3D%20release_notes release_notes tag]). Ask someone from the documentation team or Martin to review the release notes.
| Integration Lead
|-
| 6.
| Contact the marketing team announcing the new release and highlights.
| Integration Lead
|-
| 7.
| Add new QA tests to the “Testing cases” document. New QA tests should be labeled with [https://tracker.moodle.org/issues/?jql=project%20%3D%20MOBILE%20AND%20resolution%20in%20(Unresolved%2C%20Fixed)%20AND%20labels%20%3D%20qa_test_required%20ORDER%20BY%20priority%20DESC%2C%20updated%20DESC qa_test_required]. Remove that label once are added to the document.
| Tester
|-
| 8.
| Run npm audit to ensure all the dependencies are OK.
| Developer
|-
| 9.
| Freeze Cordova plugins and Javascript libraries versions (node modules) in the integration branch.
| Developer
|-
| 10.
| '''Start testing'''
| Tester
|}

== 1 day before ==

{| class="table table-striped table-bordered"
|-
! style="width:20px" | #
! Task
! style="width:12%" | Responsibility
|-
| 1.
| Backport to local_mobile (all branches) all the new required Web Services by new features.
Check if existing Web Services should be added to the local_mobile service (because they were added to the Mobile app service).

Once all the Web Services are backported and tested, publish a new version in the plugins database (via TAGS) so admin can updates their sites.
| Integration Lead
|}

== The release day ==

{| class="table table-striped table-bordered"
|-
! style="width:20px" | #
! Task
! style="width:12%" | Responsibility
|-
| 1.
| Fix the version name in integration/config.xml and integration:src/config.json (remove the -dev).
| Integration Lead
|-
| 2.
| Integrate the [https://github.com/moodlehq/moodleapp/compare/master...integration integration branch onto the master one].
| Integration Lead
|-
| 3.
| Do some testing with the production builds before sending the application to the stores (overall testing to see that nothing is broken because of the branch merge done in step 2):
* Correct definitive version name displayed (and commit)
* AOT compiling worked
* Language strings synchronised from lang.moodle.net
* New language packs added
| All the team
|-
| 4.
| Send the applications to the stores for review.
| Integration Lead
|-
| 5.
| Create a TAG/Release in github ([https://github.com/moodlehq/moodleapp/releases moodlehq/moodleapp]) with the version number.
| Integration Lead
|-
| 6.
| Mark the issue and the [https://tracker.moodle.org/projects/MOBILE?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page version] as released in the tracker.
| Integration Lead
|-
| 7.
| Update release notes [[Moodle_Mobile_Release_Notes]] .
| Integration Lead
|}

== The following days ==

{| class="table table-striped table-bordered"
|-
! style="width:20px" | #
! Task
! style="width:12%" | Responsibility
|-
| 1.
| Social media announcements (Forum and Twitter).
| All the team & Marketing team
|-
| 2.
| Post in moodle.org/news.
| Team Lead
|-
| 3.
| Review the users and developers documentation (check that everything is in order). Review the [https://tracker.moodle.org/issues/?jql=project%20%3D%20MOBILE%20AND%20labels%20in%20%28docs_required%2C%20dev_docs_required%29 docs_required and dev_docs_required_tags]. Review the [https://docs.moodle.org/en/Moodle_Mobile_features Mobile features wiki documentation].
| All the team
|-
| 4.
| Delete the integration and desktop branches and create it again based on master.
| Team Lead
|-
| 5.
| Bump version numbers in the following files in the integration branch: config.xml, src/config.json (appending a -dev to the versionname field to indicate that is a development version), package.json (including mac->bundleVersion) and desktop/assets/windows/AppXManifest.xml.
| Integration Lead
|-
| 6.
| Unfreeze Cordova plugins and Javascript libraries versions (node modules).
| Developer
|-
| 7.
| Execute the combine CSS gulp task to generate a new CSS file for the BMA designer.
| Developer
|-
| 8.
| Check that the [https://cloud.docker.com/u/moodlehq/repository/docker/moodlehq/moodleapp/general Docker image] for the new version was successfully built.
| Integration Lead
|-
| 9.
| Update of the [https://moodle.org/plugins/view.php?id=997 local_moodlemobileapp] plugin (as final release) in moodle.org/plugins (only for Moodle version 2.6).
| Dev
|}

== See also ==

* [[Moodle App Release Notes]]

[[Category:Processes]]
[[Category:Mobile]]
{{DISPLAYTITLE:Moodle app release process}}

Sending custom Push Notifications to the Moodle App

2022-03-31T10:43:34Z

Jleyva: English corrections

{{Moodle App (Ionic 5)}}
There are two ways to send custom Push Notifications to the Moodle app users:
# By using Moodle’s Message API implementing a message provider
# By directly using the Airnotifier (Moodle’s Push Notification server) APIs

'''The main differences are:'''

By using Moodle’s Message API, users (students, teachers, etc..) can opt-out to not receive custom notifications. They can also opt-in to receive them not only on the app but also via email. Messages sent using this API can be delivered to non-app users.

Using the Airnotifier API will force the user to receive the notification unless they change their app settings to not receive any notification.
Messages sent using this API will only get to active app users.

In both cases, please remember that the number of user devices that can receive Push Notifications is dictated by your app [https://moodle.com/app/ subscription].
== Moodle’s Message API ==
Please read the official Moodle documentation, [[Message API]], where it is explained how to create a new message provider within a plugin.

Apart from what is explained in the [[Message API]] please notice that it is possible to add a "customdata" field (json-encoded) with additional parameters. Those parameters are the ones described in the Airnotifier API section below.
== Airnotifier API ==
Airnotifier is the name of the Push Notification server used by Moodle. It is possible to use its own API to send custom notifications from Moodle without having to use Moodle's Message API.
=== Payload format ===
'''Mandatory fields:'''
* processor (string): Always set to Moodle
* notification (number): Whether it is a notification (1) or a message (0).
* subject (string): Notification title.
* smallmessage (string): Notification body, short text.
* fullmessage (string): Notification body, ignored if smallmessage is set.
'''Optional'''
* site (string): Site ID (md5 hash of site URL + username)
* Siteurl (string): Site URL (used to identify the site the notification is coming from)
* wwwroot (string): Moodle’s $CFG->wwwroot
* component (string): Moodle’s component that generated the notification
* contexturl (string): URL the notification is related to
* customdata (JSON encoded object, all fields are optional)
** notificationiconurl (string): Icon to display in the notification (Android only).
** notificationpictureurl (string). Large picture to display in the notification (Android only).
** tokenpluginfile (string): Token to view the icon if needed.
** extendedtext (string). An extended text (HTML), opened in popup when clicked.
** appurl (string): When notification is clicked, open this URL. It has preference over contexturl but it will be ignored if extendedtext is set.
** appurlopenin (string): Where to open the previous URL ‘browser’, ‘in-app’ or any other value.
=== Sample CURL requests ===
'''Simple notification, only subject and body:'''
curl AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test"}}'
'''Notification including an icon and picture (only displayed on Android devices) opening a popup with custom content on the app:'''
curl AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test", "customdata": "{\"extendedtext\" : \"Extended tex that will open in a popupt\", \"notificationiconurl\" : \"https://picsum.photos/50\", \"notificationpictureurl\" : \"https://picsum.photos/200\"}"}}'
'''Notification opening URL that can be handled by the app (a course within the app):'''
curl AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test", "customdata": "{ \"appurl\" : \"https://mymoodlesite.net/course/view.php?id=18\", \"notificationiconurl\" : \"https://picsum.photos/50\", \"notificationpictureurl\" : \"https://picsum.photos/200\"}"}}'
'''AIRNOTIFIER_URL''': Can be obtained from your Moodle site settings: Site administration > Messaging > Mobile.

'''APP_ID''': commoodlemoodlemobile for the standard Moodle app, it can also be obtained from Site administration > Messaging > Mobile.

'''AIRNOTIFIER_ACCESS_KEY''': Your Airnotifier Access key can be obtained from Site administration > Messaging > Mobile.

'''DEVICE_TOKEN''': The user’s receiving the notification device token, for testing purposes you can get it via the app -> App settings -> About -> Click at app version -> Push notification ID.

In Moodle the push ids are in the user_devices table (pushid field), the previous table has to be joined with message_airnotifier_devices to obtain active devices.

The device could be android-fcm or ios-fcm (in the example we used android-fcm only).
[[Category:Mobile]]

Sending custom Push Notifications to the Moodle App

2022-03-30T12:28:21Z

Jleyva: /* Sample CURL requests */

{{Moodle App (Ionic 5)}}

There are two ways to send custom Push Notifications to the Moodle app users:
# By using Moodle’s Message API implementing a message provider
# By directly using the Airnotifier (Moodle’s Push Notification server) APIs

'''Main differences are:'''

By using Moodle’s Message API, users (students, teachers, etc..) can opt-out to not receive custom notifications, they can also opt-in to receive them not only on the app but also via email. Messages sent using this API can arrive to non app users.

Using the Airnotifier API will force the user to receive the notification unless they change their app settings to not receive any notification.
Messages sent using this API will only arrive to active app users.

In both cases please remember that the number of user devices that can receive Push Notifications is dictated by your app [https://moodle.com/app/ subscription].

== Moodle’s Message API ==
Please read the official Moodle documentation, [[Message API]], where it is explained how to create a new message provider within a plugin.

Apart from what it is explained in the [[Message API]] please notice that it is possible to add a customdata field (json-encoded) with additional parameters. Those parameters are the ones described in the Airnotifier API section bellow.
== Airnotifier API ==
Airnotifier is the name of the Push Notification server used by Moodle. It is possible to use its own API to send custom notifications from Moodle without having to use Moodle's Message API.
=== Payload format ===
'''Mandatory fields:'''
* processor (string): Always set to moodle
* notification (number): Whether it’s a notification (1) or a message (0).
* subject (string): Notification title.
* smallmessage (string): Notification body, short text.
* fullmessage (string): Notification body, ignored if smallmessage is set.

'''Optional'''
* site (string): Site ID (md5 hash of site URL + username)
* Siteurl (string): Site URL (used to identify the site the notification is coming from)
* wwwroot (string): Moodle’s $CFG->wwwroot
* component (string): Moodle’s component that generated the notification
* contexturl (string): URL the notification is related to
* customdata (json encoded object, all fields are optional)
** notificationiconurl (string): Icon to display in the notification (Android only).
** notificationpictureurl (string). Large picture to display in the notification (Android only).
** tokenpluginfile (string): Token to view the icon if needed.
** extendedtext (string). An extended text (HTML), opened in popup when clicked.
** appurl (string): When notification is clicked, open this URL. Has preference over contexturl but it will be ignored if extendedtext is set.
** appurlopenin (string): Where to open the previous URL ‘browser’, ‘inapp’ or any other value.

=== Sample CURL requests ===

'''Simple notification, only subject and body'''
curl AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test"}}'
'''Notification including an icon and picture (only displayed on Android devices) opening a popup with custom content on the app'''
curl AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test", "customdata": "{\"extendedtext\" : \"Extended tex that will open in a popupt\", \"notificationiconurl\" : \"https://picsum.photos/50\", \"notificationpictureurl\" : \"https://picsum.photos/200\"}"}}'
'''Notification opening URL that can be handled by the app (a course within the app)'''
curl AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test", "customdata": "{ \"appurl\" : \"https://mymoodlesite.net/course/view.php?id=18\", \"notificationiconurl\" : \"https://picsum.photos/50\", \"notificationpictureurl\" : \"https://picsum.photos/200\"}"}}'

'''AIRNOTIFIER_URL''': Can be obtained from your Moodle site settings: Site administration > Messaging > Mobile

'''APP_ID''': commoodlemoodlemobile for the standard Moodle app, it can also be obtained from Site administration > Messaging > Mobile

'''AIRNOTIFIER_ACCESS_KEY''': Your Airnotifier Access key can be obtained from Site administration > Messaging > Mobile

'''DEVICE_TOKEN''': The user’s receiving the notification device token, for testing purposes you can get it via the app -> App settings -> About -> Click at app version -> Push notification ID

In Moodle the push ids are in the user_devices table (pushid field), the previous table has to be joined with message_airnotifier_devices to obtain active devices.

The device could be android-fcm or ios-fcm (in the example we used android-fcm only)

[[Category:Mobile]]

Sending custom Push Notifications to the Moodle App

2022-03-30T12:25:36Z

Jleyva: /* Sample CURL requests */

{{Moodle App (Ionic 5)}}

There are two ways to send custom Push Notifications to the Moodle app users:
# By using Moodle’s Message API implementing a message provider
# By directly using the Airnotifier (Moodle’s Push Notification server) APIs

'''Main differences are:'''

By using Moodle’s Message API, users (students, teachers, etc..) can opt-out to not receive custom notifications, they can also opt-in to receive them not only on the app but also via email. Messages sent using this API can arrive to non app users.

Using the Airnotifier API will force the user to receive the notification unless they change their app settings to not receive any notification.
Messages sent using this API will only arrive to active app users.

In both cases please remember that the number of user devices that can receive Push Notifications is dictated by your app [https://moodle.com/app/ subscription].

== Moodle’s Message API ==
Please read the official Moodle documentation, [[Message API]], where it is explained how to create a new message provider within a plugin.

Apart from what it is explained in the [[Message API]] please notice that it is possible to add a customdata field (json-encoded) with additional parameters. Those parameters are the ones described in the Airnotifier API section bellow.
== Airnotifier API ==
Airnotifier is the name of the Push Notification server used by Moodle. It is possible to use its own API to send custom notifications from Moodle without having to use Moodle's Message API.
=== Payload format ===
'''Mandatory fields:'''
* processor (string): Always set to moodle
* notification (number): Whether it’s a notification (1) or a message (0).
* subject (string): Notification title.
* smallmessage (string): Notification body, short text.
* fullmessage (string): Notification body, ignored if smallmessage is set.

'''Optional'''
* site (string): Site ID (md5 hash of site URL + username)
* Siteurl (string): Site URL (used to identify the site the notification is coming from)
* wwwroot (string): Moodle’s $CFG->wwwroot
* component (string): Moodle’s component that generated the notification
* contexturl (string): URL the notification is related to
* customdata (json encoded object, all fields are optional)
** notificationiconurl (string): Icon to display in the notification (Android only).
** notificationpictureurl (string). Large picture to display in the notification (Android only).
** tokenpluginfile (string): Token to view the icon if needed.
** extendedtext (string). An extended text (HTML), opened in popup when clicked.
** appurl (string): When notification is clicked, open this URL. Has preference over contexturl but it will be ignored if extendedtext is set.
** appurlopenin (string): Where to open the previous URL ‘browser’, ‘inapp’ or any other value.

=== Sample CURL requests ===

'''Simple notification, only subject and body'''
curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test"}}'
'''Notification including an icon and picture (only displayed on Android devices) opening a popup with custom content on the app'''
curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test", "customdata": "{\"extendedtext\" : \"Extended tex that will open on a popupt\", \"notificationiconurl\" : \"https://picsum.photos/50\", \"notificationpictureurl\" : \"https://picsum.photos/200\"}"}}'
'''Notification opening URL that can be handled by the app (a course within the app)'''
curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test", "customdata": "{ \"appurl\" : \"https://mymoodlesite.net/course/view.php?id=18\", \"notificationiconurl\" : \"https://picsum.photos/50\", \"notificationpictureurl\" : \"https://picsum.photos/200\"}"}}'

'''AIRNOTIFIER_URL''': Can be obtained from Site administration > Messaging > Mobile

'''APP_ID''': commoodlemoodlemobile for the standard Moodle app

'''AIRNOTIFIER_ACCESS_KEY''': Your Airnotifier Access key that can be obtained from Site administration > Messaging > Mobile

'''DEVICE_TOKEN''': The user’s receiving the notification device token, for testing purposes you can get it via the app -> App settings -> About .> Click at app version -> Push notification ID

In Moodle the push ids are in the user_devices table (pushid field), the previous table has to be joined with message_airnotifier_devices to obtain active devices.

Device could be android-fcm or ios-fcm

[[Category:Mobile]]

Sending custom Push Notifications to the Moodle App

2022-03-29T15:02:55Z

Jleyva:

{{Moodle App (Ionic 5)}}

There are two ways to send custom Push Notifications to the Moodle app users:
# By using Moodle’s Message API implementing a message provider
# By directly using the Airnotifier (Moodle’s Push Notification server) APIs

'''Main differences are:'''

By using Moodle’s Message API, users (students, teachers, etc..) can opt-out to not receive custom notifications, they can also opt-in to receive them not only on the app but also via email. Messages sent using this API can arrive to non app users.

Using the Airnotifier API will force the user to receive the notification unless they change their app settings to not receive any notification.
Messages sent using this API will only arrive to active app users.

In both cases please remember that the number of user devices that can receive Push Notifications is dictated by your app [https://moodle.com/app/ subscription].

== Moodle’s Message API ==
Please read the official Moodle documentation, [[Message API]], where it is explained how to create a new message provider within a plugin.

Apart from what it is explained in the [[Message API]] please notice that it is possible to add a customdata field (json-encoded) with additional parameters. Those parameters are the ones described in the Airnotifier API section bellow.
== Airnotifier API ==
Airnotifier is the name of the Push Notification server used by Moodle. It is possible to use its own API to send custom notifications from Moodle without having to use Moodle's Message API.
=== Payload format ===
'''Mandatory fields:'''
* processor (string): Always set to moodle
* notification (number): Whether it’s a notification (1) or a message (0).
* subject (string): Notification title.
* smallmessage (string): Notification body, short text.
* fullmessage (string): Notification body, ignored if smallmessage is set.

'''Optional'''
* site (string): Site ID (md5 hash of site URL + username)
* Siteurl (string): Site URL (used to identify the site the notification is coming from)
* wwwroot (string): Moodle’s $CFG->wwwroot
* component (string): Moodle’s component that generated the notification
* contexturl (string): URL the notification is related to
* customdata (json encoded object, all fields are optional)
** notificationiconurl (string): Icon to display in the notification (Android only).
** notificationpictureurl (string). Large picture to display in the notification (Android only).
** tokenpluginfile (string): Token to view the icon if needed.
** extendedtext (string). An extended text (HTML), opened in popup when clicked.
** appurl (string): When notification is clicked, open this URL. Has preference over contexturl but it will be ignored if extendedtext is set.
** appurlopenin (string): Where to open the previous URL ‘browser’, ‘inapp’ or any other value.

=== Sample CURL requests ===
'''AIRNOTIFIER_URL''': Can be obtained from Site administration > Messaging > Mobile

'''APP_ID''': commoodlemoodlemobile for the standard Moodle app

'''AIRNOTIFIER_ACCESS_KEY''': Your Airnotifier Access key that can be obtained from Site administration > Messaging > Mobile

'''DEVICE_TOKEN''': The user’s receiving the notification device token, for testing purposes you can get it via the app -> App settings -> About .> Click at app version -> Push notification ID

In Moodle the push ids are in the user_devices table (pushid field), the previous table has to be joined with message_airnotifier_devices to obtain active devices.

Device could be android-fcm or ios-fcm

'''Simple notification, only subject and body'''
curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test"}}'</syntaxhighlight>
'''Notification including an icon and picture (only displayed on Android devices) opening a popup with custom content on the app'''
curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test", "customdata": "{\"extendedtext\" : \"Extended tex that will open on a popupt\", \"notificationiconurl\" : \"https://picsum.photos/50\", \"notificationpictureurl\" : \"https://picsum.photos/200\"}"}}'
'''Notification opening URL that can be handled by the app (a course within the app)'''
curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test", "customdata": "{ \"appurl\" : \"https://mymoodlesite.net/course/view.php?id=18\", \"notificationiconurl\" : \"https://picsum.photos/50\", \"notificationpictureurl\" : \"https://picsum.photos/200\"}"}}'

[[Category:Mobile]]

Sending custom Push Notifications to the Moodle App

2022-03-29T15:01:58Z

Jleyva: /* Payload format */

{{Moodle App (Ionic 5)}}

There are two ways to send custom Push Notifications to the Moodle app users:
# By using Moodle’s Message API implementing a message provider
# By directly using the Airnotifier (Moodle’s Push Notification server) APIs

'''Main differences are:'''

By using Moodle’s Message API, users (students, teachers, etc..) can opt-out to not receive custom notifications, they can also opt-in to receive them not only on the app but also via email. Messages sent using this API can arrive to non app users.

Using the Airnotifier API will force the user to receive the notification unless they change their app settings to not receive any notification.
Messages sent using this API will only arrive to active app users.

In both cases please remember that the number of user devices that can receive Push Notifications is dictated by your app [https://moodle.com/app/ subscription].

== Moodle’s Message API ==
Please read the official Moodle documentation, [[Message API]], where it is explained how to create a new message provider within a plugin.

Apart from what it is explained in the [[Message API]] please notice that it is possible to add a customdata field (json-encoded) with additional parameters. Those parameters are the ones described in the Airnotifier API section bellow.
== Airnotifier API ==
Airnotifier is the name of the Push Notification server used by Moodle. It is possible to use its own API to send custom notifications from Moodle without having to use Moodle's Message API.
=== Payload format ===
'''Mandatory fields:'''
* processor (string): Always set to moodle
* notification (number): Whether it’s a notification (1) or a message (0).
* subject (string): Notification title.
* smallmessage (string): Notification body, short text.
* fullmessage (string): Notification body, ignored if smallmessage is set.

'''Optional'''
* site (string): Site ID (md5 hash of site URL + username)
* Siteurl (string): Site URL (used to identify the site the notification is coming from)
* wwwroot (string): Moodle’s $CFG->wwwroot
* component (string): Moodle’s component that generated the notification
* contexturl (string): URL the notification is related to
* customdata (json encoded object, all fields are optional)
** notificationiconurl (string): Icon to display in the notification (Android only).
** notificationpictureurl (string). Large picture to display in the notification (Android only).
** tokenpluginfile (string): Token to view the icon if needed.
** extendedtext (string). An extended text (HTML), opened in popup when clicked.
** appurl (string): When notification is clicked, open this URL. Has preference over contexturl but it will be ignored if extendedtext is set.
** appurlopenin (string): Where to open the previous URL ‘browser’, ‘inapp’ or any other value.

=== Sample CURL requests ===
'''AIRNOTIFIER_URL''': Can be obtained from Site administration > Messaging > Mobile

'''APP_ID''': commoodlemoodlemobile for the standard Moodle app

'''AIRNOTIFIER_ACCESS_KEY''': Your Airnotifier Access key that can be obtained from Site administration > Messaging > Mobile

'''DEVICE_TOKEN''': The user’s receiving the notification device token, for testing purposes you can get it via the app -> App settings -> About .> Click at app version -> Push notification ID

In Moodle the push ids are in the user_devices table (pushid field), the previous table has to be joined with message_airnotifier_devices to obtain active devices.

Device could be android-fcm or ios-fcm

'''Simple notification, only subject and body'''
curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test"}}'</syntaxhighlight>
'''Notification including an icon and picture (only displayed on Android devices) opening a popup with custom content on the app'''
curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test", "customdata": "{\"extendedtext\" : \"Extended tex that will open on a popupt\", \"notificationiconurl\" : \"https://picsum.photos/50\", \"notificationpictureurl\" : \"https://picsum.photos/200\"}"}}'
'''Notification opening URL that can be handled by the app (a course within the app)'''
curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test", "customdata": "{ \"appurl\" : \"https://mymoodlesite.net/course/view.php?id=18\", \"notificationiconurl\" : \"https://picsum.photos/50\", \"notificationpictureurl\" : \"https://picsum.photos/200\"}"}}'

Sending custom Push Notifications to the Moodle App

2022-03-29T15:01:28Z

Jleyva:

{{Moodle App (Ionic 5)}}

There are two ways to send custom Push Notifications to the Moodle app users:
# By using Moodle’s Message API implementing a message provider
# By directly using the Airnotifier (Moodle’s Push Notification server) APIs

'''Main differences are:'''

By using Moodle’s Message API, users (students, teachers, etc..) can opt-out to not receive custom notifications, they can also opt-in to receive them not only on the app but also via email. Messages sent using this API can arrive to non app users.

Using the Airnotifier API will force the user to receive the notification unless they change their app settings to not receive any notification.
Messages sent using this API will only arrive to active app users.

In both cases please remember that the number of user devices that can receive Push Notifications is dictated by your app [https://moodle.com/app/ subscription].

== Moodle’s Message API ==
Please read the official Moodle documentation, [[Message API]], where it is explained how to create a new message provider within a plugin.

Apart from what it is explained in the [[Message API]] please notice that it is possible to add a customdata field (json-encoded) with additional parameters. Those parameters are the ones described in the Airnotifier API section bellow.
== Airnotifier API ==
Airnotifier is the name of the Push Notification server used by Moodle. It is possible to use its own API to send custom notifications from Moodle without having to use Moodle's Message API.
=== Payload format ===
'''Mandatory fields:'''
* processor (string): Always set to moodle
* notification (number): Whether it’s a notification (1) or a message (0).
* subject (string): Notification title.
* smallmessage (string): Notification body, short text.
* fullmessage (string): Notification body, ignored if smallmessage is set.
'''Optional'''
* site (string): Site ID (md5 hash of site URL + username)
* Siteurl (string): Site URL (used to identify the site the notification is coming from)
* wwwroot (string): Moodle’s $CFG->wwwroot
* component (string): Moodle’s component that generated the notification
* contexturl (string): URL the notification is related to
* customdata (json encoded object, all fields are optional)
** notificationiconurl (string): Icon to display in the notification (Android only).
** notificationpictureurl (string). Large picture to display in the notification (Android only).
** tokenpluginfile (string): Token to view the icon if needed.
** extendedtext (string). An extended text (HTML), opened in popup when clicked.
** appurl (string): When notification is clicked, open this URL. Has preference over contexturl but it will be ignored if extendedtext is set.
** appurlopenin (string): Where to open the previous URL ‘browser’, ‘inapp’ or any other value.
=== Sample CURL requests ===
'''AIRNOTIFIER_URL''': Can be obtained from Site administration > Messaging > Mobile

'''APP_ID''': commoodlemoodlemobile for the standard Moodle app

'''AIRNOTIFIER_ACCESS_KEY''': Your Airnotifier Access key that can be obtained from Site administration > Messaging > Mobile

'''DEVICE_TOKEN''': The user’s receiving the notification device token, for testing purposes you can get it via the app -> App settings -> About .> Click at app version -> Push notification ID

In Moodle the push ids are in the user_devices table (pushid field), the previous table has to be joined with message_airnotifier_devices to obtain active devices.

Device could be android-fcm or ios-fcm

'''Simple notification, only subject and body'''
curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test"}}'</syntaxhighlight>
'''Notification including an icon and picture (only displayed on Android devices) opening a popup with custom content on the app'''
curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test", "customdata": "{\"extendedtext\" : \"Extended tex that will open on a popupt\", \"notificationiconurl\" : \"https://picsum.photos/50\", \"notificationpictureurl\" : \"https://picsum.photos/200\"}"}}'
'''Notification opening URL that can be handled by the app (a course within the app)'''
curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test", "customdata": "{ \"appurl\" : \"https://mymoodlesite.net/course/view.php?id=18\", \"notificationiconurl\" : \"https://picsum.photos/50\", \"notificationpictureurl\" : \"https://picsum.photos/200\"}"}}'

Sending custom Push Notifications to the Moodle App

2022-03-29T14:59:09Z

Jleyva: /* Sample CURL requests */

{{Moodle App (Ionic 5)}}
There are two ways to send custom Push Notifications to the Moodle app users:
# By using Moodle’s Message API implementing a message provider
# By directly using the Airnotifier (Moodle’s Push Notification server) APIs

'''Main differences are:'''

By using Moodle’s Message API, users (students, teachers, etc..) can opt-out to not receive custom notifications, they can also opt-in to receive them not only on the app but also via email. Messages sent using this API can arrive to non app users.

Using the Airnotifier API will force the user to receive the notification unless they change their app settings to not receive any notification.
Messages sent using this API will only arrive to active app users.
== Moodle’s Message API ==
Please read the official Moodle documentation, [[Message API]], where it is explained how to create a new message provider within a plugin.

Apart from what it is explained in the [[Message API]] please notice that it is possible to add a customdata field (json-encoded) with additional parameters. Those parameters are the ones described in the Airnotifier API section bellow.
== Airnotifier API ==
Airnotifier is the name of the Push Notification server used by Moodle. It is possible to use its own API to send custom notifications from Moodle without having to use Moodle's Message API.
=== Payload format ===
'''Mandatory fields:'''
* processor (string): Always set to moodle
* notification (number): Whether it’s a notification (1) or a message (0).
* subject (string): Notification title.
* smallmessage (string): Notification body, short text.
* fullmessage (string): Notification body, ignored if smallmessage is set.
'''Optional'''
* site (string): Site ID (md5 hash of site URL + username)
* Siteurl (string): Site URL (used to identify the site the notification is coming from)
* wwwroot (string): Moodle’s $CFG->wwwroot
* component (string): Moodle’s component that generated the notification
* contexturl (string): URL the notification is related to
* customdata (json encoded object, all fields are optional)
** notificationiconurl (string): Icon to display in the notification (Android only).
** notificationpictureurl (string). Large picture to display in the notification (Android only).
** tokenpluginfile (string): Token to view the icon if needed.
** extendedtext (string). An extended text (HTML), opened in popup when clicked.
** appurl (string): When notification is clicked, open this URL. Has preference over contexturl but it will be ignored if extendedtext is set.
** appurlopenin (string): Where to open the previous URL ‘browser’, ‘inapp’ or any other value.
=== Sample CURL requests ===
'''AIRNOTIFIER_URL''': Can be obtained from Site administration > Messaging > Mobile

'''APP_ID''': commoodlemoodlemobile for the standard Moodle app

'''AIRNOTIFIER_ACCESS_KEY''': Your Airnotifier Access key that can be obtained from Site administration > Messaging > Mobile

'''DEVICE_TOKEN''': The user’s receiving the notification device token, for testing purposes you can get it via the app -> App settings -> About .> Click at app version -> Push notification ID

In Moodle the push ids are in the user_devices table (pushid field), the previous table has to be joined with message_airnotifier_devices to obtain active devices.

Device could be android-fcm or ios-fcm

'''Simple notification, only subject and body'''
curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test"}}'</syntaxhighlight>
'''Notification including an icon and picture (only displayed on Android devices) opening a popup with custom content on the app'''
curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test", "customdata": "{\"extendedtext\" : \"Extended tex that will open on a popupt\", \"notificationiconurl\" : \"https://picsum.photos/50\", \"notificationpictureurl\" : \"https://picsum.photos/200\"}"}}'
'''Notification opening URL that can be handled by the app (a course within the app)'''
curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test", "customdata": "{ \"appurl\" : \"https://mymoodlesite.net/course/view.php?id=18\", \"notificationiconurl\" : \"https://picsum.photos/50\", \"notificationpictureurl\" : \"https://picsum.photos/200\"}"}}'

Sending custom Push Notifications to the Moodle App

2022-03-29T14:58:33Z

Jleyva: /* Sample CURL requests */

{{Moodle App (Ionic 5)}}

There are two ways to send custom Push Notifications to the Moodle app users:

# By using Moodle’s Message API implementing a message provider
# By directly using the Airnotifier (Moodle’s Push Notification server) APIs

'''Main differences are:'''

By using Moodle’s Message API, users (students, teachers, etc..) can opt-out to not receive custom notifications, they can also opt-in to receive them not only on the app but also via email. Messages sent using this API can arrive to non app users.

Using the Airnotifier API will force the user to receive the notification unless they change their app settings to not receive any notification.
Messages sent using this API will only arrive to active app users.

== Moodle’s Message API ==

Please read the official Moodle documentation, [[Message API]], where it is explained how to create a new message provider within a plugin.

Apart from what it is explained in the [[Message API]] please notice that it is possible to add a customdata field (json-encoded) with additional parameters. Those parameters are the ones described in the Airnotifier API section bellow.

== Airnotifier API ==

Airnotifier is the name of the Push Notification server used by Moodle. It is possible to use its own API to send custom notifications from Moodle without having to use Moodle's Message API.

=== Payload format ===

'''Mandatory fields:'''

* processor (string): Always set to moodle
* notification (number): Whether it’s a notification (1) or a message (0).
* subject (string): Notification title.
* smallmessage (string): Notification body, short text.
* fullmessage (string): Notification body, ignored if smallmessage is set.

'''Optional'''

* site (string): Site ID (md5 hash of site URL + username)
* Siteurl (string): Site URL (used to identify the site the notification is coming from)
* wwwroot (string): Moodle’s $CFG->wwwroot
* component (string): Moodle’s component that generated the notification
* contexturl (string): URL the notification is related to
* customdata (json encoded object, all fields are optional)
** notificationiconurl (string): Icon to display in the notification (Android only).
** notificationpictureurl (string). Large picture to display in the notification (Android only).
** tokenpluginfile (string): Token to view the icon if needed.
** extendedtext (string). An extended text (HTML), opened in popup when clicked.
** appurl (string): When notification is clicked, open this URL. Has preference over contexturl but it will be ignored if extendedtext is set.
** appurlopenin (string): Where to open the previous URL ‘browser’, ‘inapp’ or any other value.

=== Sample CURL requests ===

'''AIRNOTIFIER_URL''': Can be obtained from Site administration > Messaging > Mobile

'''APP_ID''': commoodlemoodlemobile for the standard Moodle app

'''AIRNOTIFIER_ACCESS_KEY''': Your Airnotifier Access key that can be obtained from Site administration > Messaging > Mobile

'''DEVICE_TOKEN''': The user’s receiving the notification device token, for testing purposes you can get it via the app -> App settings -> About .> Click at app version -> Push notification ID

In Moodle the push ids are in the user_devices table (pushid field), the previous table has to be joined with message_airnotifier_devices to obtain active devices.

Device could be android-fcm or ios-fcm

'''Simple notification, only subject and body'''

curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test"}}'</syntaxhighlight>

'''Notification opening a popup with custom content on the app'''

curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test", "customdata": "{\"extendedtext\" : \"Extended tex that will open on a popupt\", \"notificationiconurl\" : \"https://picsum.photos/50\", \"notificationpictureurl\" : \"https://picsum.photos/200\"}"}}'

'''Notification opening URL that can be handled by the app (a course within the app)'''

curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test", "customdata": "{ \"appurl\" : \"https://mymoodlesite.net/course/view.php?id=18\", \"notificationiconurl\" : \"https://picsum.photos/50\", \"notificationpictureurl\" : \"https://picsum.photos/200\"}"}}'

Sending custom Push Notifications to the Moodle App

2022-03-29T14:58:05Z

Jleyva: /* Airnotifier API */

{{Moodle App (Ionic 5)}}

There are two ways to send custom Push Notifications to the Moodle app users:

# By using Moodle’s Message API implementing a message provider
# By directly using the Airnotifier (Moodle’s Push Notification server) APIs

'''Main differences are:'''

By using Moodle’s Message API, users (students, teachers, etc..) can opt-out to not receive custom notifications, they can also opt-in to receive them not only on the app but also via email. Messages sent using this API can arrive to non app users.

Using the Airnotifier API will force the user to receive the notification unless they change their app settings to not receive any notification.
Messages sent using this API will only arrive to active app users.

== Moodle’s Message API ==

Please read the official Moodle documentation, [[Message API]], where it is explained how to create a new message provider within a plugin.

Apart from what it is explained in the [[Message API]] please notice that it is possible to add a customdata field (json-encoded) with additional parameters. Those parameters are the ones described in the Airnotifier API section bellow.

== Airnotifier API ==

Airnotifier is the name of the Push Notification server used by Moodle. It is possible to use its own API to send custom notifications from Moodle without having to use Moodle's Message API.

=== Payload format ===

'''Mandatory fields:'''

* processor (string): Always set to moodle
* notification (number): Whether it’s a notification (1) or a message (0).
* subject (string): Notification title.
* smallmessage (string): Notification body, short text.
* fullmessage (string): Notification body, ignored if smallmessage is set.

'''Optional'''

* site (string): Site ID (md5 hash of site URL + username)
* Siteurl (string): Site URL (used to identify the site the notification is coming from)
* wwwroot (string): Moodle’s $CFG->wwwroot
* component (string): Moodle’s component that generated the notification
* contexturl (string): URL the notification is related to
* customdata (json encoded object, all fields are optional)
** notificationiconurl (string): Icon to display in the notification (Android only).
** notificationpictureurl (string). Large picture to display in the notification (Android only).
** tokenpluginfile (string): Token to view the icon if needed.
** extendedtext (string). An extended text (HTML), opened in popup when clicked.
** appurl (string): When notification is clicked, open this URL. Has preference over contexturl but it will be ignored if extendedtext is set.
** appurlopenin (string): Where to open the previous URL ‘browser’, ‘inapp’ or any other value.

=== Sample CURL requests ===

'''AIRNOTIFIER_URL''': Can be obtained from Site administration > Messaging > Mobile

'''APP_ID''': commoodlemoodlemobile for the standard Moodle app

'''AIRNOTIFIER_ACCESS_KEY''': Your Airnotifier Access key that can be obtained from Site administration > Messaging > Mobile

'''DEVICE_TOKEN''': The user’s receiving the notification device token, for testing purposes you can get it via the app -> App settings -> About .> Click at app version -> Push notification ID
In Moodle the push ids are in the user_devices table (pushid field), the previous table has to be joined with message_airnotifier_devices to obtain active devices.

Device could be android-fcm or ios-fcm

'''Simple notification, only subject and body'''

curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test"}}'</syntaxhighlight>

'''Notification opening a popup with custom content on the app'''

curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test", "customdata": "{\"extendedtext\" : \"Extended tex that will open on a popupt\", \"notificationiconurl\" : \"https://picsum.photos/50\", \"notificationpictureurl\" : \"https://picsum.photos/200\"}"}}'

'''Notification opening URL that can be handled by the app (a course within the app)'''

curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test", "customdata": "{ \"appurl\" : \"https://mymoodlesite.net/course/view.php?id=18\", \"notificationiconurl\" : \"https://picsum.photos/50\", \"notificationpictureurl\" : \"https://picsum.photos/200\"}"}}'

Sending custom Push Notifications to the Moodle App

2022-03-29T14:56:36Z

Jleyva: /* Moodle’s Message API */

{{Moodle App (Ionic 5)}}

There are two ways to send custom Push Notifications to the Moodle app users:

# By using Moodle’s Message API implementing a message provider
# By directly using the Airnotifier (Moodle’s Push Notification server) APIs

'''Main differences are:'''

By using Moodle’s Message API, users (students, teachers, etc..) can opt-out to not receive custom notifications, they can also opt-in to receive them not only on the app but also via email. Messages sent using this API can arrive to non app users.

Using the Airnotifier API will force the user to receive the notification unless they change their app settings to not receive any notification.
Messages sent using this API will only arrive to active app users.

== Moodle’s Message API ==

Please read the official Moodle documentation, [[Message API]], where it is explained how to create a new message provider within a plugin.

Apart from what it is explained in the [[Message API]] please notice that it is possible to add a customdata field (json-encoded) with additional parameters. Those parameters are the ones described in the Airnotifier API section bellow.

== Airnotifier API ==

=== Payload format ===

'''Mandatory fields:'''

* processor (string): Always set to moodle
* notification (number): Whether it’s a notification (1) or a message (0).
* subject (string): Notification title.
* smallmessage (string): Notification body, short text.
* fullmessage (string): Notification body, ignored if smallmessage is set.

'''Optional'''

* site (string): Site ID (md5 hash of site URL + username)
* Siteurl (string): Site URL (used to identify the site the notification is coming from)
* wwwroot (string): Moodle’s $CFG->wwwroot
* component (string): Moodle’s component that generated the notification
* contexturl (string): URL the notification is related to
* customdata (json encoded object, all fields are optional)
** notificationiconurl (string): Icon to display in the notification (Android only).
** notificationpictureurl (string). Large picture to display in the notification (Android only).
** tokenpluginfile (string): Token to view the icon if needed.
** extendedtext (string). An extended text (HTML), opened in popup when clicked.
** appurl (string): When notification is clicked, open this URL. Has preference over contexturl but it will be ignored if extendedtext is set.
** appurlopenin (string): Where to open the previous URL ‘browser’, ‘inapp’ or any other value.

=== Sample CURL requests ===

'''AIRNOTIFIER_URL''': Can be obtained from Site administration > Messaging > Mobile

'''APP_ID''': commoodlemoodlemobile for the standard Moodle app

'''AIRNOTIFIER_ACCESS_KEY''': Your Airnotifier Access key that can be obtained from Site administration > Messaging > Mobile

'''DEVICE_TOKEN''': The user’s receiving the notification device token, for testing purposes you can get it via the app -> App settings -> About .> Click at app version -> Push notification ID
In Moodle the push ids are in the user_devices table (pushid field), the previous table has to be joined with message_airnotifier_devices to obtain active devices.

Device could be android-fcm or ios-fcm

'''Simple notification, only subject and body'''

curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test"}}'</syntaxhighlight>

'''Notification opening a popup with custom content on the app'''

curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test", "customdata": "{\"extendedtext\" : \"Extended tex that will open on a popupt\", \"notificationiconurl\" : \"https://picsum.photos/50\", \"notificationpictureurl\" : \"https://picsum.photos/200\"}"}}'

'''Notification opening URL that can be handled by the app (a course within the app)'''

curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test", "customdata": "{ \"appurl\" : \"https://mymoodlesite.net/course/view.php?id=18\", \"notificationiconurl\" : \"https://picsum.photos/50\", \"notificationpictureurl\" : \"https://picsum.photos/200\"}"}}'

Sending custom Push Notifications to the Moodle App

2022-03-29T14:53:53Z

Jleyva: Created page with "{{Moodle App (Ionic 5)}} There are two ways to send custom Push Notifications to the Moodle app users: # By using Moodle’s Message API implementing a message provider # B..."

{{Moodle App (Ionic 5)}}

There are two ways to send custom Push Notifications to the Moodle app users:

# By using Moodle’s Message API implementing a message provider
# By directly using the Airnotifier (Moodle’s Push Notification server) APIs

'''Main differences are:'''

By using Moodle’s Message API, users (students, teachers, etc..) can opt-out to not receive custom notifications, they can also opt-in to receive them not only on the app but also via email. Messages sent using this API can arrive to non app users.

Using the Airnotifier API will force the user to receive the notification unless they change their app settings to not receive any notification.
Messages sent using this API will only arrive to active app users.

== Moodle’s Message API ==

Please read the official Moodle documentation: [[Message API]]

== Airnotifier API ==

=== Payload format ===

'''Mandatory fields:'''

* processor (string): Always set to moodle
* notification (number): Whether it’s a notification (1) or a message (0).
* subject (string): Notification title.
* smallmessage (string): Notification body, short text.
* fullmessage (string): Notification body, ignored if smallmessage is set.

'''Optional'''

* site (string): Site ID (md5 hash of site URL + username)
* Siteurl (string): Site URL (used to identify the site the notification is coming from)
* wwwroot (string): Moodle’s $CFG->wwwroot
* component (string): Moodle’s component that generated the notification
* contexturl (string): URL the notification is related to
* customdata (json encoded object, all fields are optional)
** notificationiconurl (string): Icon to display in the notification (Android only).
** notificationpictureurl (string). Large picture to display in the notification (Android only).
** tokenpluginfile (string): Token to view the icon if needed.
** extendedtext (string). An extended text (HTML), opened in popup when clicked.
** appurl (string): When notification is clicked, open this URL. Has preference over contexturl but it will be ignored if extendedtext is set.
** appurlopenin (string): Where to open the previous URL ‘browser’, ‘inapp’ or any other value.

=== Sample CURL requests ===

'''AIRNOTIFIER_URL''': Can be obtained from Site administration > Messaging > Mobile

'''APP_ID''': commoodlemoodlemobile for the standard Moodle app

'''AIRNOTIFIER_ACCESS_KEY''': Your Airnotifier Access key that can be obtained from Site administration > Messaging > Mobile

'''DEVICE_TOKEN''': The user’s receiving the notification device token, for testing purposes you can get it via the app -> App settings -> About .> Click at app version -> Push notification ID
In Moodle the push ids are in the user_devices table (pushid field), the previous table has to be joined with message_airnotifier_devices to obtain active devices.

Device could be android-fcm or ios-fcm

'''Simple notification, only subject and body'''

curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test"}}'</syntaxhighlight>

'''Notification opening a popup with custom content on the app'''

curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test", "customdata": "{\"extendedtext\" : \"Extended tex that will open on a popupt\", \"notificationiconurl\" : \"https://picsum.photos/50\", \"notificationpictureurl\" : \"https://picsum.photos/200\"}"}}'

'''Notification opening URL that can be handled by the app (a course within the app)'''

curl https://AIRNOTIFIER_URL/api/v2/push -X POST -H "X-AN-APP-NAME: APP_ID" -H "X-AN-APP-KEY: AIRNOTIFIER_ACCESS_KEY" --data '{"device": "android-fcm", "token": "DEVICE_TOKEN", "extra": {"processor" : "moodle", "notification": 1, "subject": "Title test", "fullmessage": "Message test", "customdata": "{ \"appurl\" : \"https://mymoodlesite.net/course/view.php?id=18\", \"notificationiconurl\" : \"https://picsum.photos/50\", \"notificationpictureurl\" : \"https://picsum.photos/200\"}"}}'

Using the Moodle App in a browser

2022-02-16T18:26:34Z

Jleyva: /* Installation and configuration */

Browsers are not officially supported by the application, but you can use a Chromium-based browser for development if you don’t need any native functionality.

Please notice that it has to be a Chromium-based browser, because the application relies on the [https://caniuse.com/?search=websql Web SQL Database API] which isn't supported in most browsers. This is a non-standard API, but that's not a problem because this is only used in the browser. Running on a native environment, the application relies on native APIs that are well supported.
{{Moodle App (Ionic 5)}}
== Differences between Chromium and Google Chrome ==
Google Chrome is the Chromium open source project built, packaged, and distributed by Google. We can say that Chromium is Google Chrome without the "Google" add-ons. For that reason, we recommend using Chromium instead of Google Chrome.
== Advantages and disadvantages of using a browser instead of a native device ==
Main advantages:
* Faster development.
* DOM inspector.
* Network monitor.
* Database inspector.
* Emulation options.

Disadvantages:
* You can't use native functionality.
* If you need to use Cordova plugins, you will probably need to provide a way to emulate those APIs in the browser or avoid calling them in the browser environment.
* You will always need to test in a native device prior to a production release.
* You will need to verify that your CSS/layout looks the same in native devices.
== Installation and configuration ==
You can install the Chromium browser by downloading it from [https://www.chromium.org/getting-involved/download-chromium the official download page].

In order to run the Moodle App, we recommend that you launch the browser with a couple of arguments. These are necessary to disable some of the limitations that don't exist in the native application, and also prepare the development environment:
<syntaxhighlight lang="bash">
chromium-browser --allow-file-access-from-files --disable-web-security --allow-running-insecure-content --no-referrers --unlimited-storage --auto-open-devtools-for-tabs --user-data-dir=~/.chromium-dev-data
</syntaxhighlight>
The command above will work on Linux. If you are using other operative system, check out [https://www.chromium.org/developers/how-tos/run-chromium-with-flags how to run chromium with flags] in other environments.

Please, notice also that certain versions of Chrome might required this additional flag to work: --disable-site-isolation-trials

For more info about the user data dir, please read [https://chromium.googlesource.com/chromium/src/+/master/docs/user_data_dir.md the official documentation].
=== Creating a shortcut ===
We strongly recommend that you create a new shortcut and use it only for working with the app during development. In Linux, and possibly other operating systems, these arguments only work if you don't already have the same browser running. Hence if you use Google Chrome as your normal browser, you can use Chromium for development and vice versa.

In Linux, you can create such a shortcut by writing a script that is globally available. For example, you can create the following file in <code>/usr/local/bin/unsafe-chromium</code>:
<syntaxhighlight lang="bash">
#!/bin/bash
chromium-browser --allow-file-access-from-files --disable-web-security --allow-running-insecure-content --no-referrers --unlimited-storage --auto-open-devtools-for-tabs --user-data-dir=/home/{username}/.chromium-dev-data $@
</syntaxhighlight>
Notice that this time we shouldn't use <code>~/.chromium-dev-data</code> to describe the user data dir. That's because this file can be called from a different shell, and <code>~</code> could not be interpreted properly (this may end up creating a folder called "~" in your project folder, and you probably don't want that).

Also, remember to make this file executable by running <code>sudo chmod +x /usr/local/bin/unsafe-chromium</code>.

For convenience, you can also define an application launch that calls this script.
'''Help wanted!''' These instructions have only been tested in Linux. If you are using a different operative system, [[Talk:Using the Moodle App in a browser|let us know]] how it went (or just [https://docs.moodle.org/dev/index.php?title=Using_the_Moodle_App_in_a_browser&veaction=edit edit this page]!).
=== Configuring the default browser ===
When you launch the application by running <code>npm start</code>, this will open a tab on your default browser. You can close this tab and open the url with your development browser, but if you want to do it automatically you can override the default browser by setting the <code>MOODLE_APP_BROWSER</code> environment variable.

For example, if you have created a shortcut like we mentioned in the previous section, you can just add the following to your <code>~/.bashrc</code> file:
<syntaxhighlight lang="bash">
export MOODLE_APP_BROWSER=unsafe-chromium
</syntaxhighlight>
'''Help wanted!''' These instructions have only been tested in Linux. If you are using a different operative system, [[Talk:Using the Moodle App in a browser|let us know]] how it went (or just [https://docs.moodle.org/dev/index.php?title=Using_the_Moodle_App_in_a_browser&veaction=edit edit this page]!).
== Tips & tricks ==
Once you have everything set up, you should be able to develop like you would with any other front-end application. You can learn about the development tools you have available by reading the [https://developer.chrome.com/devtools/index Chrome DevTools documentation].

Here's some things we find useful to work with the Moodle App in particular:
* [https://developer.chrome.com/docs/devtools/device-mode/ Device Mode] — You can use this feature to make the browser behave more like a native device. This will work best if you [https://developer.chrome.com/docs/devtools/customize/placement/ dock the development panel] to one side (left or right), but you may want to do something else in your environment.
* [https://developer.chrome.com/docs/devtools/console/ Console Panel] — This panel is essential for any developer, since it will show you any errors or custom messages that you've written. You can also use the search box to filter messages seeing everything is too overwhelming. You will also see specific logs from the Moodle App, but keep in mind that they are not used in production environment. If you are not running the application yourself, you can inspect the environment by opening the /assets/env.json url.
* [https://developer.chrome.com/docs/devtools/dom/ Elements Panel] — This panel is also essential for any developer, you'll be able to inspect and modify the HTML that is actually being rendered.
* [https://developer.chrome.com/docs/devtools/network/ Network Panel] — This panel can be useful if you are trying to see how the Moodle App communicates with a Moodle site. You may also want to [https://developer.chrome.com/docs/devtools/network/reference/#disable-cache disable the cache] in order to have the same behaviour after each reload. However, keep in mind that this only disables the browser cache, any Web Service calls that are cached by the Moodle App will remain cached. You can learn more about network requests in the [[Debugging network requests in the Moodle App]] page.
* [https://developer.chrome.com/docs/devtools/storage/websql/ WebSQL Inspector] — As mentioned before, WebSQL is a non-standard API. But since the Moodle App uses it for development, this inspector may come in handy. Keep in mind that the native application does not use WebSQL, so it is possible that you see some different behaviour in a native device. But it should be reliable for the most part.
[[Category: Mobile]]
[[Category: Moodle App Ionic 5]]

Moodle Mobile 3.9.5 release notes

2021-08-31T09:00:50Z

Jleyva: /* New features and improvements */

[[Moodle Mobile release notes]] > {{FULLPAGENAME}}

Release date: 27 August 2021
==New features and improvements==
* Accessibility improvements to achieve WCAG 2.1 AA compliance
* H5P improvements - play packages using as much screen as possible and improve the way they are embedded
* Moodle 3.11 student activity completion support
* LTI 1.3 launch support
* iOS ITP settings support to allow the iOS version of the app to embed content from different URLs
* New option in iOS for allowing a user to open a file using the system preview or a dedicated app
* Plagiarism information displayed in essay question types
* Word count support in quiz essay questions
* Quiz pass grade displayed on quiz front page
==Iconic 5 upgrade==
In this version, we have upgraded the framework we use for building the app. Note that there are several changes which may impact plugins or sites using their own custom mobile CSS:
* If you have developed a plugin that is supported for the Moodle app please read [[Adapt your Mobile plugins to Ionic 5]]
* If you have a Premium app subscription and your own Moodle app theme please read [[Ionic5 style migration guide]]
==Complete list of issues==

=== Bug ===
* MOBILE-3496 - NOT_FOUND_ERR when uploading video for Assignment from "Photo albums" on iOS
* MOBILE-3563 - Workshop does not have submit button, when allowed late submissions
* MOBILE-3567 - The app does not launch a course view event after the user self-enrol into the course
* MOBILE-3615 - Button "Help" opens wrong website
* MOBILE-3623 - Site plugins: success message not seen if combined with goBackOnSuccess
* MOBILE-3670 - Navbar color and custom CSS clash on login page.
* MOBILE-3674 - Make CoreUrl.sameDomainAndPath case insensitive
* MOBILE-3693 - Radio button: item not clickable if it contains links
* MOBILE-3694 - Auto-login only works in first iframe if several are displayed at the same time
* MOBILE-3701 - iOS: SCORM package reloaded when clicking a link with href '#' and handled via JS
* MOBILE-3704 - Page: Files with parameters not working
* MOBILE-3709 - SCORM does not registrer cmi.core.total_time APP mobile
* MOBILE-3713 - Cookies not sent to iframes in iOS 14 (preventing embedding external content such as H5P)
* MOBILE-3722 - It is not possible to create events for 2022 onwards
* MOBILE-3724 - Fix LTI 1.3 launch in the app
* MOBILE-3789 - Assignment blind marking
* MOBILE-3797 - User profiles can cause infinite requests with custom course themes
* MOBILE-3832 - Infinite scroll: infinite requests when an error happens
=== New Feature ===
* MOBILE-3757 - Support new student completion
=== Task ===
* MOBILE-3732 - Display plagiarism information in the essay question type
=== Improvement ===
* MOBILE-3673 - Update target SDK to 30
* MOBILE-3680 - Apply essay question min/max word count in the app
* MOBILE-3698 - Review if word count changes done in MDL-70796 should be applied to the app
* MOBILE-3716 - Include the Scan QR code button in the reconnect screen
* MOBILE-3734 - Review single activity course format in Ionic 5
* MOBILE-3739 - Add a leave guard on chat
* MOBILE-3742 - Support links to other sites in Ionic 5 (redirect)
* MOBILE-3754 - Pass grade not displayed on quiz front page
* MOBILE-3758 - Update H5P library to 1.24.02
* MOBILE-3761 - Show "open with" dialog when opening a file
* MOBILE-3762 - Recaptcha open button does not explain the function
* MOBILE-3765 - Include a link to a permanent survey about the Moodle app
* MOBILE-3766 - Include a link to provide feedback during beta testing
* MOBILE-3771 - Do not display the bottom navigation menu for the H5P activity when playing a package
* MOBILE-3783 - Release Moodle app version 3.9.5
=== Sub-task ===
* MOBILE-3565 - Create a minimum base of the app using Ionic 5
* MOBILE-3591 - Migrate tags structure
* MOBILE-3592 - Migrate user feature to ionic 5
* MOBILE-3608 - Migrate blocks to ionic5
* MOBILE-3609 - Implement split view component
* MOBILE-3620 - Migrate filters to Ionic 5
* MOBILE-3624 - Migrate badges to Ionic 5
* MOBILE-3625 - Migrate blocks with module dependency to Ionic 5
* MOBILE-3626 - Migrate calendar to Ionic 5
* MOBILE-3627 - Migrate blog feature to Ionic 5
* MOBILE-3628 - Migrate competency and learning plans to Ionic 5
* MOBILE-3629 - Migrate course completion to Ionic 5
* MOBILE-3630 - Migrate shared files to Ionic 5
* MOBILE-3631 - Migrate messaging addon to Ionic 5
* MOBILE-3632 - Migrate Notes to Ionic 5
* MOBILE-3633 - Migrate notifications to Ionic 5
* MOBILE-3634 - Migrate remote themes to Ionic 5
* MOBILE-3635 - Migrate storage manager to Ionic 5
* MOBILE-3636 - Migrate assign activity to Ionic 5
* MOBILE-3637 - Migrate book activity to Ionic 5
* MOBILE-3638 - Migrate chat activity to Ionic 5
* MOBILE-3639 - Migrate choice activity to Ionic 5
* MOBILE-3640 - Migrate database activity to Ionic 5
* MOBILE-3641 - Migrate feedback activity to Ionic 5
* MOBILE-3642 - Migrate folder activity to Ionic 5
* MOBILE-3643 - Migrate forum activity to Ionic 5
* MOBILE-3644 - Migrate glossary activity to Ionic 5
* MOBILE-3645 - Migrate h5p activity to Ionic 5
* MOBILE-3646 - Migrate IMSCP activity to Ionic 5
* MOBILE-3647 - Migrate label activity to Ionic 5
* MOBILE-3648 - Migrate lesson activity to Ionic 5
* MOBILE-3649 - Migrate lti activity to Ionic 5
* MOBILE-3650 - Migrate page activity to Ionic 5
* MOBILE-3651 - Migrate quiz activity to Ionic 5
* MOBILE-3652 - Migrate resource activity to Ionic 5
* MOBILE-3653 - Migrate scorm activity to Ionic 5
* MOBILE-3654 - Migrate survey activity to Ionic 5
* MOBILE-3655 - Migrate url activity to Ionic 5
* MOBILE-3656 - Migrate wiki activity to Ionic 5
* MOBILE-3657 - Migrate workshop activity to Ionic 5
* MOBILE-3658 - Migrate comments feature to Ionic 5
* MOBILE-3659 - Migrate course feature to Ionic 5
* MOBILE-3660 - Migrate courses feature to Ionic 5
* MOBILE-3661 - Migrate grades feature to Ionic 5
* MOBILE-3662 - Migrate push notifications feature to Ionic 5
* MOBILE-3663 - Migrate rating feature to Ionic 5
* MOBILE-3664 - Migrate site plugins to Ionic 5
* MOBILE-3665 - Change language files placement
* MOBILE-3666 - Migrate core H5P code to Ionic 5
* MOBILE-3675 - Migrate participants and course grades tab to Ionic 5
* MOBILE-3689 - Review initialization
* MOBILE-3690 - Abstract some splitview code to improve navigation and resizing
* MOBILE-3691 - Prevent iframe navigation from taking over the app
* MOBILE-3712 - Migrate QR scanner to Ionic 5
* MOBILE-3720 - Review platforms support
* MOBILE-3738 - Migrate Behat tests to ionic 5
* MOBILE-3744 - Improve icons labelling
* MOBILE-3746 - Solve iOS Visible Keyboard Focus
* MOBILE-3749 - Increse touch target area to 44x44 at least
* MOBILE-3750 - Add an alternative way to horizontal scrolls
* MOBILE-3751 - Consistent heading design
* MOBILE-3752 - Table related a11y issues
* MOBILE-3753 - Improve buttons labelling
* MOBILE-3759 - Review ion-badges a11y text
[[Category:Mobile]]
[[Category:Release notes]]

Moodle App Release Notes

2021-08-27T17:15:54Z

Jleyva: /* Moodle App */

== Moodle App ==

{| class="wikitable"
|-
! Version name
! Date
! Version code
!
|-
! Moodle Mobile 3.9.5
| 27 August 2021
| 39500
| [[Moodle Mobile 3.9.5 release notes|Release Notes]]
|-
! Moodle Mobile 3.9.4
| 28 December 2020
| 39400
| [[Moodle Mobile 3.9.4 release notes|Release Notes]]
|-
! Moodle Mobile 3.9.3
| 30 November 2020
| 39300
| [[Moodle Mobile 3.9.3 release notes|Release Notes]]
|-
! Moodle Mobile 3.9.2
| 16 July 2020
| 39200
| [[Moodle Mobile 3.9.2 release notes|Release Notes]]
|-
! Moodle Mobile 3.9.1
| 3 July 2020
| 39100
| [[Moodle Mobile 3.9.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.9.0
| 26 June 2020
| 39000
| [[Moodle Mobile 3.9.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.8.2
| 2 April 2020
| 38200
| [[Moodle Mobile 3.8.2 release notes|Release Notes]]
|-
! Moodle Mobile 3.8.1
| 25 March 2020
| 38100
| [[Moodle Mobile 3.8.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.8.0
| 20 December 2019
| 38000
| [[Moodle Mobile 3.8.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.7.2
| 20 September 2019
| 37200
| [[Moodle Mobile 3.7.2 release notes|Release Notes]]
|-
! Moodle Mobile 3.7.1
| 30 August 2019
| 37100
| [[Moodle Mobile 3.7.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.7.0
| 7 June 2019
| 37000
| [[Moodle Mobile 3.7.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.6.1
| 29 March 2019
| 36100
| [[Moodle Mobile 3.6.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.6.0
| 11 January 2019
| 36000
| [[Moodle Mobile 3.6.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.5.2
| 10 September 2018
| 35200
| [[Moodle Mobile 3.5.2 release notes|Release Notes]]
|-
! Moodle Mobile 3.5.1
| 6 July 2018
| 35100
| [[Moodle Mobile 3.5.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.5.0
| 25 June 2018
| 35000
| [[Moodle Mobile 3.5.0 release notes|Release Notes]]
|}

== Moodle Mobile ==

Versions with support or 3.0 and previous versions, based on Ionic 1.

{| class="wikitable"
|-
! Version name
! Date
! Version code
!
|-
! Moodle Mobile 3.4.2
| 19 March 2018
| 20230
| [[Moodle Mobile 3.4.2 release notes|Release Notes]]
|-
! Moodle Mobile 3.4.1
| 28 February 2018
| 20220
| [[Moodle Mobile 3.4.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.4.0
| 30 November 2017
| 20210
| [[Moodle Mobile 3.4.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.3.2
| 29 September 2017
| 20200
| [[Moodle Mobile 3.3.2 release notes|Release Notes]]
|-
! Moodle Mobile 3.3.1
| 28 July 2017
| 20190
| [[Moodle Mobile 3.3.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.3.0
| 26 May 2017
| 20180
| [[Moodle Mobile 3.3.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.2.1
| 28 February 2017
| 20170
| [[Moodle Mobile 3.2.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.2.0
| 12 December 2016
| 20160
| [[Moodle Mobile 3.2.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.1.3
| 19 October 2016
| 20150
| [[Moodle Mobile 3.1.3 release notes|Release Notes]]
|-
! Moodle Mobile 3.1.2
| 27 July 2016
| 2014
| [[Moodle Mobile 3.1.2 release notes|Release Notes]]
|-
! Moodle Mobile 3.1.1
| 14 June 2016
| 2013
| [[Moodle Mobile 3.1.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.1.0
| 23 May 2016
| 2012
| [[Moodle Mobile 3.1.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.0.0
| 15 April 2016
| 2011
| [[Moodle Mobile 3.0.0 release notes|Release Notes]]
|-
! Moodle Mobile 2.9
| 29 February 2016
| 2010
| [[Moodle Mobile 2.9 release notes|Release Notes]]
|-
! Moodle Mobile 2.8
| 22 January 2016
| 2009
| [[Moodle Mobile 2.8 release notes|Release Notes]]
|-
! Moodle Mobile 2.7
| 29 December 2015
| 2008
| [[Moodle Mobile 2.7 release notes|Release Notes]]
|-
! Moodle Mobile 2.6
| 27 November 2015
| 2007
| [[Moodle Mobile 2.6 release notes|Release Notes]]
|-
! Moodle Mobile 2.5
| 6 November 2015
| 2006
| [[Moodle Mobile 2.5 release notes|Release Notes]]
|-
! Moodle Mobile 2.4
| 21 October 2015
| 2005
| [[Moodle Mobile 2.4 release notes|Release Notes]]
|-
! Moodle Mobile 2.3
| 8 October 2015
| 2004
| [[Moodle Mobile 2.3 release notes|Release Notes]]
|-
! Moodle Mobile 2.2
| 10 September 2015
| 2003
| [[Moodle Mobile 2.2 release notes|Release Notes]]
|-
! Moodle Mobile 2.1
| 28 August 2015
| 2002
| [[Moodle Mobile 2.1 release notes|Release Notes]]
|-
! Moodle Mobile 2.0
| 31 July 2015
| 2000
| [[Moodle Mobile 2.0 release notes|Release Notes]]
|}

== Moodle Mobile 1 ==

See [[Moodle Mobile 1 release notes]]

== See also ==

* [[Moodle Desktop release notes]]
* [[Moodle Mobile Roadmap]]

[[Category: Mobile]]
[[Category:Release notes]]

Moodle Mobile 3.9.5 release notes

2021-08-27T17:15:14Z

Jleyva:

[[Moodle Mobile release notes]] > {{FULLPAGENAME}}

Release date: Not yet released

==New features and improvements==

* Accessibility improvements to achieve WCAG 2.1 AA compliance
* H5P improvements - play packages using as much screen as possible and improve the way they are embedded
* Moodle 3.11 student activity completion support
* LTI 1.3 launch support
* iOS ITP settings support to allow the iOS version of the app to embed content from different URLs
* New option in iOS for allowing a user to open a file using the system preview or a dedicated app
* Plagiarism information displayed in essay question types
* Word count support in quiz essay questions
* Quiz pass grade displayed on quiz front page

==Iconic 5 upgrade==

In this version, we have upgraded the framework we use for building the app. Note that there are several changes which may impact plugins or sites using their own custom mobile CSS:

* If you have developed a plugin that is supported for the Moodle app please read [[Adapt your Mobile plugins to Ionic 5]]
* If you have a Premium app subscription and your own Moodle app theme please read [[Ionic5 style migration guide]]

==Complete list of issues==

=== Bug ===
* MOBILE-3496 - NOT_FOUND_ERR when uploading video for Assignment from "Photo albums" on iOS
* MOBILE-3563 - Workshop does not have submit button, when allowed late submissions
* MOBILE-3567 - The app does not launch a course view event after the user self-enrol into the course
* MOBILE-3615 - Button "Help" opens wrong website
* MOBILE-3623 - Site plugins: success message not seen if combined with goBackOnSuccess
* MOBILE-3670 - Navbar color and custom CSS clash on login page.
* MOBILE-3674 - Make CoreUrl.sameDomainAndPath case insensitive
* MOBILE-3693 - Radio button: item not clickable if it contains links
* MOBILE-3694 - Auto-login only works in first iframe if several are displayed at the same time
* MOBILE-3701 - iOS: SCORM package reloaded when clicking a link with href '#' and handled via JS
* MOBILE-3704 - Page: Files with parameters not working
* MOBILE-3709 - SCORM does not registrer cmi.core.total_time APP mobile
* MOBILE-3713 - Cookies not sent to iframes in iOS 14 (preventing embedding external content such as H5P)
* MOBILE-3722 - It is not possible to create events for 2022 onwards
* MOBILE-3724 - Fix LTI 1.3 launch in the app
* MOBILE-3789 - Assignment blind marking
* MOBILE-3797 - User profiles can cause infinite requests with custom course themes
* MOBILE-3832 - Infinite scroll: infinite requests when an error happens

=== New Feature ===
* MOBILE-3757 - Support new student completion

=== Task ===
* MOBILE-3732 - Display plagiarism information in the essay question type

=== Improvement ===
* MOBILE-3673 - Update target SDK to 30
* MOBILE-3680 - Apply essay question min/max word count in the app
* MOBILE-3698 - Review if word count changes done in MDL-70796 should be applied to the app
* MOBILE-3716 - Include the Scan QR code button in the reconnect screen
* MOBILE-3734 - Review single activity course format in Ionic 5
* MOBILE-3739 - Add a leave guard on chat
* MOBILE-3742 - Support links to other sites in Ionic 5 (redirect)
* MOBILE-3754 - Pass grade not displayed on quiz front page
* MOBILE-3758 - Update H5P library to 1.24.02
* MOBILE-3761 - Show "open with" dialog when opening a file
* MOBILE-3762 - Recaptcha open button does not explain the function
* MOBILE-3765 - Include a link to a permanent survey about the Moodle app
* MOBILE-3766 - Include a link to provide feedback during beta testing
* MOBILE-3771 - Do not display the bottom navigation menu for the H5P activity when playing a package
* MOBILE-3783 - Release Moodle app version 3.9.5

=== Sub-task ===
* MOBILE-3565 - Create a minimum base of the app using Ionic 5
* MOBILE-3591 - Migrate tags structure
* MOBILE-3592 - Migrate user feature to ionic 5
* MOBILE-3608 - Migrate blocks to ionic5
* MOBILE-3609 - Implement split view component
* MOBILE-3620 - Migrate filters to Ionic 5
* MOBILE-3624 - Migrate badges to Ionic 5
* MOBILE-3625 - Migrate blocks with module dependency to Ionic 5
* MOBILE-3626 - Migrate calendar to Ionic 5
* MOBILE-3627 - Migrate blog feature to Ionic 5
* MOBILE-3628 - Migrate competency and learning plans to Ionic 5
* MOBILE-3629 - Migrate course completion to Ionic 5
* MOBILE-3630 - Migrate shared files to Ionic 5
* MOBILE-3631 - Migrate messaging addon to Ionic 5
* MOBILE-3632 - Migrate Notes to Ionic 5
* MOBILE-3633 - Migrate notifications to Ionic 5
* MOBILE-3634 - Migrate remote themes to Ionic 5
* MOBILE-3635 - Migrate storage manager to Ionic 5
* MOBILE-3636 - Migrate assign activity to Ionic 5
* MOBILE-3637 - Migrate book activity to Ionic 5
* MOBILE-3638 - Migrate chat activity to Ionic 5
* MOBILE-3639 - Migrate choice activity to Ionic 5
* MOBILE-3640 - Migrate database activity to Ionic 5
* MOBILE-3641 - Migrate feedback activity to Ionic 5
* MOBILE-3642 - Migrate folder activity to Ionic 5
* MOBILE-3643 - Migrate forum activity to Ionic 5
* MOBILE-3644 - Migrate glossary activity to Ionic 5
* MOBILE-3645 - Migrate h5p activity to Ionic 5
* MOBILE-3646 - Migrate IMSCP activity to Ionic 5
* MOBILE-3647 - Migrate label activity to Ionic 5
* MOBILE-3648 - Migrate lesson activity to Ionic 5
* MOBILE-3649 - Migrate lti activity to Ionic 5
* MOBILE-3650 - Migrate page activity to Ionic 5
* MOBILE-3651 - Migrate quiz activity to Ionic 5
* MOBILE-3652 - Migrate resource activity to Ionic 5
* MOBILE-3653 - Migrate scorm activity to Ionic 5
* MOBILE-3654 - Migrate survey activity to Ionic 5
* MOBILE-3655 - Migrate url activity to Ionic 5
* MOBILE-3656 - Migrate wiki activity to Ionic 5
* MOBILE-3657 - Migrate workshop activity to Ionic 5
* MOBILE-3658 - Migrate comments feature to Ionic 5
* MOBILE-3659 - Migrate course feature to Ionic 5
* MOBILE-3660 - Migrate courses feature to Ionic 5
* MOBILE-3661 - Migrate grades feature to Ionic 5
* MOBILE-3662 - Migrate push notifications feature to Ionic 5
* MOBILE-3663 - Migrate rating feature to Ionic 5
* MOBILE-3664 - Migrate site plugins to Ionic 5
* MOBILE-3665 - Change language files placement
* MOBILE-3666 - Migrate core H5P code to Ionic 5
* MOBILE-3675 - Migrate participants and course grades tab to Ionic 5
* MOBILE-3689 - Review initialization
* MOBILE-3690 - Abstract some splitview code to improve navigation and resizing
* MOBILE-3691 - Prevent iframe navigation from taking over the app
* MOBILE-3712 - Migrate QR scanner to Ionic 5
* MOBILE-3720 - Review platforms support
* MOBILE-3738 - Migrate Behat tests to ionic 5
* MOBILE-3744 - Improve icons labelling
* MOBILE-3746 - Solve iOS Visible Keyboard Focus
* MOBILE-3749 - Increse touch target area to 44x44 at least
* MOBILE-3750 - Add an alternative way to horizontal scrolls
* MOBILE-3751 - Consistent heading design
* MOBILE-3752 - Table related a11y issues
* MOBILE-3753 - Improve buttons labelling
* MOBILE-3759 - Review ion-badges a11y text

[[Category:Mobile]]
[[Category:Release notes]]

Moodle App Remote Themes Upgrade Guide

2021-06-21T12:24:07Z

Jleyva: /* How to inspect the app styles and CSS */

{{Template:Ionic5}}

In the following guide you will find some examples to migrate your styles to apply ionic5 based Moodle app (3.9.5). It contains tables where each row is a migration to do, the left part is the old code and the right part the new one.

We recommend that you prepend your old CSS rules (see ‘Before starting the migration’), by doing so users that are still using Moodle App 3.9.4 (or earlier versions) will see the same styling you had until now.

==Before starting the migration==

# Remove all styles using ionic classes ending with '''-wp''' (Windows Phone is not supported therefore it’s not necessary to specify it)
# Check [https://github.com/moodlehq/moodleapp/blob/ionic5/src/theme/theme.light.scss the theme file (link can change in the future)] where almost all variables are specified.
# As in the previous version, do not use any Saas variable (the ones starting with $). But you can use CSS3 ones (starting with --)
# We recommend prepending all css rules with '''body.ionic5''' in order to make them only available for ionic5 and the old ones prepend them with '''body:not(.ionic5)''' for the previous versions of the Moodle App (3.9.4, 3.9.3, and so on).
# Be aware that example rules may differ from your css that could be more specific.

=== How to inspect the app styles and CSS ===

We recommend you to install the Chromium browser and follow this guide: [[Moodle Mobile development using Chrome or Chromium]]

For opening the new version of the app you can use this link: https://ionic5.apps.moodledemo.net. (This link can change in a near future)

Please, notice that it is very important to launch the browser with the indicated flags in the previous document, otherwise your custom CSS will not load.

=== Platform based styles ===

To apply a variable or a rule only to iOS or Android, prepend the whole rule with '''html.ios''' for ios or '''html.md''' for android devices. Note the correct rule is to place html before body.

===Dark mode styles===
To apply a variable or a rule only to dark mode, prepend the rule with '''body.dark'''.

Example, toolbar background color on ios dark mode:

<code css>
html.ios body.ionic5.dark {
--core-header-toolbar-background: red;
}</code>

Bear in mind that you can disable Dark Mode for all your users following [https://docs.moodle.org/en/Moodle_app_guide_for_admins#Disabled_features Moodle app guide for admins (Disabled features)]

===Shadow DOM===
Ionic is a set of web components and shadow DOM is a way to encapsulate them and make them a little less transparent to the developer and user (hiding markup structure, style, and behavior) but avoiding clash when using them.

This makes it more difficult to personalize and change some parts of those components. However you can check the [https://ionicframework.com/docs/components Ionic documentation of each] to check the parts that are customizable.

====Example, to change ion-button:====
# Check shadow parts that you can access.

You can style “native” part this way:

<code css>
ion-button::part(native) {
text-transform: none;
}</code>

# Check css exposed variables:
You can change all buttons background, or just the ones with an specific class:

<code css>
ion-button {
--background: red;
}

ion-button.specific {
--background: yellow;
}</code>

====More information about shadow DOM:====
* [https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_shadow_DOM Using shadow DOM - Web Components | MDN]
* [https://ionicframework.com/docs/theming/css-shadow-parts CSS Shadow Parts - Ionic Documentation]
* [https://ionicframework.com/blog/shadow-dom-in-ionic-and-why-its-awesome/ Shadow DOM in Ionic (and Why it's Awesome) - Ionic Blog]

== Main colors ==
The main color in the app is Moodle orange, but you can change it just using:

<code css>
--brand-color: red;</code>

This will probably reduce all the css you are applying right now.
===Named Colors===

--blue, --red, --green, --yellow, --turquoise, --purple but you’ll have to define also the variants: --blue-light, --blue-dark, --red-light, --red-dark, and also for green and yellow (purple and turquoise don’t use any variant).

===Purpose colors===
* --primary (brand-color)
* --danger (red)
* --warning (yellow)
* --success (green)
* --info (blue)
* --light (gray-lighter)
* --medium (gray-light)
* --dark (black)

For those you’ll have to define also some variants, ie, primary color:

* --ion-color-primary-rgb: RGB list of the color, ie 245, 233, 222;
* --ion-color-primary-contrast: Black or white depending on which color gives more contrast.
* --ion-color-primary-contrast-rgb: RGB version of the contrast color: 0, 0, 0 or 255, 255, 255
* --ion-color-primary-shade: Slightly darker color. (mix 12% of black)
* --ion-color-primary-tint: Slightly lighter color. (mix 10% of white)

There are limitations on copying those colors (blue, red) to the purpose colors (primary, secondary, success, etc) and, the changes won’t apply to both of them so you’ll have to define all the variables to have a complete change.

===Page background===
<code css>
--background-color: white;
--ion-background-color-rgb: 255, 255, 255; // Need to be translated to rgb.</code>
===Main text color===
<code css>
--text-color: black;
--ion-text-color-rgb: 0, 0, 0; // Need to be translated to rgb.</code>

Color used in categories and secondary content.
<code css>
--subdued-text-color: gray;</code>

Links color
<code css>
--core-link-color: blue;</code>

==Header toolbar==
On the header toolbar, we’ve added a bottom border that you can disable.

===Background===
{| class="wikitable" border="1"
|-
| <code css>
.toolbar-background-md,
.toolbar-background-ios {
background: red;
}</code>
| <code css>--core-header-toolbar-background: red;</code>
|}

===Text and buttons===
{| class="wikitable" border="1"
|-
| <code css>
.toolbar-title-md,
.toolbar-title-ios {
color: red;
}
</code>
| <code css>--core-header-toolbar-color: red;</code>
|-
| <code css>
.toolbar-title-md,
.toolbar-title-ios {
font-weight: normal;
}
</code>
| <code css>ion-header ion-toolbar.in-toolbar h1,
ion-header ion-toolbar.in-toolbar h2 {
font-weight: normal;
}
</code>
|}
===Buttons color===
{| class="wikitable" border="1"
|-
| <code css>
.bar-button-clear-md-default, .bar-button-default-md, .bar-button-md-default,
.bar-button.button-md,
.bar-button-clear-ios-default, .bar-button-default-ios, .bar-button-ios-default,
.bar-button.button-ios {
color: yellow;
}
</code>
| <code css>ion-header ion-toolbar ion-button {
--ion-toolbar-color: blue;
--color: yellow;
}
</code>
|}
===Border width and color (new)===
<code css>
--core-header-toolbar-border-width: 2px; // 0 will disable it.
--core-header-toolbar-border-color: yellow;
</code>

==Bottom tab bar (main menu)==
===Background===
{| class="wikitable" border="1"
|-
| <code css>.tabs-md .tabbar,
.tabs-ios .tabbar {
background: red;
}
</code>
| <code css>--core-bottom-tabs-background: red;</code>
|}
===Tab icon color===
{| class="wikitable" border="1"
|-
| <code css>.tabs-md .tab-button-icon,
.tabs-ios .tab-button-icon {
color: blue;
}
</code>
| <code css>--core-bottom-tabs-color: blue;</code>
|}
===Selected tab icon color===
{| class="wikitable" border="1"
|-
| <code css>tabs-md .tab-button[aria-selected=true] .tab-button-icon,
.tabs-ios .tab-button[aria-selected=true] .tab-button-icon {
color: red;
}
</code>
| <code css>--core-bottom-tabs-color-selected: red;</code>
|}
===Badge color and text===
{| class="wikitable" border="1"
|-
| <code css>core-ion-tabs .tab-badge.badge {
color: white;
background: red;
}
</code>
| <code css>--core-bottom-tabs-badge-text-color: white;
--core-bottom-tabs-badge-color: red;
</code>
|}

==Top tabs==
===Tabs background===
{| class="wikitable" border="1"
|-
| <code css>.core-tabs-bar {
background-color: red;
}
</code>
| <code css>--core-tabs-background: red;</code>
|}
===Individual tab background===
{| class="wikitable" border="1"
|-
| <code css>.core-tabs-bar .tab-slide {
background-color: red;
}
</code>
| <code css>--core-tab-background: red;</code>
|}
===Unselected tab styles===
{| class="wikitable" border="1"
|-
| <code css>.core-tabs-bar .tab-slide {
color: red;
border-bottom-color: red;
}
</code>
| <code css>--core-tab-color: red;
--core-tab-border-color: red;
</code>
|}
===Selected tab styles===
{| class="wikitable" border="1"
|-
| <code css>.core-tabs-bar .tab-slide[aria-selected=true]{
color: red;
border-bottom-color: red;
font-weigth: normal;
}
</code>
| <code css>--core-tab-color-active: red;
--core-tab-border-color-active: red;
--core-tab-font-weight-active: bold;
</code>
|}

==Items==
===Items background color===
{| class="wikitable" border="1"
|-
| <code css>ion-item {
background: red;
}
</code>
| <code css>--ion-item-background: red;</code>
|}
===Item divider background color===
{| class="wikitable" border="1"
|-
| <code css>.item-divider-md,
.item-divider-ios {
background: red;
color: yellow;
}
</code>
| <code css>--item-divider-background: red;
--item-divider-color: yellow;
</code>
|}
===Empty divider background===
{| class="wikitable" border="1"
|-
| New selector.
| <code css>--spacer-background: red;</code>
|}
==Buttons==
To change button colors, see Purpose buttons section. Also you can set some properties checking like:

<code css>
ion-button {
--background: red;
}</code>

[https://ionicframework.com/docs/api/button#css-custom-properties Check Ionic documentation for more information.]

Use [https://ionicframework.com/docs/api/fab-button ion-fab-button] to change Floating action buttons.

==Progress bar==
You can now easily style the progress bars.

<code css>
--core-progressbar-height: 8px;
--core-progressbar-color: red;
--core-progressbar-text-color: black;
--core-progressbar-background: white;
</code>
==More page==
===Icons===
The icons in the more page can now easily change the color:
{| class="wikitable" border="1"
|-
| <code css>page-core-mainmenu-more ion-icon {
color: red;
}
</code>
| <code css>--core-more-icon: red;</code>
|}

To change a color on a particular icon you’ll have to use the class of each handler, for example, to change the color of the folder icon on the menu item named Files:
{| class="wikitable" border="1"
|-
| <code css>page-core-mainmenu-more .ion-md-folder,
page-core-mainmenu-more .ion-ios-folder {
color: red;
}
</code>
| <code css>.addon-privatefiles-handler ion-icon {
color: red;
}
</code>
|}
===Item border color===
{| class="wikitable" border="1"
|-
| <code css>page-core-mainmenu-more .item-block.item-ios .item-inner,
page-core-mainmenu-more .item-block.item-md .item-inner {
border-bottom-color: red;
}
</code>
| <code css>--core-more-item-border: red;</code>
|}

The dividers background color can be overridden using '''--spacer-background: red;'''
==Login page==
You can personalize some colors in the login page: (only credentials page, after selecting the site).

<code css>
--core-login-background: red;
--core-login-text-color: blue;
--core-login-input-background: green;
--core-login-input-color: yellow;</code>

==Calendar page ==
Calendar page can be personalized.

<code css>
--addon-calendar-event-category-color: purple;
--addon-calendar-event-course-color: red;
--addon-calendar-event-group-color: yellow;
--addon-calendar-event-user-color: blue};
--addon-calendar-event-site-color: green;
--addon-calendar-today-border-color: orange;
--addon-calendar-border-color: gray;</code>

==Messages page==

Message discussion page (including: chat activity and comments)

<code css>
--addon-messages-message-bg: white;
--addon-messages-message-activated-bg: gray-light;
--addon-messages-message-note-text: gray-dark;
--addon-messages-message-mine-bg: gray-light;
--addon-messages-message-mine-activated-bg: gray;
--addon-messages-discussion-badge: orange;
--addon-messages-discussion-badge-text: white;</code>

Some modifications on the input field:

<code css>
--core-send-message-input-background: gray-light;
--core-send-message-input-color: black;</code>

Moodle App

2021-06-21T12:23:13Z

Jleyva:

{{Moodle Mobile}}

'''IMPORTANT'''

This documentation is valid only for Moodle Mobile 3.5 onwards (the version of the app using the Ionic 3 framework).

We are still working on this documentation:

If you want to support your plugin in the Mobile app, please read [[Mobile support for plugins]]

'''IONIC5 UPGRADE'''

* If you have developed a plugin that is supported for the mobile app please read: [[Adapt your Mobile plugins to Ionic 5]]
* If you have a Premium app subscription and your own Moodle App theme please read: [[Ionic5 style migration guide]]

== See also ==

* Documentation for [[Moodle Mobile 2 (Ionic 1)]] (Obsolete, only for Moodle Mobile < 3.5)

Moodle App FAQ

2021-05-31T15:06:25Z

Jleyva:

{{Moodle Mobile}}

== How can I contribute to Moodle Mobile? ==

You can help with any issue marked with the tag contribfriendly: https://tracker.moodle.org/issues/?jql=project%20%3D%20MOBILE%20AND%20status%20%3D%20Open%20AND%20labels%20%3D%20contribfriendly

If you want to help with another issue, please let us know first via the tracker (a comment in the issue itself).

You have a detailed description of our development process here: [[Moodle App Development Process]]

== Everything seems to be correctly configured but I see this error: Cannot connect: Verify that your have typed correctly the URL and that your site uses Moodle 2.4 or later ==

* Ensure that debugging is disabled in your site: Administration > Development > Debugging
* Check that the ADOdb option is disabled if you are using the external database auth or enrolment plugin. (In Plugins > Authentication > External database and in Plugins > Enrolment > External database).
* If your site uses an SSL certificate, it must be a trusted certificate, not self-signed. Please use this tool or a similar one to check that your certificate is fine: [https://www.geocerts.com/ssl_checker SSL Checker]. All the checks must be ok, including the "Certificate Chain Complete". Otherwise the app might work on iOS but not on Android.

== The app starts but it says it cannot connect to any site I try ==

This is because you need to use a different browser with special flags enabled so cross domains XHR requests are allowed.

In sort, you need to download Chromium from https://download-chromium.appspot.com/ and open it with this command:

chromium --allow-file-access-from-files --disable-web-security

For additional information please, read: [[Moodle Mobile development using Chrome or Chromium]]

== I get a blank page in Chrome/Chromium when launching the app in Windows ==

* Ensure that you have downloaded the latest master version from github (git checkout master; git pull master; git checkout mybranch; git rebase master)
* Ensure that gulp-slash is installed: npm install gulp-slash
* Run gulp again

== Some features like IMSCP, resource mini sites, local notifications are not working in the browser ==

Some features must be tested directly in a mobile device via ionic run android or ionic run ios.

It will require you to install the platform specific SDK or development tools, follow your platform guide here: http://cordova.apache.org/docs/en/edge/guide_platforms_index.md.html#Platform%20Guides

== What is the difference between a native app and a Mobile specific theme or responsive theme? ==

See http://moodle.org/mod/forum/discuss.php?d=206736#p901475

Also http://moodle.org/mod/forum/discuss.php?d=206736#p901751

Moodle App Development Process

2021-05-31T15:04:45Z

Jleyva: Created page with "{{Moodle Mobile}} The development of new features and improvements in the Moodle App is organised in the following six phases: Discovery - Shaping - Implementation - QA Tes..."

{{Moodle Mobile}}

The development of new features and improvements in the Moodle App is organised in the following six phases:

Discovery - Shaping - Implementation - QA Testing - Release - Evaluation

As a summary of the process we can say that during the discovery phase we do an initial selection of features and improvements to be included in the next release of the app by reviewing the feedback from different stakeholders and the improvements detected by Moodle’s UX team user research.

In the shaping phase we do an initial high-level design and specifications so we can commence with the implementation phase in which the developers, with the help of our designers, will implement the selected features.

During the Testing & QA phase, we do intensive testing to check that there are not regressions and, sometimes, we publish Beta versions so our community can check in advance the upcoming new features and provide feedback before the release so we can make the necessary adjustments.

Once we are confident we have a stable new version that is aligned with our stakeholders’ expectations we move to the Release phase in which the new version of the app is fully rolled-out to our users.

During the evaluation phase we analyse our stakeholders feedback to validate if we met their expectations.

== Discovery ==

During this first phase we analyse our different stakeholders’ needs and then we prioritise them so we can build a short-term roadmap for upcoming app releases.

We have different stakeholders (order does not indicate importance):

* End users
* External compliance entities/organisations
* Moodle Partners and Resellers
* BMA clients
* Pro/Premium plans clients
* Moodle Community
* Other Moodle Product teams

=== Prioritisation ===
We use the MoSCoW method. The term MoSCoW itself is an acronym derived from the first letter of each of four prioritisation categories: M - Must have S - Should have C - Could have W - Won't have.

There is some existing criteria for what’s mandatory (MUST) to include in a new release:
* New Moodle LMS functionality (affecting students)
* New Moodle Workplace functionality (affecting students)
* User-facing serious UX problems (app speed/performance, notifications, navigation and resume activity/courses)
* Compliance (GDPR, accessibility)
* Technology (mandatory libraries updates etc…)
* Critical bugs
* Security issues

For what’s not mandatory, we use additional methods such as “Value versus Complexity” but there is always a subjective evaluation and the Moodle Apps Product Manager is the one making the final decisions.

New features and improvements under the “Could have” category can be removed at any time during the implementation phase if we feel we won’t be able to implement them.

Only critical issues (bugs or MUST not properly detected such as LMS changes) can be added once the implementation phase has commenced but minor nice-to-have improvements will often be added throughout the release cycle.

=== Schedule ===
We usually release between four to six versions of the Moodle app per year.

Usually a few weeks after a Moodle LMS major release and also between two major LMS releases.

== Shaping ==

During this phase there are two major things happening:
#A high-level design solution is drafted
#Technical specifications are created

So basically, we are defining what the feature should be doing, how it will work and how it interacts with other systems and the rest of the app. The evaluation criteria (used to check if we solved the problem once is used by end users) is also defined in this phase.

During this phase a developer and a designer will work together so the designer is aware of the technical limitations and the developer has a clear understanding of the high-level proposed solution to be refined during the implementation phase.

== Implementation ==

During this phase the developer and the designer will work on building the solution outlined in the Shaping phase, making decisions and choosing trade-offs about the finer details. Both the designer and the developer have full responsibility and they work autonomously unless they need specific help from other developers with more experience in certain areas.

Before the code gets integrated and it is ready for testing, a colleague has to perform the so-called peer-review, that is basically another developer (not involved in the original implementation) taking a fresh look at the code.

Once the code implementing the features is integrated, a tester will ensure that it works as expected. Automatic tests should be added by the developer in new features, so this step is mostly to look for regressions and to check that all the possible use cases for the solution were considered at implementation time.

== QA testing ==

Once all the selected new features, improvements and bugs fixes have been implemented and tested, we perform a complete review of the Moodle app functionality in order to detect possible regressions.

This is manually done, we go through a list of features of the Moodle app and we check that everything is working as expected in both Android and iOS devices.

At the beginning of this process, we also invite our community members to do some beta testing of the upcoming new features of improvements, to do this, we use Apple TestFlight and Android Beta Testing. Our community members are able to provide feedback prior to the release that will help to detect potential issues.

== Release ==

Once the QA testing phase has finished, we move on into the Release phase which consists basically in doing a full-rollout of the new version of the app in Google Play and the Apple App Store.

== Evaluation ==

In this phase we basically collect feedback to see if the new features and improvements are well received by our final users. As well as using the evaluation criteria we defined in the Shaping phase.
If something is not working as expected because it has bugs or the selected design solution is not working for most of our users we will action in the next development cycle to address the problem.

[[Category: Mobile]]

Debugging network requests in the Moodle App

2021-05-05T13:02:30Z

Jleyva: /* See also */

{{Moodle Mobile}}== Introduction ==

This guide will help you find and report problems with the Moodle Mobile app on your site.

It is especially useful for the following problems:
* Unable to log in on your site
* When you receive one of the following error messages in the app:
** Can not find data record in database table external_functions
** Invalid response value detected
** Cannot get course contents

== Requirements ==
* Moodle 3.1 onwards (your site needs at least this version)
* Moodle Desktop app 3.6.1 onwards or Google Chrome/Chromium browser
[[{{ns:file}}:moodlemobile_enabledebug.png|thumb|300px]]

== Enabling debugging on your Moodle site ==

# Go to Debugging in the Site administration
# For "Debug messages" select 'DEVELOPER'
# Tick "Display debug messages"
# Click the 'Save changes' button.

Note: Remember to disable debugging again once you have finished debugging your problem.

== Enabling debugging on the mobile app ==

# Go to the More tab
# Go to Settings > General
# Enable "Display debug messages"

Note: Remember to disable debugging again once you have finished debugging your problem.

== First try ==

At this point, you may not need fo go further on this guide.

Log-out and log-in again into your site and try to reproduce the error, hopefully, with Moodle and app debugging enabled you will see an explanatory message of what is happening.

If you are unable to find a solution, contact a [https://moodle.com/partners/ Moodle Partner] or post in the [https://moodle.org/mod/forum/view.php?id=7798 Moodle for mobile forum] on moodle.org for non-guaranteed community support.

== Setting up the debugging tool ==

=== Moodle Desktop ===

The recommended way to debug the problem is using the Moodle Desktop app. Please notice that the app version should be 3.6.1 or higher. The desktop app lets you debug some features, such as Single Sign-On, that require a built app to work, rather than a hosted or local ionic build running in a web browser.

You can download the desktop app [https://download.moodle.org/desktop/ from here].

Download the desktop app, install it and open it. Once it's open, you can open the "Developer tools" with the following shortcut:

* In MacOS: Cmd + Option + I
* In Windows or Linux: Ctrl + Shift + I

Once the Developer Tools are open, follow these steps:

# Dock the new panels on the right side (in the new panel top-right options choose “Dock to the right” icon)
# Click the Network tab (at the top-center)
# Enable the filter (filter shape icon) so it changes to colour red
# In the new text field displayed when enabling the filter write <code>.php</code>

Now you are ready to debug all the web services requests sent to your Moodle site by the mobile app.

=== Chrome or Chromium ===

[[{{ns:file}}:moodlemobile_chrome_inspect_network.png|thumb|300px]]

Another option is to use Google Chrome or Google Chromium to debug this. If you already have the Moodle Desktop app you can skip this section.

Debugging the mobile app is not so easy, so we have provided an online web version of the app that can be easily debugged using the Chrome browser.

# Open your Chrome browser and go to https://mobileapp.moodledemo.net/
# Open your browser options (icon at the top-right of your browser window), then go to More tools -> Developer tools
# Dock the new panels on the right side (in the new panel top-right options choose “Dock to the right” icon)
# Click the Network tab (at the top-center)
# Enable the filter (filter shape icon) so it changes to colour red
# In the new text field displayed when enabling the filter write <code>.php</code>

Now you are ready to debug all the web services requests sent to your Moodle site by the mobile app.

== Debugging a web service (WS) error ==

[[{{ns:file}}:moodlemobile_chrome_debug_ws_error.png|thumb|300px]]

# Connect to your site and browse to the functionality displaying an error
# In the right panel you will see a list of requests made by the app to your Moodle site (token.php server.php server.php etc..)
# Click on each one of them (starting with the last one in the list) but skip those that don’t start with token.php or server.php
# In the new sub-window open select the “Response” tab and check if you see an error
# Copy the error then go to the [[:en:Moodle Mobile FAQ|Moodle Mobile FAQ]] in the user docs to check if there is a known solution for it
# If you are unable to find a solution, contact a [https://moodle.com/partners/ Moodle Partner] or post in the [https://moodle.org/mod/forum/view.php?id=7798 Moodle for mobile forum] on moodle.org for non-guaranteed community support.

== Troubleshooting ==

'''How to log-in into a site configured to use browser or embedded authentication'''

You can execute the following in the js console:

window.handleOpenURL("moodlemobile://URL?token=WSTOKEN");

You can also launch a normal authentication process (allowing the authentication popup) and capture in the Network tab the redirect to moodlemobile://... created by the admin/tool/mobile/launch.php script and then execute in the console:

window.handleOpenURL("moodlemobile://token=ABCxNGUxMD........=");

== See also ==

* [[Moodle Mobile development using Chrome or Chromium]]

Moodle Mobile 3.9.3 release notes

2021-03-08T13:18:40Z

Jleyva: /* New features and improvements */

[[Moodle Mobile release notes]] > {{FULLPAGENAME}}

Release date: 30 November 2020

== New features and improvements ==

* Students can submit quizzes with essay question types including attachments (Requires Moodle 3.10)
* New Course Completion notifications (Requires Moodle 3.10)
* New option to log out from the Moodle App through the web (Requires Moodle 3.10)
* Audio-recording supported in more devices
* Activity improvements:
** Choice: New show available spaces setting (Requires Moodle 3.10)
** Lesson: Option to allow unlimited number of attempts for each question (Requires Moodle 3.10)

==Complete list of issues==

=== Bug ===
* MOBILE-3200 - Database: students can add entries in a group that doesn't belong to them (visible groups)
* MOBILE-3265 - Can't change H5P strings language after the package has been downloaded
* MOBILE-3430 - Messaging - Repeat message sent if internet connection drops during sending
* MOBILE-3464 - Hiding core-tabs on scroll makes scroll a bit clunky and can cause some issues
* MOBILE-3465 - Adding window.open in a click event makes clicks override the app
* MOBILE-3468 - No error is displayed if you scan another URL scheme in credentials
* MOBILE-3469 - Single Activity course: if there are (sticky) blocks, the tablet view only shows the description (Forum at least)
* MOBILE-3471 - Find a way to have webview plugin only in iOS
* MOBILE-3477 - iOS app stays loading forever if a site has a lot of calendar events
* MOBILE-3487 - Invalidate only unknown files isn't working as expected
* MOBILE-3488 - Open local HTML file in Android: images aren't seen
* MOBILE-3489 - Android: App cannot access geolocation if Location is disabled in the device
* MOBILE-3503 - Scrolling/swipping from the bottom of a course page to top make top tabs to "shake"
* MOBILE-3508 - External linked files (google drive repository) do not work in mobile app
* MOBILE-3509 - Mobile app goes to blank notification page when clicking forum digest notification
* MOBILE-3511 - ionViewDidLeave not called in split view right pane
* MOBILE-3515 - Error: Avoid hardcoding the debug mode
* MOBILE-3519 - Forum: When following a link in app to a discussion, file attachments don't work
* MOBILE-3526 - Custom CFBundleShortVersionString can't be set
* MOBILE-3530 - Offload course files - error: "Cannot read property 'getFiles' of undefined
* MOBILE-3532 - iOS: top bar has disappeared
* MOBILE-3533 - Disabled messaging - Hide "messages" section within preferences
* MOBILE-3534 - Update macOS signing script
* MOBILE-3539 - Course overview displays In Progress courses if all filters are disabled
* MOBILE-3556 - Mobile app site check causes unnecessary errors in server log
* MOBILE-3557 - Display "Not available" in hidden sections which name is displayed to users
* MOBILE-3562 - Course image is displayed twice (second time as part of the course attachments) in the pre-self enrol view
* MOBILE-3571 - Filters: core_filters_get_available_in_context call can exceed PHP input variables limit
* MOBILE-3578 - Multiple duplicate requests to tool_lp_data_for_user_competency_summary_in_course in the user profile
* MOBILE-3583 - Fix multichoice questions for 3.10
* MOBILE-3589 - Lesson: support unlimited max attempts
* MOBILE-3590 - Don't display H5P Embed button in the app
* MOBILE-3598 - H5P packages disappear after opening a new page with a package

=== New Feature ===
* MOBILE-3432 - Implement file type exclusion list for mobile
* MOBILE-3454 - Support disabling check available text filters in the app
* MOBILE-3501 - Create task to push a branch and automatically update tracker issue
* MOBILE-3540 - Let links specify if they should be opened in InAppBrowser

=== Task ===
* MOBILE-3425 - Update required Node version to 11+

=== Improvement ===
* MOBILE-2272 - Quiz Essay Question Uploading in the mobile app
* MOBILE-3188 - Cached web service responses for activity should show in manage storage
* MOBILE-3338 - Apply component and componentId to WS calls
* MOBILE-3421 - iPad: subtitles in video if too long are not seen on the screen
* MOBILE-3435 - Handle required custom fields in signup
* MOBILE-3445 - Let plugins disable PTR
* MOBILE-3449 - Sync assingment submission when PTR from submission review page
* MOBILE-3450 - Improve synchronizing a logged out site
* MOBILE-3451 - Display more data about devices in the app
* MOBILE-3453 - Don't unpack more than one H5P package at the same time
* MOBILE-3472 - Indicate restriction access after the section when 'All sections' is selected
* MOBILE-3480 - Support images and links using svg + image/a in the app
* MOBILE-3490 - Media capture should fallback to Media (self-recorded audios) if there is not an external audio recording app configured
* MOBILE-3492 - Don't collapse content in large screens
* MOBILE-3493 - Don't display section selector if there are no sections
* MOBILE-3499 - Unlock plugins and libraries after 3.9.2 release
* MOBILE-3505 - App freezes when SSO via inappbrowser is launched in an active site where the token expired
* MOBILE-3507 - Improve Push notification handling for supporting custom notifications
* MOBILE-3510 - Revise encoding H5P message (' is being shown instead of ')
* MOBILE-3512 - Desktop: Revise 'Course overview'(more columns)
* MOBILE-3514 - Support the "Show available spaces" choice setting in the app
* MOBILE-3516 - Use fork of InAppBrowser if they don't release a new version before 3.9.3 release
* MOBILE-3543 - Update electron version
* MOBILE-3546 - Make sitelisting fields configurable
* MOBILE-3548 - Make site url input placeholder easy to change using language strings
* MOBILE-3549 - Allow any HTML tag in plugins templates
* MOBILE-3553 - Remove version from H5P jquery file
* MOBILE-3554 - Add a setting to force login_logo.png usage
* MOBILE-3558 - Day view: the add event icon "+" should scroll
* MOBILE-3569 - Allow IFRAME to use XHTML document in Resource add-on
* MOBILE-3572 - Default the app color scheme to light
* MOBILE-3587 - Support autocomplete for connect/reconnect screens
* MOBILE-3596 - Send the block ID to tool_mobile_get_content

[[Category:Mobile]]
[[Category:Release notes]]

Moodle Mobile Roadmap

2021-02-25T15:42:50Z

Jleyva: Redirected page to Roadmap

#REDIRECT [[Roadmap]]

Moodle App Release Notes

2020-12-30T17:31:58Z

Jleyva:

== Moodle App ==

{| class="nicetable"
|-
! Version name
! Date
! Version code
!
|-
! Moodle Mobile 3.9.4
| 28 December 2020
| 39400
| [[Moodle Mobile 3.9.4 release notes|Release Notes]]
|-
! Moodle Mobile 3.9.3
| 30 November 2020
| 39300
| [[Moodle Mobile 3.9.3 release notes|Release Notes]]
|-
! Moodle Mobile 3.9.2
| 16 July 2020
| 39200
| [[Moodle Mobile 3.9.2 release notes|Release Notes]]
|-
! Moodle Mobile 3.9.1
| 3 July 2020
| 39100
| [[Moodle Mobile 3.9.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.9.0
| 26 June 2020
| 39000
| [[Moodle Mobile 3.9.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.8.2
| 2 April 2020
| 38200
| [[Moodle Mobile 3.8.2 release notes|Release Notes]]
|-
! Moodle Mobile 3.8.1
| 25 March 2020
| 38100
| [[Moodle Mobile 3.8.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.8.0
| 20 December 2019
| 38000
| [[Moodle Mobile 3.8.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.7.2
| 20 September 2019
| 37200
| [[Moodle Mobile 3.7.2 release notes|Release Notes]]
|-
! Moodle Mobile 3.7.1
| 30 August 2019
| 37100
| [[Moodle Mobile 3.7.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.7.0
| 7 June 2019
| 37000
| [[Moodle Mobile 3.7.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.6.1
| 29 March 2019
| 36100
| [[Moodle Mobile 3.6.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.6.0
| 11 January 2019
| 36000
| [[Moodle Mobile 3.6.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.5.2
| 10 September 2018
| 35200
| [[Moodle Mobile 3.5.2 release notes|Release Notes]]
|-
! Moodle Mobile 3.5.1
| 6 July 2018
| 35100
| [[Moodle Mobile 3.5.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.5.0
| 25 June 2018
| 35000
| [[Moodle Mobile 3.5.0 release notes|Release Notes]]
|}

== Moodle Mobile ==

Versions with support or 3.0 and previous versions, based on Ionic 1.

{| class="nicetable"
|-
! Version name
! Date
! Version code
!
|-
! Moodle Mobile 3.4.2
| 19 March 2018
| 20230
| [[Moodle Mobile 3.4.2 release notes|Release Notes]]
|-
! Moodle Mobile 3.4.1
| 28 February 2018
| 20220
| [[Moodle Mobile 3.4.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.4.0
| 30 November 2017
| 20210
| [[Moodle Mobile 3.4.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.3.2
| 29 September 2017
| 20200
| [[Moodle Mobile 3.3.2 release notes|Release Notes]]
|-
! Moodle Mobile 3.3.1
| 28 July 2017
| 20190
| [[Moodle Mobile 3.3.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.3.0
| 26 May 2017
| 20180
| [[Moodle Mobile 3.3.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.2.1
| 28 February 2017
| 20170
| [[Moodle Mobile 3.2.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.2.0
| 12 December 2016
| 20160
| [[Moodle Mobile 3.2.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.1.3
| 19 October 2016
| 20150
| [[Moodle Mobile 3.1.3 release notes|Release Notes]]
|-
! Moodle Mobile 3.1.2
| 27 July 2016
| 2014
| [[Moodle Mobile 3.1.2 release notes|Release Notes]]
|-
! Moodle Mobile 3.1.1
| 14 June 2016
| 2013
| [[Moodle Mobile 3.1.1 release notes|Release Notes]]
|-
! Moodle Mobile 3.1.0
| 23 May 2016
| 2012
| [[Moodle Mobile 3.1.0 release notes|Release Notes]]
|-
! Moodle Mobile 3.0.0
| 15 April 2016
| 2011
| [[Moodle Mobile 3.0.0 release notes|Release Notes]]
|-
! Moodle Mobile 2.9
| 29 February 2016
| 2010
| [[Moodle Mobile 2.9 release notes|Release Notes]]
|-
! Moodle Mobile 2.8
| 22 January 2016
| 2009
| [[Moodle Mobile 2.8 release notes|Release Notes]]
|-
! Moodle Mobile 2.7
| 29 December 2015
| 2008
| [[Moodle Mobile 2.7 release notes|Release Notes]]
|-
! Moodle Mobile 2.6
| 27 November 2015
| 2007
| [[Moodle Mobile 2.6 release notes|Release Notes]]
|-
! Moodle Mobile 2.5
| 6 November 2015
| 2006
| [[Moodle Mobile 2.5 release notes|Release Notes]]
|-
! Moodle Mobile 2.4
| 21 October 2015
| 2005
| [[Moodle Mobile 2.4 release notes|Release Notes]]
|-
! Moodle Mobile 2.3
| 8 October 2015
| 2004
| [[Moodle Mobile 2.3 release notes|Release Notes]]
|-
! Moodle Mobile 2.2
| 10 September 2015
| 2003
| [[Moodle Mobile 2.2 release notes|Release Notes]]
|-
! Moodle Mobile 2.1
| 28 August 2015
| 2002
| [[Moodle Mobile 2.1 release notes|Release Notes]]
|-
! Moodle Mobile 2.0
| 31 July 2015
| 2000
| [[Moodle Mobile 2.0 release notes|Release Notes]]
|}

== Moodle Mobile 1 ==

See [[Moodle Mobile 1 release notes]]

== See also ==

* [[Moodle Desktop release notes]]
* [[Moodle Mobile Roadmap]]

[[Category: Mobile]]
[[Category:Release notes]]

Moodle Mobile 3.9.4 release notes

2020-12-30T17:31:16Z

Jleyva: Created page with "Moodle Mobile release notes > {{FULLPAGENAME}} Release date: 28 December 2020 == New features and improvements == * Minor improvements and bug fixes ==Complete list of..."

[[Moodle Mobile release notes]] > {{FULLPAGENAME}}

Release date: 28 December 2020

== New features and improvements ==

* Minor improvements and bug fixes

==Complete list of issues==

=== Bug ===
* MOBILE-3616 - Loading modal displayed forever when opening a course with a custom course format

=== Improvement ===
* MOBILE-3607 - Site plugins: CSS should be included in DOM in reliable order

[[Category:Mobile]]
[[Category:Release notes]]

Moodle Mobile 3.9.3 release notes

2020-11-30T19:33:08Z

Jleyva:

[[Moodle Mobile release notes]] > {{FULLPAGENAME}}

Release date: 30 November 2020

== New features and improvements ==

* Students can now submit quizzes with essay question types including attachments
* New Course Completion notifications
* New option to log out from the Moodle App through the web
* Audio-recording now supported in more devices
* Several improvements for activity modules:
** Choice: New show available spaces setting
** Lesson: Allow maximum number of attempts to be unlimited

==Complete list of issues==

=== Bug ===
* MOBILE-3200 - Database: students can add entries in a group that doesn't belong to them (visible groups)
* MOBILE-3265 - Can't change H5P strings language after the package has been downloaded
* MOBILE-3430 - Messaging - Repeat message sent if internet connection drops during sending
* MOBILE-3464 - Hiding core-tabs on scroll makes scroll a bit clunky and can cause some issues
* MOBILE-3465 - Adding window.open in a click event makes clicks override the app
* MOBILE-3468 - No error is displayed if you scan another URL scheme in credentials
* MOBILE-3469 - Single Activity course: if there are (sticky) blocks, the tablet view only shows the description (Forum at least)
* MOBILE-3471 - Find a way to have webview plugin only in iOS
* MOBILE-3477 - iOS app stays loading forever if a site has a lot of calendar events
* MOBILE-3487 - Invalidate only unknown files isn't working as expected
* MOBILE-3488 - Open local HTML file in Android: images aren't seen
* MOBILE-3489 - Android: App cannot access geolocation if Location is disabled in the device
* MOBILE-3503 - Scrolling/swipping from the bottom of a course page to top make top tabs to "shake"
* MOBILE-3508 - External linked files (google drive repository) do not work in mobile app
* MOBILE-3509 - Mobile app goes to blank notification page when clicking forum digest notification
* MOBILE-3511 - ionViewDidLeave not called in split view right pane
* MOBILE-3515 - Error: Avoid hardcoding the debug mode
* MOBILE-3519 - Forum: When following a link in app to a discussion, file attachments don't work
* MOBILE-3526 - Custom CFBundleShortVersionString can't be set
* MOBILE-3530 - Offload course files - error: "Cannot read property 'getFiles' of undefined
* MOBILE-3532 - iOS: top bar has disappeared
* MOBILE-3533 - Disabled messaging - Hide "messages" section within preferences
* MOBILE-3534 - Update macOS signing script
* MOBILE-3539 - Course overview displays In Progress courses if all filters are disabled
* MOBILE-3556 - Mobile app site check causes unnecessary errors in server log
* MOBILE-3557 - Display "Not available" in hidden sections which name is displayed to users
* MOBILE-3562 - Course image is displayed twice (second time as part of the course attachments) in the pre-self enrol view
* MOBILE-3571 - Filters: core_filters_get_available_in_context call can exceed PHP input variables limit
* MOBILE-3578 - Multiple duplicate requests to tool_lp_data_for_user_competency_summary_in_course in the user profile
* MOBILE-3583 - Fix multichoice questions for 3.10
* MOBILE-3589 - Lesson: support unlimited max attempts
* MOBILE-3590 - Don't display H5P Embed button in the app
* MOBILE-3598 - H5P packages disappear after opening a new page with a package

=== New Feature ===
* MOBILE-3432 - Implement file type exclusion list for mobile
* MOBILE-3454 - Support disabling check available text filters in the app
* MOBILE-3501 - Create task to push a branch and automatically update tracker issue
* MOBILE-3540 - Let links specify if they should be opened in InAppBrowser

=== Task ===
* MOBILE-3425 - Update required Node version to 11+

=== Improvement ===
* MOBILE-2272 - Quiz Essay Question Uploading in the mobile app
* MOBILE-3188 - Cached web service responses for activity should show in manage storage
* MOBILE-3338 - Apply component and componentId to WS calls
* MOBILE-3421 - iPad: subtitles in video if too long are not seen on the screen
* MOBILE-3435 - Handle required custom fields in signup
* MOBILE-3445 - Let plugins disable PTR
* MOBILE-3449 - Sync assingment submission when PTR from submission review page
* MOBILE-3450 - Improve synchronizing a logged out site
* MOBILE-3451 - Display more data about devices in the app
* MOBILE-3453 - Don't unpack more than one H5P package at the same time
* MOBILE-3472 - Indicate restriction access after the section when 'All sections' is selected
* MOBILE-3480 - Support images and links using svg + image/a in the app
* MOBILE-3490 - Media capture should fallback to Media (self-recorded audios) if there is not an external audio recording app configured
* MOBILE-3492 - Don't collapse content in large screens
* MOBILE-3493 - Don't display section selector if there are no sections
* MOBILE-3499 - Unlock plugins and libraries after 3.9.2 release
* MOBILE-3505 - App freezes when SSO via inappbrowser is launched in an active site where the token expired
* MOBILE-3507 - Improve Push notification handling for supporting custom notifications
* MOBILE-3510 - Revise encoding H5P message (' is being shown instead of ')
* MOBILE-3512 - Desktop: Revise 'Course overview'(more columns)
* MOBILE-3514 - Support the "Show available spaces" choice setting in the app
* MOBILE-3516 - Use fork of InAppBrowser if they don't release a new version before 3.9.3 release
* MOBILE-3543 - Update electron version
* MOBILE-3546 - Make sitelisting fields configurable
* MOBILE-3548 - Make site url input placeholder easy to change using language strings
* MOBILE-3549 - Allow any HTML tag in plugins templates
* MOBILE-3553 - Remove version from H5P jquery file
* MOBILE-3554 - Add a setting to force login_logo.png usage
* MOBILE-3558 - Day view: the add event icon "+" should scroll
* MOBILE-3569 - Allow IFRAME to use XHTML document in Resource add-on
* MOBILE-3572 - Default the app color scheme to light
* MOBILE-3587 - Support autocomplete for connect/reconnect screens
* MOBILE-3596 - Send the block ID to tool_mobile_get_content

[[Category:Mobile]]
[[Category:Release notes]]

Moodle Mobile 3.8.2 release notes

2020-11-30T15:07:59Z

Jleyva:

[[Moodle Mobile release notes]] > {{FULLPAGENAME}}

Release date: 2 April 2020

== New features and improvements ==

* Usability improvements in the Login page
* Performance improvements

==Complete list of issues==

===Improvements===

* MOBILE-3387 - Prevent duplicate AJAX calls
* MOBILE-3389 - Improve error messages and help in login page

[[Category:Mobile]]
[[Category:Release notes]]

Moodle Mobile 3.9.3 release notes

2020-11-30T15:07:10Z

Jleyva:

Moodle Mobile 3.9.2 release notes

2020-11-30T15:07:00Z

Jleyva:

[[Moodle Mobile release notes]] > {{FULLPAGENAME}}

Release date: 16 July 2020

== New features and improvements ==

* This is an un-scheduled release with several bug fixes and minor improvements.

==Complete list of issues==

=== Bug ===
* MOBILE-3426 - SCORM course displays only on half of screen on mobile devices (phone and tablet)
* MOBILE-3466 - Check calendar current day
* MOBILE-3473 - File/More options doesn't allow uploading files bigger than 10MB
* MOBILE-3475 - Called function "isVersionGreaterEqualThan" of undefined error in the "token expired" credentials screen
* MOBILE-3481 - Fix max width for iframe

=== Improvement ===
* MOBILE-3452 - Workshops (iOS): titles (ionic styles)
* MOBILE-3474 - Remove autofocus from the forgotten password screen and site URL / site finder screen when QR login button is displayed
* MOBILE-3476 - Make demo accounts case-insensitive

[[Category:Mobile]]
[[Category:Release notes]]

Moodle Mobile 3.9.1 release notes

2020-11-30T15:06:43Z

Jleyva:

[[Moodle Mobile release notes]] > {{FULLPAGENAME}}

Release date: 3 July 2020

== New features and improvements ==

* This is an un-scheduled release due to a bug caused by a localisation issue in the Traditional Chinese language pack.

==Complete list of issues==

=== Bug ===
* MOBILE-3461 - iframe-viewer uses a string in hideUntil instead of a boolean
* MOBILE-3462 - Make sure app direction is either ltr or rtl
* MOBILE-3467 - Authenticate using a custom URL scheme not working if site is logged out
* MOBILE-3470 - mod_resource file cannot be opened after PTR in course page

=== Improvement ===
* MOBILE-3458 - Validate URL for custom URLs and QR reader when app has fixed sites
* MOBILE-3459 - Disable QR reader in main menu
* MOBILE-3463 - Add an option to add a new site using URL

[[Category:Mobile]]
[[Category:Release notes]]

Moodle Mobile 3.9.0 release notes

2020-11-30T15:06:28Z

Jleyva:

[[Moodle Mobile release notes]] > {{FULLPAGENAME}}

Release date: 26 June 2020

== New features and improvements ==

* H5P activity - including offline tracking support (requires Moodle 3.9)
* iPad multitasking - having the Moodle app sharing the screen at the same time as other apps (similar to Android split view)
* On-boarding slides for new Moodle app users (Android only)
* Site finder - enabling a user to easily find their Moodle site by entering the name (no need to enter the site URL)
* QR reader - enabling a user to scan QR codes and open external URLs or courses and activities in the app
* Feedback from the app (active app users only)

== Exclusive features for Pro and Premium subscriptions ==
* QR code auto-login - enabling a user to scan a QR code in their Moodle site profile and be automatically logged in in the app without having to enter their credentials (requires Moodle 3.9)
* Site finder customised info - site admins can customise the information about their site which is displayed in site finder search results
Learn more about our Pro and Premium subscriptions [https://moodle.com/app/ here]

==Complete list of issues==

=== New Feature ===
* MOBILE-3305 - Implement removing individual downloaded courses
* MOBILE-3411 - Support H5P activity in the app (without tracking)
* MOBILE-3412 - Support tracking in H5P activities
* MOBILE-3413 - Let users view their attempts in H5P activities
* MOBILE-3414 - Create new onboarding slides for Android only
* MOBILE-3416 - Support multitasking in iPad (aka split view)

=== Improvement ===
* MOBILE-2995 - QR code support in the app
* MOBILE-3101 - Use WKWebView
* MOBILE-3134 - For plugin activities the size context menu item is not updating automatically without a refresh
* MOBILE-3249 - Mobile: Sort courses by short name.
* MOBILE-3270 - Files uploaded from Google Drive (Android) have an incorrect size (4 bytes)
* MOBILE-3309 - Use ionic-cli as a project dependency
* MOBILE-3331 - Accessibility - open in browser & PDF icons causing problems for screenreaders
* MOBILE-3344 - Desktop (Windows): revise file types for file submission using Zip
* MOBILE-3351 - Desktop (Win / Ubuntu): Image preview (magnifying glass) to use all available space
* MOBILE-3370 - Add App Support for block_activity_results
* MOBILE-3375 - Make resource warnings less intrusive
* MOBILE-3380 - Split view placeholder always displays an arrow pointing to the left, even in RTL
* MOBILE-3382 - Show unread messages badge
* MOBILE-3394 - Add event when user activity is sent
* MOBILE-3402 - Improve Login UX
* MOBILE-3406 - Refactor apps' H5P code to make it more similar to H5P's PHP and Moodle structure
* MOBILE-3417 - Allow Blocks plugins to specify a fallback
* MOBILE-3418 - Use WKWebView in InAppBrowser for iOS
* MOBILE-3419 - Make RTE button use , instead of , for accessibility
* MOBILE-3422 - Revise tablet view when keyboard is activated
* MOBILE-3436 - Improve UX when opening a scorm
* MOBILE-3437 - Calculate download size: ignore size of files already downloaded
* MOBILE-3447 - Support disabling InAppBrowser in LTI in the app
* MOBILE-3294 - Behat tests for the Moodle App
* MOBILE-3434 - Update behat tests for the Moodle App

=== Bug ===
* MOBILE-2870 - Feedback Activity - "Answer the Questions" button styling issue
* MOBILE-3015 - Mobile app crash when select subtitle in video player iOS
* MOBILE-3346 - Not possible to see your own workshop submission feedback on the App
* MOBILE-3363 - When the dark theme is on, the pop-up windows and the keyboard remain with a light background
* MOBILE-3368 - Required node version in package.json to avoid confusion
* MOBILE-3377 - Android: RTE buttons don't work when some text is selected
* MOBILE-3384 - Cannot read property 'errorcode' of null if local/mobile/check.php returns null
* MOBILE-3390 - Database URL Field "Forced name for the link" doesn't show in Mobile view
* MOBILE-3398 - mod_data doesn't browse correctly when using ##moreurl##
* MOBILE-3400 - "Last accessed" module list sort is not updated after a course is viewed
* MOBILE-3407 - Drops aren't displayed in drag and drop into image questions in Moodle 3.6
* MOBILE-3420 - Blog images are not loaded properly
* MOBILE-3424 - Fix vulnerability in jQuery 1.9.1
* MOBILE-3438 - Update drag and drop code with changes on MDL-58645
* MOBILE-3443 - Big Modals on landscape like multichoice on database are not closable
* MOBILE-3448 - File name is not unique when uploading

[[Category: Mobile]]
[[Category:Release notes]]

Moodle Mobile 3.9.3 release notes

2020-11-30T15:03:21Z

Jleyva:

Moodle Mobile 3.9.3 release notes

2020-11-30T12:19:03Z

Jleyva: Created page with "Moodle Mobile release notes > {{FULLPAGENAME}} Release date: 30 November 2020 == New features and improvements == ==Complete list of issues=="

[[Moodle Mobile release notes]] > {{FULLPAGENAME}}

Release date: 30 November 2020

== New features and improvements ==

==Complete list of issues==

Peer reviewing

2020-11-19T14:58:07Z

Jleyva: /* The Moodle mobile app */

=Process=

Peer review process helps to prepare the issue for integration. The peer reviewer is another developer who was not involved in the development process on the issue and therefore can take a fresh look and notice something that original developer might have forgotten during development. It is important to check that the bug actually is present and the code fixes it without creating new regressions.

==Completing Peer review as a community member==

Any other developer can review any change. That is why it is called 'peer' review. However, not everyone has the necessary permissions in the tracker to click the buttons 'Start peer review', 'Finish peer review' etc. This should not discourage you from looking at other contributors code and providing comments and feedback. The issue will still need to wait for someone with the right permissions to come along and click the buttons, but they can read your review and then need do no more than double-check some points, which will save a lot of time.

To provide feedback to the developer, leave the issue in "Waiting for Peer Review" (since you don't have permission to do anything else, and also that makes it easy for someone with sufficient permissions to find the issue and move it forwards). Review the code using the checklist below, including any appropriate comments. Once finished, please post a comment clearly stating the outcome of your review. If you think it needs more work then indicate what needs to be changed. If you are happy with the patch, leave a clear comment that you believe this is ready to be made part of Moodle. This can then easily be seen by a HQ developer or component lead and they can quickly take appropriate action.

If a followup review happens to identify something you did not find, you have an opportunity to expand your knowledge and provide better reviews in the future as well as having saved everybody else some time.

Feedback to indicate the issue is ready to progress might look like the following;

Thanks again for your contribution. I have reviewed the patch:
 
[Copy and paste the checklist here, and complete it]
 
I don't have permission to use the peer review buttons on this issue. I hope that someone with sufficient permissions will move the issue forwards soon.


Feedback to indicate the issue requires further work might look like the following;

Thanks for providing a patch. I think the following points require further work
 
[Copy and paste the checklist here, and complete it]
 
Please indicate If you are willing to continue working on this issue and complete the solution.


Can you help with peer reviewing? If so, please see the [https://tracker.moodle.org/issues/?filter=13607 list of issues waiting for peer review].

==Peer review for development by HQ or a known common contributor==

When code comes from a HQ developer or external developer who has been contributing significantly to Moodle and is well acquainted with Moodle standards, peer review is limited to checking the code according to the Checklist below.

If everything is fine, the peer reviewer submits the issue for integration.

If some additional work is needed or the author specifically asked not to submit for integration yet, the peer reviewer clicks on “Finish peer review” and the issue state returns to “Development in progress”. Usually the name of the peer reviewer stays on the issue and if a second peer review is requested it is expected that the same Peer reviewer picks it up. If the peer reviewer is not able to do the second review, they should remove their name and comment about it. Otherwise the issue does not appear on “waiting for peer review” dashboard. Please remember that not all jira users have permission to submit for integration.

==Peer review for external developers==

When the code has come from an external developer, the peer reviewer will also help the developer to lead the issue to integration. In this case the peer reviewer should not use “Finish peer review” button.

If the issue needs additional work, the peer reviewer comments about the suggested changes but does not change the status of the issue and it remains as “Peer review in progress”. If the author of the patch does not reply in 4 days, the peer reviewer may select either to complete the patch themselves or reopen the issue. The decision should be based on the amount of work required to complete the solution, for example, changing coding style or commit message, rebasing, backporting, adding testing instructions, etc. should be performed by the peer reviewer. This may require picking the commits into reviewer’s git branch.

It is very important to give the credit to the author of the code by either keeping their authorship on the commit or adding “Thanks to XXXX for providing the patch” to the commit message. If the author of the patch is not in jira-developers group the special user 'moodle.com' should be entered in Assignee field.

There could be situations when the patch is incomplete, does not fix the original issue, creates regressions or otherwise is not correct. As stated above, the peer reviewer should comment about it and wait for the feedback from the author. If there is no feedback, or the author can not work on this issue any more, and the peer reviewer also does not find it easy and important enough to complete, the issue needs to be reopened. Button “Fail peer review” (available to HQ developers only) will reset the issue status to “Reopened”. On this screen peer reviewer should remove assignee, peer reviewer and “patch” label from the issue. This way issue will become available again for anybody who want to work on it. All communication will remain in comments and issue history.

If the issue has passed peer review but the integrator or tester has raised some questions about it, then normally the developer who created the patch would be expected to respond. If they do no respond quickly enough, then the peer reviewer is expected to step in and take responsibility for the change they reviewed.

Once the issue is ready for integration, you can submit it to integration on behalf of the developer. Most external developers (those who are not in the jira-developers group) do not have permission to submit their own issues to integration so cannot do it themselves.

==Replies templates==


Thanks for providing a patch. 
I have reviewed your code and can confirm that it addresses the reported issue. We would like to include it in core. Moodle values its contributors and tries to give them credit when possible. If you are interested in your name appearing on the https://moodle.org/dev/contributions.php page you can create a git commit that we will then pull into Moodle. You can learn more about Git and how Moodle uses it at <nowiki>[Git for developers|https://docs.moodle.org/dev/Git_for_developers]</nowiki> page. Please let me know if you want to prepare a git branch. Or if you don’t have time to go through the whole process at the moment I can pick your patch myself.



Thanks for providing a patch. 
Your code looks almost ready for integration into Moodle. There are just some little things that need to be changed to comply with Moodle standards. Can you please take a look at the review results below and tell me if you are able to modify your branch to address them.



I have reviewed your patch, it addresses the problem and complies with Moodle standards. I'm pushing this issue for integration. Following Moodle <nowiki>[Process|https://docs.moodle.org/dev/Process]</nowiki> it will go through integration review and testing before being included in the product. There might be additional questions from an integrator and/or a tester at those stages. It would be appreciated if you read tracker emails and can reply to questions if needed. If everything goes well during the next two stages your issue will be included in the next weekly release and your count on https://moodle.org/dev/contributions.php page will increase. 
Thanks again for your contribution.



Thanks for providing a patch. 
Unfortunately this patch does not fully address the reported issue. ... DETAILS... 
Even though the code does solve the issue in the short-term it is very likely to create regressions ..... 
I have spent some time reviewing the patch and I would recommend that you ..... 
Please let me know If you are willing to continue working on this issue and complete the solution.


=Checklist=

These are points to consider while peer-reviewing issues. Further explanation below.

[] Syntax
[] Output
[] Language
[] Databases
[] Testing (instructions and automated tests)
[] Security
[] Privacy (see [[Privacy API]])
[] Performance and Clustering
[] Documentation
[] Git
[] Third party code
[] Sanity check
[] Icons
[] The Moodle mobile app

Acceptable check-marks are Y (for yes), N (for no) or - (for not applicable). All N check-marks should be accompanied by an explanation of the problem that still needs to be addressed.

==Syntax==
To allow the community of Moodle developers to work together, conventions should be followed.

* The code is easy to understand and, where it isn't, comments have been provided.
* Variables are named correctly (all lower case, no camel-case, no underscores).
* Functions are named correctly (all lower case, no camel-case, underscores allowed).
* PHP DocBlocks have been updated and adhere to [[Coding_style#Documentation_and_comments|coding style guide]].
* Where functions are being removed, the [[Deprecation]] process is followed.
* The code doesn't use [[Deprecated_functions_in_2.0|deprecated functions]].
* $_GET, $_POST, $_REQUEST, $_COOKIE, and $_SESSION are never used.

See the [[Coding style]] guide for details.
Most of the previous items list are checked automatically by the CiBot ([[Automated code review]]). So in this case it's recommended to review the execution results to validate that there aren't errors. However, take into account that for now, CiBot is not checking all file types (it happens, for instance, with the Javascript files).

==Output==
Output needs to be controlled by renderers to achieve consistency and correct application of themes.

Ensure that:
* output renders are used to generate output strings, including HTML tags;
* HTML output is valid html5;
* no inline styles have been used in HTML output (everything has to be in CSS);
* CSS has been added to the appropriate CSS files (base, specific area, sometimes canvas); and
* the code doesn't use buffered output unless absolutely necessary.
* all visual output has a RTL alternative included

feedback any notices (E_STRICT, etc) seen into the MDL.

==Language==
To achieve appropriate internationalisation of Moodle, language strings must be managed correctly.

Ensure that:
* new language strings are named correctly (all lower case, no camel-case, underscores are permissible in some cases);
* help strings are named and formatted as described in [[Help strings]];
* language strings are used instead of hard-coded strings for text output;
* language strings have not been removed or renamed, had their meaning changed or had their parameters changed in stable branches (permitted only in master); and
* [https://docs.moodle.org/dev/Commit_cheat_sheet#Include_AMOS_script_in_the_commit_if_needed AMOS commands] have been specified when moving or copying language strings.

==Databases==
DB calls are the greatest performance bottleneck in Moodle.

If there is SQL code you can test quickly then do so.

Ensure that:
* there are minimal DB calls (no excessive use of the DB); and
* the code uses SQL compatible with all the supported DB engines (check all selected fields appear in an 'order by' clause).

==Testing instructions and automated tests==
It is the developer's responsibility to test code before integration. Issues should not be sent for peer review without tests so that the peer reviewer can assess their quality and use them to consider the scope of the issue.

Ensure that:
* there are specific testing instructions that state how, as well as what, to test. Please ensure that the testing instructions:
** [[Testing instructions guide|are in the correct format]];
** are clear; and
** are concise;
** they consider other perspectives of other users perhaps not considered by original developers e.g. Moodle mobile app users
* the assignee has tested according to the instructions and verified that they are passing (This is the responsibility of the assignee, not the peer reviewer)
* new unit tests have been added when there is a change in functionality; and
* '''unit tests pass''' for related areas where changes have been made.
* '''Behat tests pass''' for related areas where changes have been made, especially when it involved UI changes.

==Security==
The user community relies on Moodle being responsibly secure.

Ensure that:
* user login is checked where an identity is needed;
* sesskey values are checked before all write actions where appropriate (some read actions as well);
* capabilities are checked where roles differ; and
* if the issue itself is a [[Security|security]] issue, the [[Process#Security_issues|security process]] is being followed.
** Ensure that the fix is '''not''' available in a public repository (ie. a personal Github account); stand-alone patches should be provided instead.
** The issue will not be integrated until just before the next minor version release.

==Privacy==
The user community relies on Moodle keeping user's privacy.

See more info [[Privacy_API]]

Ensure that:
* No unnecessary personal user data is saved;
* All personal user data is saved in compliance with [https://en.wikipedia.org/wiki/General_Data_Protection_Regulation General Data Protection Regulation] (GDPR) which is an EU directive;
* For all stored data you will need to:
** Describe the type of data that they store;
** Provide a way to export that data; and
** Provide a way to delete that data.

==Performance and clustering==
It is easy to write code that works sufficiently well when you are working on either small sets of data or with a small number of active users. Picking performance issues can be quite difficult and can required a complex level of understanding of both the section of code being reviewed, but also other parts that interact with it.

Clustering is when the same code is run on different computers and an end user could send each request to a different computer. This can produce a number of concurrency issues if not thought through. One example is; If you complete an opcache_reset(), no other server except the one you ran it on knows that it happened. So data can get out of sync.

Ensure that:
* Any filesystem, database or cache accesses are done in the most efficient way.
* That any code or function that appear expensive are not in critical paths. eg; They don't load on every page.
* The least possible code is running to complete the task, especially looking for hidden loops. They can appear from calling functions.
* Any code that runs is not specific to a single node. (eg opcache_reset()) This ensures clusters will run correctly.
* If the code could affect performance at all, make sure there is a comment noting what was considered.
** What they did to mitigate performance impact, or why they thought it wasn't an issue.
** Why they made certain trade-offs.

==Documentation==
Work does not stop when code is integrated.

Ensure that:
* The PHPdoc comments on all classes, methods and fields are useful. (Comments that just repeat the function name are not helpful! Add value.)
* Where an API has been changed significantly, the relevant upgrade.txt file has been updated with information.
* Where something has been deprecated, that the comments don't just say "do NOT use this any more!!!" but acutally say what should be done instead.
* Appropriate [[Tracker_issue_labels|labels]] have been added when there has been a function change, particularly
** docs_required (any functional change, usually paired with ui_change),
** dev_docs_required (any change to APIs, usually paired with api_change),
** ui_change (any functional change, usually paired with docs_required, except ui_change remains permanetly),
** api_change (any change to APIs that devs will need to know about, usually paired with dev_docs_required, except api_change remains permanetly),
** unit_test_required and acceptance_test_required, when there are api or ui changes needing improved coverage, and
** qa_test_required (significant functional change, not covered by unit/acceptance ones).
* Also, verify that the components for the issue are correctly set, so maintainers (subscribed by default) will be mailed about issues early in the process.

==Git==
Ensure that:
* the commit matches the [[Coding style#Git_commits|Coding style]]
* the Git history is clean and the work has been rebased to logical commits; and
* the original author of the work provided as a patch has been given credit within the commit (as author of in the commit message if changes were made).

==Third party code==
Does the change contain [[Plugin with third party libraries|third party code]]? If so, ensure that:

* The code is licensed under a [http://www.gnu.org/licenses/license-list.html#GPLCompatibleLicenses| GPL compatible license].
* The instructions for upgrading/importing the library and contained within a readme_moodle.txt file.
* The library is recorded in a thirdparty.xml file, including licensing information.
* Third party code has been scanned to check for url accessible entry points that could be exploited. These should either be disabled, or if required functionality they should be checked for security weaknesses.
* Does not duplicate the functionality of any existing api or third party library in core.
* Any modifications to third party code are recorded in readme_moodle.txt

==Sanity check==
Ensure that:
* the code seems to solve the described problem completely within its reported scope (and further issues have been created to resolve remaining parts or further refactoring);
* the code makes sense in relation to the broader codebase (look at the whole function, not just the altered code); and
* the developer has searched for and fixed other areas that may also have been affected by the same problem.
* verify that the related component maintainers, if known, have participated and are aware of the issue (as assignee, or existing comments...). If they have not, please perform a friendly <tt>@mention</tt> to make them aware about the issue. A list of component leads is available here: https://docs.moodle.org/dev/Component_Leads
* if any version numbers have been changed in [[version.php]] files, then the changes follow [[Moodle_versions#How_to_increment_version_numbers_in_core|the rule for updating version numbers in core]].
* there are comments on tracker explaining why current approach was taken and why other options (especially large issues). If not comment asking them to explain

==Icons==
Are new icons being introduced? If so, ensure that:
* the icons abide by our [https://docs.moodle.org/dev/Moodle_icons icon guidelines] with regards to size, design and format
* the icons are do not unnecessarily add new ways of expressing existing concepts
* the icons are in a pix folder that makes sense

==The Moodle mobile app==
The Moodle app supports most of the student-related Moodle functionality. It is important to think about how a change in that type of functionality might affect it.

Ensure that:
* The issue is labelled with affects_mobileapp when the developer suspects that the changes can affect the app.
* New module settings are returned via the existing Web Services in the module
* When the code includes a new Web Service that will be necessary for the Moodle app, the new Web Service is included in the mobile service
* New global settings that affect new features for the app are included in the WebServices returning global settings (tool_mobile_get_config)
* The testing instructions include testing steps for the Moodle App

==See Also==
* [http://moodle.org/plugins/view.php?plugin=local_codechecker Code checker plugin]

[[Category: Processes]]

Peer reviewing

2020-11-19T14:55:02Z

Jleyva: /* Checklist */

=Process=

Peer review process helps to prepare the issue for integration. The peer reviewer is another developer who was not involved in the development process on the issue and therefore can take a fresh look and notice something that original developer might have forgotten during development. It is important to check that the bug actually is present and the code fixes it without creating new regressions.

==Completing Peer review as a community member==

Any other developer can review any change. That is why it is called 'peer' review. However, not everyone has the necessary permissions in the tracker to click the buttons 'Start peer review', 'Finish peer review' etc. This should not discourage you from looking at other contributors code and providing comments and feedback. The issue will still need to wait for someone with the right permissions to come along and click the buttons, but they can read your review and then need do no more than double-check some points, which will save a lot of time.

To provide feedback to the developer, leave the issue in "Waiting for Peer Review" (since you don't have permission to do anything else, and also that makes it easy for someone with sufficient permissions to find the issue and move it forwards). Review the code using the checklist below, including any appropriate comments. Once finished, please post a comment clearly stating the outcome of your review. If you think it needs more work then indicate what needs to be changed. If you are happy with the patch, leave a clear comment that you believe this is ready to be made part of Moodle. This can then easily be seen by a HQ developer or component lead and they can quickly take appropriate action.

If a followup review happens to identify something you did not find, you have an opportunity to expand your knowledge and provide better reviews in the future as well as having saved everybody else some time.

Feedback to indicate the issue is ready to progress might look like the following;

Thanks again for your contribution. I have reviewed the patch:
 
[Copy and paste the checklist here, and complete it]
 
I don't have permission to use the peer review buttons on this issue. I hope that someone with sufficient permissions will move the issue forwards soon.


Feedback to indicate the issue requires further work might look like the following;

Thanks for providing a patch. I think the following points require further work
 
[Copy and paste the checklist here, and complete it]
 
Please indicate If you are willing to continue working on this issue and complete the solution.


Can you help with peer reviewing? If so, please see the [https://tracker.moodle.org/issues/?filter=13607 list of issues waiting for peer review].

==Peer review for development by HQ or a known common contributor==

When code comes from a HQ developer or external developer who has been contributing significantly to Moodle and is well acquainted with Moodle standards, peer review is limited to checking the code according to the Checklist below.

If everything is fine, the peer reviewer submits the issue for integration.

If some additional work is needed or the author specifically asked not to submit for integration yet, the peer reviewer clicks on “Finish peer review” and the issue state returns to “Development in progress”. Usually the name of the peer reviewer stays on the issue and if a second peer review is requested it is expected that the same Peer reviewer picks it up. If the peer reviewer is not able to do the second review, they should remove their name and comment about it. Otherwise the issue does not appear on “waiting for peer review” dashboard. Please remember that not all jira users have permission to submit for integration.

==Peer review for external developers==

When the code has come from an external developer, the peer reviewer will also help the developer to lead the issue to integration. In this case the peer reviewer should not use “Finish peer review” button.

If the issue needs additional work, the peer reviewer comments about the suggested changes but does not change the status of the issue and it remains as “Peer review in progress”. If the author of the patch does not reply in 4 days, the peer reviewer may select either to complete the patch themselves or reopen the issue. The decision should be based on the amount of work required to complete the solution, for example, changing coding style or commit message, rebasing, backporting, adding testing instructions, etc. should be performed by the peer reviewer. This may require picking the commits into reviewer’s git branch.

It is very important to give the credit to the author of the code by either keeping their authorship on the commit or adding “Thanks to XXXX for providing the patch” to the commit message. If the author of the patch is not in jira-developers group the special user 'moodle.com' should be entered in Assignee field.

There could be situations when the patch is incomplete, does not fix the original issue, creates regressions or otherwise is not correct. As stated above, the peer reviewer should comment about it and wait for the feedback from the author. If there is no feedback, or the author can not work on this issue any more, and the peer reviewer also does not find it easy and important enough to complete, the issue needs to be reopened. Button “Fail peer review” (available to HQ developers only) will reset the issue status to “Reopened”. On this screen peer reviewer should remove assignee, peer reviewer and “patch” label from the issue. This way issue will become available again for anybody who want to work on it. All communication will remain in comments and issue history.

If the issue has passed peer review but the integrator or tester has raised some questions about it, then normally the developer who created the patch would be expected to respond. If they do no respond quickly enough, then the peer reviewer is expected to step in and take responsibility for the change they reviewed.

Once the issue is ready for integration, you can submit it to integration on behalf of the developer. Most external developers (those who are not in the jira-developers group) do not have permission to submit their own issues to integration so cannot do it themselves.

==Replies templates==


Thanks for providing a patch. 
I have reviewed your code and can confirm that it addresses the reported issue. We would like to include it in core. Moodle values its contributors and tries to give them credit when possible. If you are interested in your name appearing on the https://moodle.org/dev/contributions.php page you can create a git commit that we will then pull into Moodle. You can learn more about Git and how Moodle uses it at <nowiki>[Git for developers|https://docs.moodle.org/dev/Git_for_developers]</nowiki> page. Please let me know if you want to prepare a git branch. Or if you don’t have time to go through the whole process at the moment I can pick your patch myself.



Thanks for providing a patch. 
Your code looks almost ready for integration into Moodle. There are just some little things that need to be changed to comply with Moodle standards. Can you please take a look at the review results below and tell me if you are able to modify your branch to address them.



I have reviewed your patch, it addresses the problem and complies with Moodle standards. I'm pushing this issue for integration. Following Moodle <nowiki>[Process|https://docs.moodle.org/dev/Process]</nowiki> it will go through integration review and testing before being included in the product. There might be additional questions from an integrator and/or a tester at those stages. It would be appreciated if you read tracker emails and can reply to questions if needed. If everything goes well during the next two stages your issue will be included in the next weekly release and your count on https://moodle.org/dev/contributions.php page will increase. 
Thanks again for your contribution.



Thanks for providing a patch. 
Unfortunately this patch does not fully address the reported issue. ... DETAILS... 
Even though the code does solve the issue in the short-term it is very likely to create regressions ..... 
I have spent some time reviewing the patch and I would recommend that you ..... 
Please let me know If you are willing to continue working on this issue and complete the solution.


=Checklist=

These are points to consider while peer-reviewing issues. Further explanation below.

[] Syntax
[] Output
[] Language
[] Databases
[] Testing (instructions and automated tests)
[] Security
[] Privacy (see [[Privacy API]])
[] Performance and Clustering
[] Documentation
[] Git
[] Third party code
[] Sanity check
[] Icons
[] The Moodle mobile app

Acceptable check-marks are Y (for yes), N (for no) or - (for not applicable). All N check-marks should be accompanied by an explanation of the problem that still needs to be addressed.

==Syntax==
To allow the community of Moodle developers to work together, conventions should be followed.

* The code is easy to understand and, where it isn't, comments have been provided.
* Variables are named correctly (all lower case, no camel-case, no underscores).
* Functions are named correctly (all lower case, no camel-case, underscores allowed).
* PHP DocBlocks have been updated and adhere to [[Coding_style#Documentation_and_comments|coding style guide]].
* Where functions are being removed, the [[Deprecation]] process is followed.
* The code doesn't use [[Deprecated_functions_in_2.0|deprecated functions]].
* $_GET, $_POST, $_REQUEST, $_COOKIE, and $_SESSION are never used.

See the [[Coding style]] guide for details.
Most of the previous items list are checked automatically by the CiBot ([[Automated code review]]). So in this case it's recommended to review the execution results to validate that there aren't errors. However, take into account that for now, CiBot is not checking all file types (it happens, for instance, with the Javascript files).

==Output==
Output needs to be controlled by renderers to achieve consistency and correct application of themes.

Ensure that:
* output renders are used to generate output strings, including HTML tags;
* HTML output is valid html5;
* no inline styles have been used in HTML output (everything has to be in CSS);
* CSS has been added to the appropriate CSS files (base, specific area, sometimes canvas); and
* the code doesn't use buffered output unless absolutely necessary.
* all visual output has a RTL alternative included

feedback any notices (E_STRICT, etc) seen into the MDL.

==Language==
To achieve appropriate internationalisation of Moodle, language strings must be managed correctly.

Ensure that:
* new language strings are named correctly (all lower case, no camel-case, underscores are permissible in some cases);
* help strings are named and formatted as described in [[Help strings]];
* language strings are used instead of hard-coded strings for text output;
* language strings have not been removed or renamed, had their meaning changed or had their parameters changed in stable branches (permitted only in master); and
* [https://docs.moodle.org/dev/Commit_cheat_sheet#Include_AMOS_script_in_the_commit_if_needed AMOS commands] have been specified when moving or copying language strings.

==Databases==
DB calls are the greatest performance bottleneck in Moodle.

If there is SQL code you can test quickly then do so.

Ensure that:
* there are minimal DB calls (no excessive use of the DB); and
* the code uses SQL compatible with all the supported DB engines (check all selected fields appear in an 'order by' clause).

==Testing instructions and automated tests==
It is the developer's responsibility to test code before integration. Issues should not be sent for peer review without tests so that the peer reviewer can assess their quality and use them to consider the scope of the issue.

Ensure that:
* there are specific testing instructions that state how, as well as what, to test. Please ensure that the testing instructions:
** [[Testing instructions guide|are in the correct format]];
** are clear; and
** are concise;
** they consider other perspectives of other users perhaps not considered by original developers e.g. Moodle mobile app users
* the assignee has tested according to the instructions and verified that they are passing (This is the responsibility of the assignee, not the peer reviewer)
* new unit tests have been added when there is a change in functionality; and
* '''unit tests pass''' for related areas where changes have been made.
* '''Behat tests pass''' for related areas where changes have been made, especially when it involved UI changes.

==Security==
The user community relies on Moodle being responsibly secure.

Ensure that:
* user login is checked where an identity is needed;
* sesskey values are checked before all write actions where appropriate (some read actions as well);
* capabilities are checked where roles differ; and
* if the issue itself is a [[Security|security]] issue, the [[Process#Security_issues|security process]] is being followed.
** Ensure that the fix is '''not''' available in a public repository (ie. a personal Github account); stand-alone patches should be provided instead.
** The issue will not be integrated until just before the next minor version release.

==Privacy==
The user community relies on Moodle keeping user's privacy.

See more info [[Privacy_API]]

Ensure that:
* No unnecessary personal user data is saved;
* All personal user data is saved in compliance with [https://en.wikipedia.org/wiki/General_Data_Protection_Regulation General Data Protection Regulation] (GDPR) which is an EU directive;
* For all stored data you will need to:
** Describe the type of data that they store;
** Provide a way to export that data; and
** Provide a way to delete that data.

==Performance and clustering==
It is easy to write code that works sufficiently well when you are working on either small sets of data or with a small number of active users. Picking performance issues can be quite difficult and can required a complex level of understanding of both the section of code being reviewed, but also other parts that interact with it.

Clustering is when the same code is run on different computers and an end user could send each request to a different computer. This can produce a number of concurrency issues if not thought through. One example is; If you complete an opcache_reset(), no other server except the one you ran it on knows that it happened. So data can get out of sync.

Ensure that:
* Any filesystem, database or cache accesses are done in the most efficient way.
* That any code or function that appear expensive are not in critical paths. eg; They don't load on every page.
* The least possible code is running to complete the task, especially looking for hidden loops. They can appear from calling functions.
* Any code that runs is not specific to a single node. (eg opcache_reset()) This ensures clusters will run correctly.
* If the code could affect performance at all, make sure there is a comment noting what was considered.
** What they did to mitigate performance impact, or why they thought it wasn't an issue.
** Why they made certain trade-offs.

==Documentation==
Work does not stop when code is integrated.

Ensure that:
* The PHPdoc comments on all classes, methods and fields are useful. (Comments that just repeat the function name are not helpful! Add value.)
* Where an API has been changed significantly, the relevant upgrade.txt file has been updated with information.
* Where something has been deprecated, that the comments don't just say "do NOT use this any more!!!" but acutally say what should be done instead.
* Appropriate [[Tracker_issue_labels|labels]] have been added when there has been a function change, particularly
** docs_required (any functional change, usually paired with ui_change),
** dev_docs_required (any change to APIs, usually paired with api_change),
** ui_change (any functional change, usually paired with docs_required, except ui_change remains permanetly),
** api_change (any change to APIs that devs will need to know about, usually paired with dev_docs_required, except api_change remains permanetly),
** unit_test_required and acceptance_test_required, when there are api or ui changes needing improved coverage, and
** qa_test_required (significant functional change, not covered by unit/acceptance ones).
* Also, verify that the components for the issue are correctly set, so maintainers (subscribed by default) will be mailed about issues early in the process.

==Git==
Ensure that:
* the commit matches the [[Coding style#Git_commits|Coding style]]
* the Git history is clean and the work has been rebased to logical commits; and
* the original author of the work provided as a patch has been given credit within the commit (as author of in the commit message if changes were made).

==Third party code==
Does the change contain [[Plugin with third party libraries|third party code]]? If so, ensure that:

* The code is licensed under a [http://www.gnu.org/licenses/license-list.html#GPLCompatibleLicenses| GPL compatible license].
* The instructions for upgrading/importing the library and contained within a readme_moodle.txt file.
* The library is recorded in a thirdparty.xml file, including licensing information.
* Third party code has been scanned to check for url accessible entry points that could be exploited. These should either be disabled, or if required functionality they should be checked for security weaknesses.
* Does not duplicate the functionality of any existing api or third party library in core.
* Any modifications to third party code are recorded in readme_moodle.txt

==Sanity check==
Ensure that:
* the code seems to solve the described problem completely within its reported scope (and further issues have been created to resolve remaining parts or further refactoring);
* the code makes sense in relation to the broader codebase (look at the whole function, not just the altered code); and
* the developer has searched for and fixed other areas that may also have been affected by the same problem.
* verify that the related component maintainers, if known, have participated and are aware of the issue (as assignee, or existing comments...). If they have not, please perform a friendly <tt>@mention</tt> to make them aware about the issue. A list of component leads is available here: https://docs.moodle.org/dev/Component_Leads
* if any version numbers have been changed in [[version.php]] files, then the changes follow [[Moodle_versions#How_to_increment_version_numbers_in_core|the rule for updating version numbers in core]].
* there are comments on tracker explaining why current approach was taken and why other options (especially large issues). If not comment asking them to explain

==Icons==
Are new icons being introduced? If so, ensure that:
* the icons abide by our [https://docs.moodle.org/dev/Moodle_icons icon guidelines] with regards to size, design and format
* the icons are do not unnecessarily add new ways of expressing existing concepts
* the icons are in a pix folder that makes sense

==The Moodle mobile app==
The Moodle app supports most of the user-related Moodle functionality. It is important to think about how a change in student-related features might affect it.

Ensure that:
* The issue is labelled with affects_mobileapp so the Moodle Apps team will have a chance to review the changes and how they will affect the app
* New module settings are returned via the existing Web Services in the module
* When the code includes a new Web Service that will be necessary for the Moodle app, the new Web Service is included in the mobile service
* New global settings that affect new features for the app are included in the WebServices returning global settings (tool_mobile_get_config)
* The testing instructions include testing steps for the Moodle App

==See Also==
* [http://moodle.org/plugins/view.php?plugin=local_codechecker Code checker plugin]

[[Category: Processes]]