analytics/webcontent/bi/js/gemini/features/dashboard/eventGroups/api/EventGroupsAPI.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 EventGroupAPI
 * @hideconstructor
 * @classdesc API class that contains event group functionality
 */
define([], function () {
	var EventGroupsAPI = function () {
		function EventGroupsAPI() {
			_classCallCheck(this, EventGroupsAPI);
		}

		/**
   * @public
   * @function EventGroupsAPI#groupExists
   * @description Check if a group with the given group id exists
   * @param {string} groupId - group id
   * @returns {boolean} TRUE if the group exists and FALSE if it does not
   */
		EventGroupsAPI.prototype.groupExists = function groupExists() {};

		/**
   * @public
   * @function EventGroupsAPI#getGroupId
   * @description Get the group id of the given widget
   * @param {string} widgetId - widget id
   * @returns {string} group id
   */


		EventGroupsAPI.prototype.getGroupId = function getGroupId() {};

		/**
   * @public
   * @function EventGroups#getGroupIdsOnPage
   * @description Get the ids of the groups on a given page
   * @param {String} pageId - page id
   * @returns {String[]} a list of the group ids for the page
   */


		EventGroupsAPI.prototype.getGroupIdsOnPage = function getGroupIdsOnPage() {};

		/**
   * @public
   * @function EventGroupsAPI#getContentIdList
   * @description Get the content id list of the given group id
   * @param {string} groupId - group id
   * @returns {string[]} a list of content ids
   */


		EventGroupsAPI.prototype.getContentIdList = function getContentIdList() {};

		/**
   * @public
   * @function EventGroupsAPI#addToGroup
   * @description Add widgets to a group with the given group id. If the group doesn't exists it will be created
   * @param {string} groupId - group id to add the widgets to
   * @param {[string]} widgetIds - widget ids to add to the group
   * @param {string} [transactionToken] - transaction token
   */


		EventGroupsAPI.prototype.addToGroup = function addToGroup() {};

		/**
   * @public
   * @function EventGroupsAPI#createGroup
   * @description Create a new group with the given widget ids
   * @param {[string]} widgetIds - widget ids to add to the new group
   * @param {string} [transactionToken] - transaction token
   * @returns {string} newly created group id
   */


		EventGroupsAPI.prototype.createGroup = function createGroup() {};

		/**
   * @public
   * @function EventGroupsAPI#removeFromGroup
   * @description Remove the given widgets from group to it's own groups
   * @param {[string]} widgetIds - widget ids to remove from group
   * @param {string} [transactionToken] - transaction token
   * @returns {[string]} group ids
   */


		EventGroupsAPI.prototype.removeFromGroup = function removeFromGroup() {};

		return EventGroupsAPI;
	}();

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