InAppSlideoutDOMAPI.js 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  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, 2020
  6. * US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
  7. */
  8. /**
  9. * @class DashboardServiceabilityAPI
  10. * @hideconstructor
  11. * @classdesc Internal API class that is used to manage the serviceability view.
  12. */
  13. define([], function () {
  14. var InAppSlideoutDOMAPI = function () {
  15. function InAppSlideoutDOMAPI() {
  16. _classCallCheck(this, InAppSlideoutDOMAPI);
  17. }
  18. /**
  19. * @function InAppSlideoutDOMAPI#render
  20. * @description render the InAppSlideout view
  21. * @return {Promise} Promise resolved when the view is rendered
  22. */
  23. InAppSlideoutDOMAPI.prototype.render = function render() {};
  24. /**
  25. * @function InAppSlideoutDOMAPI#registerView
  26. * @description Register slideout contribution
  27. * @param {string} id - contribution id
  28. * @param {object} instance - contribution instance
  29. */
  30. InAppSlideoutDOMAPI.prototype.registerView = function registerView() {};
  31. /**
  32. * @function InAppSlideoutDOMAPI#removeView
  33. * @description remove a slideout contribution
  34. * @param {string} id - id of contribution to remove
  35. */
  36. InAppSlideoutDOMAPI.prototype.removeView = function removeView() {};
  37. /**
  38. * @function InAppSlideoutDOMAPI#getViews
  39. * @description get the list of contributions
  40. * @return {Object[]} list of contributions
  41. */
  42. InAppSlideoutDOMAPI.prototype.getViews = function getViews() {};
  43. /**
  44. * @function InAppSlideoutDOMAPI#getView
  45. * @description get a single contribution by id
  46. * @param {string} id - id of the contribution
  47. * @return {Object} contribution object
  48. */
  49. InAppSlideoutDOMAPI.prototype.getView = function getView() {};
  50. /**
  51. * @function InAppSlideoutDOMAPI#onDomStateChange
  52. * @description register a on state change callback, to be called when the DOM state is changed such as mounted or unmounted
  53. * @param {Function} fn - function to be called when the DOM state changes such as mounted or unmounted
  54. * @return {Function} function returned to destroy remove the listener
  55. */
  56. InAppSlideoutDOMAPI.prototype.onDomStateChange = function onDomStateChange() {};
  57. return InAppSlideoutDOMAPI;
  58. }();
  59. return InAppSlideoutDOMAPI;
  60. });
  61. //# sourceMappingURL=InAppSlideoutDOMAPI.js.map