MOBILE-1543 prefetch: Add 'single' param to prefetch handlers

Author: dpalou

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/services/prefetch_handler.js

@@ -136,12 +136,13 @@ angular.module('mm.addons.mod_quiz')
      * @module mm.addons.mod_quiz
      * @ngdoc method
      * @name $mmaModQuizPrefetchHandler#prefetch
-     * @param {Object} module   The module object returned by WS.
-     * @param {Number} courseId Course ID the module belongs to.
-     * @return {Promise}        Promise resolved when the prefetch is finished. 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 the prefetch is finished. Data returned is not reliable.
      */
-    self.prefetch = function(module, courseId) {
-        return $mmaModQuiz.prefetch(module, courseId);
+    self.prefetch = function(module, courseId, single) {
+        return $mmaModQuiz.prefetch(module, courseId, single);
     };
 
     return self;

www/addons/mod_resource/services/prefetch_handler.js

@@ -64,10 +64,12 @@ angular.module('mm.addons.mod_resource')
      * @module mm.addons.mod_resource
      * @ngdoc method
      * @name $mmaModResourcePrefetchHandler#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 $mmaModResource.prefetchContent(module);
     };
 

www/addons/mod_scorm/services/prefetch_handler.js

@@ -117,12 +117,13 @@ angular.module('mm.addons.mod_scorm')
      * @module mm.addons.mod_scorm
      * @ngdoc method
      * @name $mmaModScormPrefetchHandler#prefetch
-     * @param {Object} module   The module object returned by WS.
-     * @param {Number} courseid Course ID the module belongs to.
-     * @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, courseid) {
-        return $mmaModScorm.getScorm(courseid, module.id, module.url).then(function(scorm) {
+    self.prefetch = function(module, courseId, single) {
+        return $mmaModScorm.getScorm(courseId, module.id, module.url).then(function(scorm) {
             return $mmaModScorm.prefetch(scorm);
         });
     };

www/addons/mod_wiki/services/prefetch_handler.js

@@ -176,11 +176,12 @@ angular.module('mm.addons.mod_wiki')
      * @module mm.addons.mod_wiki
      * @ngdoc method
      * @name $mmaModWikiPrefetchHandler#prefetch
-     * @param {Object} module The module object returned by WS.
-     * @param {Number} courseId Course ID the module belongs to.
-     * @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, courseId) {
+    self.prefetch = function(module, courseId, single) {
         var siteId = $mmSite.getId(),
             userid = userid || $mmSite.getUserId();
 

www/core/components/course/services/prefetchdelegate.js

@@ -47,7 +47,7 @@ angular.module('mm.core')
      *                             - component (String) Handler's component.
      *                             - getDownloadSize(module, courseid) (Number|Promise) Get the download size of a module.
      *                             - isEnabled() (Boolean|Promise) Whether or not the handler is enabled on a site level.
-     *                             - prefetch(module, courseid) (Promise) Prefetches a module.
+     *                             - prefetch(module, courseid, single) (Promise) Prefetches a module.
      *                             - (Optional) getFiles(module, courseid) (Object[]|Promise) Get list of files. If not defined,
      *                                                                      we'll assume they're in module.contents.
      *                             - (Optional) determineStatus(status) (String) Returns status to show based on current. E.g. for