Merge pull request #487 from dpalou/MOBILE-1543

Mobile 1543

Author: jleyva

upgrade.txt

@@ -1,6 +1,10 @@
 This files describes API changes in the Moodle Mobile app,
 information provided here is intended especially for developers.
 
+=== 3.1.0 ===
+
+ * A new param "single" is passed to the prefetch functions of handlers registered in $mmCoursePrefetchDelegateProvider. Please notice that the download of sections will always send false/undefined, if you use this function somewhere else to download a single module then you should pass single=true.
+
 === 3.0 ===
 
  * The function $mmaModBook#getChapterContent now requires to receive the result of $mmaModBook#getContentsMap instead of module.contents.

www/addons/mod_book/services/prefetch_handler.js

@@ -82,10 +82,12 @@ angular.module('mm.addons.mod_book')
      * @module mm.addons.mod_book
      * @ngdoc method
      * @name $mmaModBookPrefetchHandler#prefetch
-     * @param {Object} module The module object returned by WS.
-     * @return {Promise}      Promise resolved when all files have been downloaded. Data returned is not reliable.
+     * @param  {Object} module   The module object returned by WS.
+     * @param  {Number} courseId Course ID the module belongs to.
+     * @param  {Boolean} single  True if we're downloading a single module, false if we're downloading a whole section.
+     * @return {Promise}         Promise resolved when all files have been downloaded. Data returned is not reliable.
      */
-    self.prefetch = function(module) {
+    self.prefetch = function(module, courseId, single) {
         return $mmaModBook.prefetchContent(module);
     };
 

www/addons/mod_folder/services/prefetch_handler.js

@@ -64,10 +64,12 @@ angular.module('mm.addons.mod_folder')
      * @module mm.addons.mod_folder
      * @ngdoc method
      * @name $mmaModFolderPrefetchHandler#prefetch
-     * @param {Object} module The module object returned by WS.
-     * @return {Promise}      Promise resolved when all files have been downloaded. Data returned is not reliable.
+     * @param  {Object} module   The module object returned by WS.
+     * @param  {Number} courseId Course ID the module belongs to.
+     * @param  {Boolean} single  True if we're downloading a single module, false if we're downloading a whole section.
+     * @return {Promise}         Promise resolved when all files have been downloaded. Data returned is not reliable.
      */
-    self.prefetch = function(module) {
+    self.prefetch = function(module, courseId, single) {
         return $mmaModFolder.prefetchContent(module);
     };
 

www/addons/mod_imscp/services/prefetch_handler.js

@@ -64,10 +64,12 @@ angular.module('mm.addons.mod_imscp')
      * @module mm.addons.mod_imscp
      * @ngdoc method
      * @name $mmaModImscpPrefetchHandler#prefetch
-     * @param {Object} module The module object returned by WS.
-     * @return {Promise}      Promise resolved when all files have been downloaded. Data returned is not reliable.
+     * @param  {Object} module   The module object returned by WS.
+     * @param  {Number} courseId Course ID the module belongs to.
+     * @param  {Boolean} single  True if we're downloading a single module, false if we're downloading a whole section.
+     * @return {Promise}         Promise resolved when all files have been downloaded. Data returned is not reliable.
      */
-    self.prefetch = function(module) {
+    self.prefetch = function(module, courseId, single) {
         return $mmaModImscp.prefetchContent(module);
     };
 

www/addons/mod_page/services/prefetch_handler.js

@@ -64,10 +64,12 @@ angular.module('mm.addons.mod_page')
      * @module mm.addons.mod_page
      * @ngdoc method
      * @name $mmaModPagePrefetchHandler#prefetch
-     * @param {Object} module The module object returned by WS.
-     * @return {Promise}      Promise resolved when all files have been downloaded. Data returned is not reliable.
+     * @param  {Object} module   The module object returned by WS.
+     * @param  {Number} courseId Course ID the module belongs to.
+     * @param  {Boolean} single  True if we're downloading a single module, false if we're downloading a whole section.
+     * @return {Promise}         Promise resolved when all files have been downloaded. Data returned is not reliable.
      */
-    self.prefetch = function(module) {
+    self.prefetch = function(module, courseId, single) {
         return $mmaModPage.prefetchContent(module);
     };
 

www/addons/mod_quiz/accessrules/delaybetweenattempts/handlers.js

@@ -37,10 +37,13 @@ angular.module('mm.addons.mod_quiz')
     /**
      * Check if a preflight check is required.
      *
+     * @param  {Object} quiz      Quiz.
      * @param  {Object} [attempt] Attempt to continue. Not defined if starting a new attempt.
+     * @param  {Boolean} prefetch True if prefetching, false if attempting the quiz.
+     * @param  {String} [siteId]  Site ID. If not defined, current site.
      * @return {Boolean}          True if preflight check required.
      */
-    self.isPreflightCheckRequired = function(attempt) {
+    self.isPreflightCheckRequired = function(quiz, attempt, prefetch, siteId) {
         return false;
     };
 

www/addons/mod_quiz/accessrules/ipaddress/handlers.js

@@ -37,10 +37,13 @@ angular.module('mm.addons.mod_quiz')
     /**
      * Check if a preflight check is required.
      *
+     * @param  {Object} quiz      Quiz.
      * @param  {Object} [attempt] Attempt to continue. Not defined if starting a new attempt.
+     * @param  {Boolean} prefetch True if prefetching, false if attempting the quiz.
+     * @param  {String} [siteId]  Site ID. If not defined, current site.
      * @return {Boolean}          True if preflight check required.
      */
-    self.isPreflightCheckRequired = function(attempt) {
+    self.isPreflightCheckRequired = function(quiz, attempt, prefetch, siteId) {
         return false;
     };
 

www/addons/mod_quiz/accessrules/numattempts/handlers.js

@@ -37,10 +37,13 @@ angular.module('mm.addons.mod_quiz')
     /**
      * Check if a preflight check is required.
      *
+     * @param  {Object} quiz      Quiz.
      * @param  {Object} [attempt] Attempt to continue. Not defined if starting a new attempt.
+     * @param  {Boolean} prefetch True if prefetching, false if attempting the quiz.
+     * @param  {String} [siteId]  Site ID. If not defined, current site.
      * @return {Boolean}          True if preflight check required.
      */
-    self.isPreflightCheckRequired = function(attempt) {
+    self.isPreflightCheckRequired = function(quiz, attempt, prefetch, siteId) {
         return false;
     };
 

www/addons/mod_quiz/accessrules/offlineattempts/handlers.js

@@ -37,10 +37,17 @@ angular.module('mm.addons.mod_quiz')
     /**
      * Check if a preflight check is required.
      *
+     * @param  {Object} quiz      Quiz.
      * @param  {Object} [attempt] Attempt to continue. Not defined if starting a new attempt.
+     * @param  {Boolean} prefetch True if prefetching, false if attempting the quiz.
+     * @param  {String} [siteId]  Site ID. If not defined, current site.
      * @return {Boolean}          True if preflight check required.
      */
-    self.isPreflightCheckRequired = function(attempt) {
+    self.isPreflightCheckRequired = function(quiz, attempt, prefetch, siteId) {
+        if (prefetch) {
+            return false;
+        }
+
         if (!attempt) {
             return true;
         }
@@ -52,14 +59,14 @@ angular.module('mm.addons.mod_quiz')
     /**
      * Get fixed preflight data (data that doesn't require user interaction).
      *
-     * @module mm.addons.mod_quiz
-     * @ngdoc method
-     * @name $mmaModQuizAccessRulesDelegate#getFixedPreflightData
+     * @param  {Object} quiz          Quiz.
      * @param  {Object} attempt       Attempt.
      * @param  {Object} preflightData Object where to store the preflight data.
+     * @param  {Boolean} prefetch     True if prefetching, false if attempting the quiz.
+     * @param  {String} [siteId]      Site ID. If not defined, current site.
      * @return {Void}
      */
-    self.getFixedPreflightData = function(attempt, preflightData) {
+    self.getFixedPreflightData = function(quiz, attempt, preflightData, prefetch, siteId) {
         preflightData.confirmdatasaved = 1;
     };
 

www/addons/mod_quiz/accessrules/openclosedate/handlers.js

@@ -37,10 +37,13 @@ angular.module('mm.addons.mod_quiz')
     /**
      * Check if a preflight check is required.
      *
+     * @param  {Object} quiz      Quiz.
      * @param  {Object} [attempt] Attempt to continue. Not defined if starting a new attempt.
+     * @param  {Boolean} prefetch True if prefetching, false if attempting the quiz.
+     * @param  {String} [siteId]  Site ID. If not defined, current site.
      * @return {Boolean}          True if preflight check required.
      */
-    self.isPreflightCheckRequired = function(attempt) {
+    self.isPreflightCheckRequired = function(quiz, attempt, prefetch, siteId) {
         return false;
     };