analytics/webcontent/bi/js/dashboard-analytics/features/dashboard/prompts/api/PromptsAPI.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 PromptsAPI
 * @hideconstructor
 * @classdesc API class to handle prompt fault.
 */
define([], function () {
	var PromptsAPI = function () {
		function PromptsAPI() {
			_classCallCheck(this, PromptsAPI);
		}

		/**
   * @function PromptsAPI#isPromptFault
   * @description Check whether a failed response is prompt fault.
   * @public
   * @param {object} errorResponse The failed query response.
   * 
   * @return true if the response status is prompt fault.
   */
		PromptsAPI.prototype.isPromptFault = function isPromptFault() {};

		/**
   * @function PromptsAPI#getPromptSpecList
   * @description get prompt spec list from prompt fault.
   * @public
   * 
   * @param {object} errorResponse The failed query response.
   * @return {object[]} An array of prompt spec.
   */


		PromptsAPI.prototype.getPromptSpecList = function getPromptSpecList() {};

		/**
   * @function PromptsAPI#openPromptView
   * @description Open prompt dialog and rerun original query with picked values from the dialog.
   * @public
   * @async
   * 
   * @param {object[]} specList An array of prompt spec.
   * @param {VisualizationAPI} [visualization] The {@link VisualizationAPI} object
   * @return {Promise<Object[]>} Returns a promise that will be resolved to an array of {@link PromptValueSpec} object
   */


		PromptsAPI.prototype.openPromptView = function openPromptView() {};

		return PromptsAPI;
	}();

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