analytics/webcontent/bi/js/gemini/features/dashboard/inAppSlideout/InAppSlideoutStateAPI.js

"use strict";

function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }

/**
 * Licensed Materials - Property of IBM
 * IBM Business Analytics (C) Copyright IBM Corp. 2019
 * US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
 */

/**
 * @class InAppSlideoutAPI
 * @hideconstructor
 * @classdesc Internal API class that is used to manage the InAppSlideout view.
 */
define([], function () {
	var InAppSlideoutAPI = function () {
		function InAppSlideoutAPI() {
			_classCallCheck(this, InAppSlideoutAPI);
		}

		/**
   * @function InAppSlideoutStateAPI#registerContribution
   * @description register a slideout contribution
   * @param {string} id - id of the contribution
   * @param {Object} contentContribution - content contribution
   * @return {Promise} Promise resolved when the contributor is registered
   */
		InAppSlideoutAPI.prototype.registerContribution = function registerContribution() {};

		/**
   * @function InAppSlideoutStateAPI#removeContribution
   * @description remove a slideout contribution
   * @param {string} id - id of contribution to remove
   */


		InAppSlideoutAPI.prototype.removeContribution = function removeContribution() {};

		/**
   * @function InAppSlideoutStateAPI#getContributions
   * @description get the list of contributions
   * @return {Object[]} list of contributions
   */


		InAppSlideoutAPI.prototype.getContributions = function getContributions() {};

		/**
   * @function InAppSlideoutStateAPI#getContribution
   * @description get a single contribution by id
   * @param {string} id - id of the contribution
   * @return {Object} contribution object
   */


		InAppSlideoutAPI.prototype.getContribution = function getContribution() {};

		/**
   * @function InAppSlideoutStateAPI#getCurrent
   * @description get current contribution
   * @return {Object} object containing `item` (contribution instance) and `data` (additional data to pass the contribution upon render)
   */


		InAppSlideoutAPI.prototype.getCurrent = function getCurrent() {};

		/**
   * @function InAppSlideoutStateAPI#getUiState
   * @description get the current ui state
   * @return {Object}
   */


		InAppSlideoutAPI.prototype.getUiState = function getUiState() {};

		/**
   * @function InAppSlideoutStateAPI#onStateChange
   * @description register a on state change callback, to be called when the state is changed
   * @param {Function} fn - function to be called when the state changes
   * @return {Function} function returned to destroy remove the listener
   */


		InAppSlideoutAPI.prototype.onStateChange = function onStateChange() {};

		/**
   * @function InAppSlideoutStateAPI#isOpen
   * @description Check whether the in app slideout is open or not
   * @return {Boolean} TRUE if the slideout is open and FALSE if the slideout is not
   */


		InAppSlideoutAPI.prototype.isOpen = function isOpen() {};

		/**
   * @function InAppSlideoutStateAPI#open
   * @description Open the slideout
   */


		InAppSlideoutAPI.prototype.open = function open() {};

		/**
   * @function InAppSlideoutStateAPI#close
   * @description Close the slideout
   */


		InAppSlideoutAPI.prototype.close = function close() {};

		return InAppSlideoutAPI;
	}();

	return InAppSlideoutAPI;
});
//# sourceMappingURL=InAppSlideoutStateAPI.js.map