<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Interface: UserProfileAPI</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Interface: UserProfileAPI</h1>
<section>
<header>
<h2>UserProfileAPI</h2>
<div class="class-description">API class that defines the user profile information that is accessible in a dashboard.</div>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
<h3>Examples</h3>
<pre class="prettyprint"><code>dashboard.getFeature('UserProfile')</code></pre>
<pre class="prettyprint"><code>appFactory.getFeature('UserProfile')</code></pre>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="getContentLocale"><span class="type-signature"></span>getContentLocale<span class="signature">()</span><span class="type-signature"> → {string}</span></h4>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
user content locale. Defaults to 'en'
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="getUserAccount"><span class="type-signature"></span>getUserAccount<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The user's account information including {defaultName, userName}
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="getValidDomainList"><span class="type-signature"></span>getValidDomainList<span class="signature">()</span><span class="type-signature"> → {String}</span></h4>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- A list of valid domains, separated by coma, null or empty string means all domains are supported
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>'localhost,www.ibm.com,www.domainport.com:80, .onelevel.com ,*.alllevels.com,.mixed.com:80'</code></pre>
<h4 class="name" id="hasCapability"><span class="type-signature"></span>hasCapability<span class="signature">(capabilityName)</span><span class="type-signature"> → {boolean}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>capabilityName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Name of the capabilities:
<ul>
<li>canAuthorDashboard</li>
<li>canUseInteractiveDashboard</li>
</ul></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns 'true' if the capability is known and enabled; false otherwise.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>if (userProfile.hasCapability('canAuthorDashboard') === true) {
//do something
} else {
// do something else
}</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AppFactory.html">AppFactory</a></li></ul><h3>Interfaces</h3><ul><li><a href="CanvasAPI.html">CanvasAPI</a></li><li><a href="ContentAPI.html">ContentAPI</a></li><li><a href="ContentStoreAPI.html">ContentStoreAPI</a></li><li><a href="DashboardCoreAPI.html">DashboardCoreAPI</a></li><li><a href="DashboardPreferencesAPI.html">DashboardPreferencesAPI</a></li><li><a href="DashboardSettingsAPI.html">DashboardSettingsAPI</a></li><li><a href="PropertiesAPI.html">PropertiesAPI</a></li><li><a href="RendererAPI.html">RendererAPI</a></li><li><a href="SaveAPI.html">SaveAPI</a></li><li><a href="SerializerAPI.html">SerializerAPI</a></li><li><a href="StateAPI.html">StateAPI</a></li><li><a href="TransactionAPI.html">TransactionAPI</a></li><li><a href="UserProfileAPI.html">UserProfileAPI</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Thu May 05 2022 17:56:07 GMT+0000 (UTC)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>