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

define([], function () {
	/**
  * @interface DashboardPreferencesAPI
  * @hideconstructor
  * @classdesc API class that is used to manage user preferences.
  * @example dashboard.getFeature('DashboardPreferences')
  */
	var DashboardPreferencesAPI = function () {
		function DashboardPreferencesAPI() {
			_classCallCheck(this, DashboardPreferencesAPI);
		}

		/**
   * @description Returns an attribute that was set in the preferences.
   * @param {string} name Name of the preference
   * @return {(string|boolean|number|null|undefined)} Value of the preference; null means the property will be removed when saved.
   */
		DashboardPreferencesAPI.prototype.getPreference = function getPreference() {};

		/**
   * @description Sets the preference.
   * @param {string} name Name of the preference
   * @param {(string|boolean|number|null)} value Value of the preference to set; exception is thrown when it is not one of these types.
   */


		DashboardPreferencesAPI.prototype.setPreference = function setPreference() {};

		/**
   * @description Saves the preferences.
   * @returns {Promise} Promise is rejected if the save did not complete successfully.
   */


		DashboardPreferencesAPI.prototype.savePreferences = function savePreferences() {};

		return DashboardPreferencesAPI;
	}();

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