From a0e5b839141dd3d63a063656ac5f3ebc0f4aca92 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=B8ren=20Gregersen?= <soreng@gmail.com>
Date: Wed, 25 Mar 2020 19:23:29 +0100
Subject: [PATCH] Add document to downloadFile-method

Simple copy/paste to document a useful method
---
 .../common/services/umbrequesthelper.service.js   | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/src/Umbraco.Web.UI.Client/src/common/services/umbrequesthelper.service.js b/src/Umbraco.Web.UI.Client/src/common/services/umbrequesthelper.service.js
index 6c765ee135..0d766dc7d8 100644
--- a/src/Umbraco.Web.UI.Client/src/common/services/umbrequesthelper.service.js
+++ b/src/Umbraco.Web.UI.Client/src/common/services/umbrequesthelper.service.js
@@ -365,12 +365,23 @@ function umbRequestHelper($http, $q, notificationsService, eventsService, formHe
         },
         
         /**
+         * @ngdoc method
+         * @name umbraco.resources.contentResource#downloadFile
+         * @methodOf umbraco.resources.contentResource
+         *
+         * @description
          * Downloads a file to the client using AJAX/XHR
-         * Based on an implementation here: web.student.tuwien.ac.at/~e0427417/jsdownload.html
-         * See https://stackoverflow.com/a/24129082/694494
+         * 
+         * @param {string} httpPath the path (url) to the resource being downloaded
+         * @returns {Promise} http promise object.
          */
         downloadFile : function (httpPath) {
 
+            /**
+             * Based on an implementation here: web.student.tuwien.ac.at/~e0427417/jsdownload.html
+             * See https://stackoverflow.com/a/24129082/694494
+             */
+
             // Use an arraybuffer
             return $http.get(httpPath, { responseType: 'arraybuffer' })
                 .then(function (response) {