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

define([], function () {

	/**
  * @interface UserProfileAPI
  * @classdesc API class that defines the user profile information that is accessible in a dashboard.
  * @example dashboard.getFeature('UserProfile')
  * @example appFactory.getFeature('UserProfile')
  */
	var UserProfileAPI = function () {
		function UserProfileAPI() {
			_classCallCheck(this, UserProfileAPI);
		}

		/**
   * @param {string} capabilityName - Name of the capabilities:
   * <ul>
   * <li>canAuthorDashboard</li>
   * <li>canUseInteractiveDashboard</li>
   * </ul>
   *
   * @returns {boolean} Returns 'true' if the capability is known and enabled; false otherwise.
   * @example
   *  if (userProfile.hasCapability('canAuthorDashboard') === true) {
   *    //do something
   *  } else {
   *    // do something else
   *  }
   */
		UserProfileAPI.prototype.hasCapability = function hasCapability() {};

		/**
   * @returns {string} user content locale. Defaults to 'en'
   */


		UserProfileAPI.prototype.getContentLocale = function getContentLocale() {};

		/*
   * @async
   * @return Promise<Object> - Promise resolved with a JSON object that contains all available content locales
   * @example
   * 	{
  		en: 'English',
  		fr: 'French',
  		af: 'Afrikaans',
  		de: 'German',
  		zh: 'Chinese'
   * 	}
   */


		UserProfileAPI.prototype.getAvailableContentLocales = function getAvailableContentLocales() {};

		/**
   * @returns {Object} The user's account information including {defaultName, userName}
   */


		UserProfileAPI.prototype.getUserAccount = function getUserAccount() {};

		/**
   * @returns {String} - A list of valid domains, separated by coma, null or empty string means all domains are supported
   * @example
   * 	'localhost,www.ibm.com,www.domainport.com:80, .onelevel.com ,*.alllevels.com,.mixed.com:80'
   */


		UserProfileAPI.prototype.getValidDomainList = function getValidDomainList() {};

		return UserProfileAPI;
	}();

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