DashboardTemplatesAPI.js 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. "use strict";
  2. function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
  3. /**
  4. * Licensed Materials - Property of IBM
  5. * IBM Business Analytics (C) Copyright IBM Corp. 2019
  6. * US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
  7. */
  8. /**
  9. * @class DashboardTemplatesAPI
  10. * @hideconstructor
  11. * @classdesc Internal API class that is used to manage the dashboard templates.
  12. */
  13. define([], function () {
  14. var DashboardTemplatesAPI = function () {
  15. function DashboardTemplatesAPI() {
  16. _classCallCheck(this, DashboardTemplatesAPI);
  17. }
  18. /**
  19. * @function DashboardTemplatesAPI#destroy
  20. * @description destroy this instance
  21. */
  22. DashboardTemplatesAPI.prototype.destroy = function destroy() {};
  23. /**
  24. * @function DashboardTemplatesAPI#listTemplates
  25. * @description Get a list of templates sorted by modificationDate
  26. * @returns {Promise} Resolves to the list of dashboard templates found
  27. */
  28. DashboardTemplatesAPI.prototype.listTemplates = function listTemplates() {};
  29. /**
  30. * @function DashboardTemplatesAPI#getTemplate
  31. * @description Get the content of a specific template
  32. * @param {string} id The id of the dashboard template who's content is to be returned
  33. * @param {boolean} includeSpec Whether or not the specficiation of the dashboard template should be included in the output
  34. * @returns {Promise} Resolves to the requested dashboard template content
  35. */
  36. DashboardTemplatesAPI.prototype.getTemplate = function getTemplate() {};
  37. /**
  38. * @function DashboardTemplatesAPI#getThumbnail
  39. * @description Get the thumbnail associated with a specific dashboard template
  40. * @param {string} id The id of the dashboard template who's thumbnail is to be returned
  41. * @returns {Promise} Resolves to the requested dashboard template thumbnail
  42. */
  43. DashboardTemplatesAPI.prototype.getThumbnail = function getThumbnail() {};
  44. return DashboardTemplatesAPI;
  45. }();
  46. return DashboardTemplatesAPI;
  47. });
  48. //# sourceMappingURL=DashboardTemplatesAPI.js.map