ContentMenuProviderAPI.js 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  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. 2020
  6. * US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
  7. */
  8. /**
  9. * @class ContentMenuProviderAPI
  10. * @hideconstructor
  11. * @classdesc API class that is used to implement a content menu provider for the purpose of contributing a content menu
  12. */
  13. define([], function () {
  14. var ContentMenuProviderAPI = function () {
  15. function ContentMenuProviderAPI() {
  16. _classCallCheck(this, ContentMenuProviderAPI);
  17. }
  18. /**
  19. * @function ContentMenuProviderAPI#getContentMenuList
  20. * @description Returns a list of content menu available contents.
  21. * @param {string[]} idList list of content ids
  22. * @return {object[]} array containing all available menu
  23. * eg. [{
  24. * id: 'id1',
  25. * name: 'overlay',
  26. * label: 'show/hide overlay',
  27. * action: actionFunction
  28. * }]
  29. */
  30. ContentMenuProviderAPI.prototype.getContentMenuList = function getContentMenuList() {};
  31. return ContentMenuProviderAPI;
  32. }();
  33. return ContentMenuProviderAPI;
  34. });
  35. //# sourceMappingURL=ContentMenuProviderAPI.js.map