analytics/webcontent/bi/js/storytelling/api/StoryAPI.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 StoryAPI
 * @hideconstructor
 * @classdesc API class that is used to control the behaviour of a storytelling instance
 */
define([], function () {
	var StoryAPI = function () {
		function StoryAPI() {
			_classCallCheck(this, StoryAPI);
		}

		/**
   * @function StoryAPI#addScene
   * @param {string} [sceneType=SceneLayout1]
   * @param {string} [title=null]
   */
		StoryAPI.prototype.addScene = function addScene(sceneType, title) {
			void sceneType;
			void title;
		};

		/**
   * @function StoryAPI#deleteScene
   * @param id
   */


		StoryAPI.prototype.deleteScene = function deleteScene(id) {
			void id;
		};

		/**
   * @function StoryAPI#duplicateScene
   * @param id
   */


		StoryAPI.prototype.duplicateScene = function duplicateScene(id) {
			void id;
		};

		/**
   * @function StoryAPI#enterShareState
   * @param slideout {Object} The share panel slideout
   */


		StoryAPI.prototype.enterShareState = function enterShareState(slideout) {
			void slideout;
		};

		/**
   * @function StoryAPI#getCurrentSceneInfo
   */


		StoryAPI.prototype.getCurrentSceneInfo = function getCurrentSceneInfo() {};

		/**
   * @function StoryAPI#getCurrentTime
   */


		StoryAPI.prototype.getCurrentTime = function getCurrentTime() {};

		/**
   * @function StoryAPI#getDuration
   */


		StoryAPI.prototype.getDuration = function getDuration() {};

		/**
   * @function StoryAPI#getSceneCount
   */


		StoryAPI.prototype.getSceneCount = function getSceneCount() {};

		/**
   * @function StoryAPI#getSelectedSceneIndex
   */


		StoryAPI.prototype.getSelectedSceneIndex = function getSelectedSceneIndex() {};

		/**
   * @function StoryAPI#getSceneId
   * @param index
   */


		StoryAPI.prototype.getSceneId = function getSceneId(index) {
			void index;
		};

		/**
   * @function StoryAPI#getTimelineAPI
   * @param index
   */


		StoryAPI.prototype.getTimelineAPI = function getTimelineAPI() {};

		/**
   * @function StoryAPI#isPlaying
   */


		StoryAPI.prototype.isPlaying = function isPlaying() {};

		/**
   * @function StoryAPI#isStartOverview
   */


		StoryAPI.prototype.isStartOverview = function isStartOverview() {};

		/**
   * @function StoryAPI#isEndOverview
   */


		StoryAPI.prototype.isEndOverview = function isEndOverview() {};

		/**
   * @function StoryAPI#isAtStartOfScene
   */


		StoryAPI.prototype.isAtStartOfScene = function isAtStartOfScene() {};

		/**
   * @function StoryAPI#isAtEndOfScene
   */


		StoryAPI.prototype.isAtEndOfScene = function isAtEndOfScene() {};

		/**
   * @function StoryAPI#toggleKioskMode
   */


		StoryAPI.prototype.toggleKioskMode = function toggleKioskMode() {};

		/**
   * @function StoryAPI#toggleNavigateMarkers
   */


		StoryAPI.prototype.toggleNavigateMarkers = function toggleNavigateMarkers() {};

		/**
   * @function StoryAPI#togglePlayThrough
   */


		StoryAPI.prototype.togglePlayThrough = function togglePlayThrough() {};

		/**
   * @function StoryAPI#isNavigateMarkers
   */


		StoryAPI.prototype.isNavigateMarkers = function isNavigateMarkers() {};

		/**
   * @function StoryAPI#isScenePopulated
   * @param sceneId
   */


		StoryAPI.prototype.isScenePopulated = function isScenePopulated(sceneId) {
			void sceneId;
		};

		/**
   * @function StoryAPI#play
   */


		StoryAPI.prototype.play = function play() {};

		/**
   * @function StoryAPI#stop
   */


		StoryAPI.prototype.stop = function stop() {};

		/**
   * @function StoryAPI#leaveShareState
   */


		StoryAPI.prototype.leaveShareState = function leaveShareState() {};

		/**
   * @function StoryAPI#moveSceneLeft
   * @param id
   */


		StoryAPI.prototype.moveSceneLeft = function moveSceneLeft(id) {
			void id;
		};

		/**
   * @function StoryAPI#moveSceneRight
   * @param id
   */


		StoryAPI.prototype.moveSceneRight = function moveSceneRight(id) {
			void id;
		};

		/**
   * @function StoryAPI#nextScene
   * @param options
   */


		StoryAPI.prototype.nextScene = function nextScene(options) {
			void options;
		};

		/**
   * @function StoryAPI#previousScene
   */


		StoryAPI.prototype.previousScene = function previousScene() {};

		/**
   * @function StoryAPI#renameScene
   * @param id
   * @param title
   */


		StoryAPI.prototype.renameScene = function renameScene(id, title) {
			void id;
			void title;
		};

		/**
   * @function StoryAPI#selectScene
   * @param options
   */


		StoryAPI.prototype.selectScene = function selectScene(options) {
			void options;
		};

		/**
   * @function StoryAPI#setCurrentTime
   * @param time
   */


		StoryAPI.prototype.setCurrentTime = function setCurrentTime(time) {
			void time;
		};

		/**
   * @function StoryAPI#enterPrintMode
   */


		StoryAPI.prototype.enterPrintMode = function enterPrintMode() {};

		/**
   * @function StoryAPI#leavePrintMode
   * @param sceneTime
   */


		StoryAPI.prototype.leavePrintMode = function leavePrintMode(sceneTime) {
			void sceneTime;
		};

		return StoryAPI;
	}();

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