analytics/webcontent/bi/js/gemini/features/dashboard/contentMenu/api/ContentMenuAPI.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. 2020
 * US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
 */

/**
 * @class ContentMenuAPI
 * @hideconstructor
 * @classdesc API class that is used to obtain the list of content menu available
 */
define([], function () {
	var ContentMenuAPI = function () {
		function ContentMenuAPI() {
			_classCallCheck(this, ContentMenuAPI);
		}

		/**
   * @function ContentMenuAPI#registerProvider
   * @description Register a provider as a content menu provider
   * @param {String} name of the provider
   * @param {Object} provider Provider api that registers and contributes to content menu
   * eg. usage: registerProvider('overlay', overlay.getAPI());
   */
		ContentMenuAPI.prototype.registerProvider = function registerProvider() {};

		/**
   * @function ContentMenuAPI#getContentMenuList
   * @description Returns a list of content menu available for a specific item given a list of content ids.
   * @param {string[]} idList list of content ids
   * @return {object[]} array containing all available menu
   * eg. [{
   * 	id: 'id1',
   * 	name: 'overlay',
   * 	label: 'show/hide overlay',
   * 	action: actionFunction
   * }]
   */


		ContentMenuAPI.prototype.getContentMenuList = function getContentMenuList() /* idList */{};

		return ContentMenuAPI;
	}();

	return ContentMenuAPI;
});
//# sourceMappingURL=ContentMenuAPI.js.map