analytics/webcontent/bi/js/dashboard-analytics/features/widget/renderSequence/api/RenderSequenceAPI.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 RenderSequenceAPI
 * @hideconstructor
 * @classdesc
 */
define([], function () {
	var RenderSequenceAPI = function () {
		function RenderSequenceAPI() {
			_classCallCheck(this, RenderSequenceAPI);
		}

		/**
   * payload passed to callbacks
   * @typedef {Object} TaskExecutionInfo
   * @property {string} taskId - id of the executed task
   * @property {RenderContextAPI} renderContent - renderContext API
   * @property {Object} error - error of the task execution
   */

		/**
   * @public
   * @function RenderSequenceAPI#onStartTaskExecution
   * @description registers the callback when task starts; callback will be called with {@link TaskExecutionInfo} as parameter
   * @param {function} callback - method to register
   */
		RenderSequenceAPI.prototype.onStartTaskExecution = function onStartTaskExecution() {};

		/**
   * @public
   * @function RenderSequenceAPI#onResolveTaskExecution
   * @description registers the callback when task ends successfully; allback will be called with {@link TaskExecutionInfo} as parameter
   * @param {function} callback - method to register
   */


		RenderSequenceAPI.prototype.onResolveTaskExecution = function onResolveTaskExecution() {};

		/**
   * @public
   * @function RenderSequenceAPI#onRejectTaskExecution
   * @description registers the callback when task end with failure; allback will be called with {@link TaskExecutionInfo} as parameter
   * @param {function} callback - method to register
   */


		RenderSequenceAPI.prototype.onRejectTaskExecution = function onRejectTaskExecution() {};

		/**
   * @public
   * @function RenderSequenceAPI#registerRenderStepProvider
   * @description Registers a render step provider. A render step provider can add custom render steps that will be executed when the visualization is rendered
   * @param {RenderStepProviderAPI} provider - render step provider
   */


		RenderSequenceAPI.prototype.registerRenderStepProvider = function registerRenderStepProvider() {};

		return RenderSequenceAPI;
	}();

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