adal-angular

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: AuthenticationContext</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <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">Class: AuthenticationContext</h1> <section> <header> <h2> AuthenticationContext </h2> </header> <article> <div class="container-overview"> <dt> <h4 class="name" id="AuthenticationContext"><span class="type-signature"></span>new AuthenticationContext<span class="signature">(config)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Creates a new AuthenticationContext object. </div> <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>config</code></td> <td class="type"> <span class="param-type"><a href="config.html">config</a></span> </td> <td class="description last">Configuration options for AuthenticationContext</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line49">line 49</a> </li></ul></dd> </dl> </dd> </div> <h3 class="subsection-title">Members</h3> <dl> <dt> <h4 class="name" id="CONSTANTS"><span class="type-signature"></span>CONSTANTS<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> Enum for storage constants </div> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>ACCESS_TOKEN</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> access_token </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>EXPIRES_IN</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> expires_in </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>ID_TOKEN</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> id_token </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>ERROR_DESCRIPTION</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> error_description </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>SESSION_STATE</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> session_state </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>STORAGE</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> OBJECTLIT </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>RESOURCE_DELIMETER</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> | </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>LOADFRAME_TIMEOUT</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> 6000 </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>TOKEN_RENEW_STATUS_CANCELED</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> Canceled </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>TOKEN_RENEW_STATUS_COMPLETED</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> Completed </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>TOKEN_RENEW_STATUS_IN_PROGRESS</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> In Progress </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>LOGGING_LEVEL</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> OBJECTLIT </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>LEVEL_STRING_MAP</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> OBJECTLIT </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>POPUP_WIDTH</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> 483 </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>POPUP_HEIGHT</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> 600 </td> <td class="description last"></td> </tr> </tbody> </table></dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line64">line 64</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="REQUEST_TYPE"><span class="type-signature"></span>REQUEST_TYPE<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> Enum for request type </div> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>LOGIN</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> LOGIN </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>RENEW_TOKEN</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> RENEW_TOKEN </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>UNKNOWN</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> UNKNOWN </td> <td class="description last"></td> </tr> </tbody> </table></dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line54">line 54</a> </li></ul></dd> </dl> </dd> </dl> <h3 class="subsection-title">Methods</h3> <dl> <dt> <h4 class="name" id="acquireToken"><span class="type-signature"></span>acquireToken<span class="signature">(resource, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Acquires token from the cache if it is not expired. Otherwise sends request to AAD to obtain a new token. </div> <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>resource</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">ResourceUri identifying the target resource</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type"><a href="global.html#tokenCallback">tokenCallback</a></span> </td> <td class="description last">The callback provided by the caller. It will be called with token or error.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line546">line 546</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="acquireTokenPopup"><span class="type-signature"></span>acquireTokenPopup<span class="signature">(resource, extraQueryParameters, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Acquires token (interactive flow using a popUp window) by sending request to AAD to obtain a new token. </div> <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>resource</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">ResourceUri identifying the target resource</td> </tr> <tr> <td class="name"><code>extraQueryParameters</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">extraQueryParameters to add to the authentication request</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type"><a href="global.html#tokenCallback">tokenCallback</a></span> </td> <td class="description last">The callback provided by the caller. It will be called with token or error.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line590">line 590</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="acquireTokenRedirect"><span class="type-signature"></span>acquireTokenRedirect<span class="signature">(resource, extraQueryParameters)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Acquires token (interactive flow using a redirect) by sending request to AAD to obtain a new token. In this case the callback passed in the Authentication request constructor will be called. </div> <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>resource</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">ResourceUri identifying the target resource</td> </tr> <tr> <td class="name"><code>extraQueryParameters</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">extraQueryParameters to add to the authentication request</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line639">line 639</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="clearCache"><span class="type-signature"></span>clearCache<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Clears cache items. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line698">line 698</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="clearCacheForResource"><span class="type-signature"></span>clearCacheForResource<span class="signature">(resource)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Clears cache items for a given resource. </div> <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>resource</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">a URI that identifies the resource.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line723">line 723</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="error"><span class="type-signature"></span>error<span class="signature">(message, error)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Logs messages when Logging Level is set to 0. </div> <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>message</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">Message to log.</td> </tr> <tr> <td class="name"><code>error</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">Error to log.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line1622">line 1622</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="getCachedToken"><span class="type-signature"></span>getCachedToken<span class="signature">(resource)</span><span class="type-signature"> → {string}</span></h4> </dt> <dd> <div class="description"> Gets token for the specified resource from the cache. </div> <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>resource</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">A URI that identifies the resource for which the token is requested.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line352">line 352</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> token if if it exists and not expired, otherwise null. </div> <dl> <dt> Type </dt> <dd> <span class="param-type">string</span> </dd> </dl> </dd> <dt> <h4 class="name" id="getCachedUser"><span class="type-signature"></span>getCachedUser<span class="signature">()</span><span class="type-signature"> → {<a href="User.html">User</a>}</span></h4> </dt> <dd> <div class="description"> If user object exists, returns it. Else creates a new user object by decoding id_token from the cache. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line383">line 383</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> user object </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="User.html">User</a></span> </dd> </dl> </dd> <dt> <h4 class="name" id="getLoginError"><span class="type-signature"></span>getLoginError<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> </dt> <dd> <div class="description"> Gets login error </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line889">line 889</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> error message related to login. </div> <dl> <dt> Type </dt> <dd> <span class="param-type">string</span> </dd> </dl> </dd> <dt> <h4 class="name" id="getRequestInfo"><span class="type-signature"></span>getRequestInfo<span class="signature">()</span><span class="type-signature"> → {<a href="RequestInfo.html">RequestInfo</a>}</span></h4> </dt> <dd> <div class="description"> Creates a requestInfo object from the URL fragment and returns it. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line907">line 907</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> an object created from the redirect response from AAD comprising of the keys - parameters, requestType, stateMatch, stateResponse and valid. </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="RequestInfo.html">RequestInfo</a></span> </dd> </dl> </dd> <dt> <h4 class="name" id="getResourceForEndpoint"><span class="type-signature"></span>getResourceForEndpoint<span class="signature">(endpoint)</span><span class="type-signature"> → {string}</span></h4> </dt> <dd> <div class="description"> Gets resource for given endpoint if mapping is provided with config. </div> <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>endpoint</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">The URI for which the resource Id is requested.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line1068">line 1068</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> resource for this API endpoint. </div> <dl> <dt> Type </dt> <dd> <span class="param-type">string</span> </dd> </dl> </dd> <dt> <h4 class="name" id="getUser"><span class="type-signature"></span>getUser<span class="signature">(callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Calls the passed in callback with the user object or error message related to the user. </div> <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>callback</code></td> <td class="type"> <span class="param-type"><a href="global.html#userCallback">userCallback</a></span> </td> <td class="description last">The callback provided by the caller. It will be called with user or error.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line777">line 777</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="handleWindowCallback"><span class="type-signature"></span>handleWindowCallback<span class="signature">(<span class="optional">hash</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> This method must be called for processing the response received from AAD. It extracts the hash, processes the token or error, saves it in the cache and calls the registered callbacks with the result. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>hash</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> window.location.hash </td> <td class="description last">Hash fragment of Url.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line1122">line 1122</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="info"><span class="type-signature"></span>info<span class="signature">(message)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Logs messages when Logging Level is set to 2. </div> <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>message</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">Message to log.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line1638">line 1638</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="isCallback"><span class="type-signature"></span>isCallback<span class="signature">(hash)</span><span class="type-signature"> → {Boolean}</span></h4> </dt> <dd> <div class="description"> Checks if the URL fragment contains access token, id token or error_description. </div> <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>hash</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">Hash passed from redirect page</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line875">line 875</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> true if response contains id_token, access_token or error, false otherwise. </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Boolean</span> </dd> </dl> </dd> <dt> <h4 class="name" id="log"><span class="type-signature"></span>log<span class="signature">(level, message, error)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Checks the Logging Level, constructs the Log message and logs it. Users need to implement/override this method to turn on Logging. </div> <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>level</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last">Level can be set 0,1,2 and 3 which turns on 'error', 'warning', 'info' or 'verbose' level logging respectively.</td> </tr> <tr> <td class="name"><code>message</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">Message to log.</td> </tr> <tr> <td class="name"><code>error</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">Error to log.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line1599">line 1599</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="login"><span class="type-signature"></span>login<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Initiates the login process by redirecting the user to Azure AD authorization endpoint. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line192">line 192</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="logOut"><span class="type-signature"></span>logOut<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Redirects user to logout endpoint. After logout, it will redirect to postLogoutRedirectUri if added as a property on the config object. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line737">line 737</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="promptUser"><span class="type-signature"></span>promptUser<span class="signature">(urlNavigate)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Redirects the browser to Azure AD authorization endpoint. </div> <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>urlNavigate</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">Url of the authorization endpoint.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line686">line 686</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="registerCallback"><span class="type-signature"></span>registerCallback<span class="signature">(resource, expectedState, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Adds the passed callback to the array of callbacks for the specified resource and puts the array on the window object. </div> <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>resource</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">A URI that identifies the resource for which the token is requested.</td> </tr> <tr> <td class="name"><code>expectedState</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">A unique identifier (guid).</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type"><a href="global.html#tokenCallback">tokenCallback</a></span> </td> <td class="description last">The callback provided by the caller. It will be called with token or error.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line399">line 399</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="saveTokenFromHash"><span class="type-signature"></span>saveTokenFromHash<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Saves token or error received in the response from AAD in the cache. In case of id_token, it also creates the user object. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line986">line 986</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="verbose"><span class="type-signature"></span>verbose<span class="signature">(message)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Logs messages when Logging Level is set to 3. </div> <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>message</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">Message to log.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line1646">line 1646</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="warn"><span class="type-signature"></span>warn<span class="signature">(message)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Logs messages when Logging Level is set to 1. </div> <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>message</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">Message to log.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line1630">line 1630</a> </li></ul></dd> </dl> </dd> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="AuthenticationContext.html">AuthenticationContext</a></li><li><a href="config.html">config</a></li><li><a href="RequestInfo.html">RequestInfo</a></li><li><a href="User.html">User</a></li></ul><h3><a href="global.html">Global</a></h3> </nav> <br clear="both"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Fri Oct 20 2017 15:19:15 GMT-0700 (PDT) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>