msal
Version:
Microsoft Authentication Library for js
840 lines • 50.9 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>UserAgentApplication | msal</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">msal</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/_useragentapplication_.html">"UserAgentApplication"</a>
</li>
<li>
<a href="_useragentapplication_.useragentapplication.html">UserAgentApplication</a>
</li>
</ul>
<h1>Class UserAgentApplication</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>UserAgentApplication class</p>
</div>
<p>Object Instance that the developer can use to make loginXX OR acquireTokenXX functions</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">UserAgentApplication</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_useragentapplication_.useragentapplication.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="_useragentapplication_.useragentapplication.html#authority" class="tsd-kind-icon">authority</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_useragentapplication_.useragentapplication.html#acquiretokenpopup" class="tsd-kind-icon">acquire<wbr>Token<wbr>Popup</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_useragentapplication_.useragentapplication.html#acquiretokenredirect" class="tsd-kind-icon">acquire<wbr>Token<wbr>Redirect</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_useragentapplication_.useragentapplication.html#acquiretokensilent" class="tsd-kind-icon">acquire<wbr>Token<wbr>Silent</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_useragentapplication_.useragentapplication.html#getaccount" class="tsd-kind-icon">get<wbr>Account</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_useragentapplication_.useragentapplication.html#getallaccounts" class="tsd-kind-icon">get<wbr>All<wbr>Accounts</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_useragentapplication_.useragentapplication.html#getauthorityinstance" class="tsd-kind-icon">get<wbr>Authority<wbr>Instance</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_useragentapplication_.useragentapplication.html#getcurrentconfiguration" class="tsd-kind-icon">get<wbr>Current<wbr>Configuration</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_useragentapplication_.useragentapplication.html#getlogininprogress" class="tsd-kind-icon">get<wbr>Login<wbr>InProgress</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_useragentapplication_.useragentapplication.html#getpostlogoutredirecturi" class="tsd-kind-icon">get<wbr>Post<wbr>Logout<wbr>Redirect<wbr>Uri</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_useragentapplication_.useragentapplication.html#getredirecturi" class="tsd-kind-icon">get<wbr>Redirect<wbr>Uri</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_useragentapplication_.useragentapplication.html#handleredirectcallback" class="tsd-kind-icon">handle<wbr>Redirect<wbr>Callback</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_useragentapplication_.useragentapplication.html#loginpopup" class="tsd-kind-icon">login<wbr>Popup</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_useragentapplication_.useragentapplication.html#loginredirect" class="tsd-kind-icon">login<wbr>Redirect</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_useragentapplication_.useragentapplication.html#logout" class="tsd-kind-icon">logout</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_useragentapplication_.useragentapplication.html#setlogger" class="tsd-kind-icon">set<wbr>Logger</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_useragentapplication_.useragentapplication.html#ssosilent" class="tsd-kind-icon">sso<wbr>Silent</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_useragentapplication_.useragentapplication.html#urlcontainshash" class="tsd-kind-icon">url<wbr>Contains<wbr>Hash</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>User<wbr>Agent<wbr>Application<span class="tsd-signature-symbol">(</span>configuration<span class="tsd-signature-symbol">: </span><a href="../modules/_configuration_.html#configuration" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_useragentapplication_.useragentapplication.html" class="tsd-signature-type">UserAgentApplication</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/UserAgentApplication.ts#L177">src/UserAgentApplication.ts:177</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>configuration: <a href="../modules/_configuration_.html#configuration" class="tsd-signature-type">Configuration</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_useragentapplication_.useragentapplication.html" class="tsd-signature-type">UserAgentApplication</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
<a name="authority" class="tsd-anchor"></a>
<h3>authority</h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> authority<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> authority<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/UserAgentApplication.ts#L166">src/UserAgentApplication.ts:166</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Method to manage the authority URL.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>authority</p>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/UserAgentApplication.ts#L157">src/UserAgentApplication.ts:157</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>setter for the authority URL</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>val: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
<p>authority</p>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="acquiretokenpopup" class="tsd-anchor"></a>
<h3>acquire<wbr>Token<wbr>Popup</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">acquire<wbr>Token<wbr>Popup<span class="tsd-signature-symbol">(</span>userRequest<span class="tsd-signature-symbol">: </span><a href="../modules/_authenticationparameters_.html#authenticationparameters" class="tsd-signature-type">AuthenticationParameters</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/_authresponse_.html#authresponse" class="tsd-signature-type">AuthResponse</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/UserAgentApplication.ts#L390">src/UserAgentApplication.ts:390</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Use when you want to obtain an access_token for your API via opening a popup window in the user's browser</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>userRequest: <a href="../modules/_authenticationparameters_.html#authenticationparameters" class="tsd-signature-type">AuthenticationParameters</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/_authresponse_.html#authresponse" class="tsd-signature-type">AuthResponse</a><span class="tsd-signature-symbol">></span></h4>
<ul>
<li>a promise that is fulfilled when this function has completed, or rejected if an error was raised. Returns the <a href="../modules/_authresponse_.html#authresponse">AuthResponse</a> object</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="acquiretokenredirect" class="tsd-anchor"></a>
<h3>acquire<wbr>Token<wbr>Redirect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">acquire<wbr>Token<wbr>Redirect<span class="tsd-signature-symbol">(</span>userRequest<span class="tsd-signature-symbol">: </span><a href="../modules/_authenticationparameters_.html#authenticationparameters" class="tsd-signature-type">AuthenticationParameters</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/UserAgentApplication.ts#L346">src/UserAgentApplication.ts:346</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Use when you want to obtain an access_token for your API by redirecting the user's browser window to the authorization endpoint.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>userRequest: <a href="../modules/_authenticationparameters_.html#authenticationparameters" class="tsd-signature-type">AuthenticationParameters</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="acquiretokensilent" class="tsd-anchor"></a>
<h3>acquire<wbr>Token<wbr>Silent</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">acquire<wbr>Token<wbr>Silent<span class="tsd-signature-symbol">(</span>userRequest<span class="tsd-signature-symbol">: </span><a href="../modules/_authenticationparameters_.html#authenticationparameters" class="tsd-signature-type">AuthenticationParameters</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/_authresponse_.html#authresponse" class="tsd-signature-type">AuthResponse</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/UserAgentApplication.ts#L694">src/UserAgentApplication.ts:694</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Use this function to obtain a token before every call to the API / resource provider</p>
</div>
<p>MSAL return's a cached token when available
Or it send's a request to the STS to obtain a new token using a hidden iframe.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>userRequest: <a href="../modules/_authenticationparameters_.html#authenticationparameters" class="tsd-signature-type">AuthenticationParameters</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/_authresponse_.html#authresponse" class="tsd-signature-type">AuthResponse</a><span class="tsd-signature-symbol">></span></h4>
<ul>
<li>a promise that is fulfilled when this function has completed, or rejected if an error was raised. Returns the <a href="../modules/_authresponse_.html#authresponse">AuthResponse</a> object</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getaccount" class="tsd-anchor"></a>
<h3>get<wbr>Account</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_account_.account.html" class="tsd-signature-type">Account</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/UserAgentApplication.ts#L1996">src/UserAgentApplication.ts:1996</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the signed in account
(the account object is created at the time of successful login)
or null when no state is found</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="_account_.account.html" class="tsd-signature-type">Account</a></h4>
<p><a href="_account_.account.html">Account</a> - the account object stored in MSAL</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getallaccounts" class="tsd-anchor"></a>
<h3>get<wbr>All<wbr>Accounts</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>All<wbr>Accounts<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="_account_.account.html" class="tsd-signature-type">Account</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/UserAgentApplication.ts#L2038">src/UserAgentApplication.ts:2038</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Use to get a list of unique accounts in MSAL cache based on homeAccountIdentifier.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="_account_.account.html" class="tsd-signature-type">Account</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getauthorityinstance" class="tsd-anchor"></a>
<h3>get<wbr>Authority<wbr>Instance</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Authority<wbr>Instance<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Authority</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/UserAgentApplication.ts#L175">src/UserAgentApplication.ts:175</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the current authority instance from the MSAL configuration object</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Authority</span></h4>
<p>{@link Authority} authority instance</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getcurrentconfiguration" class="tsd-anchor"></a>
<h3>get<wbr>Current<wbr>Configuration</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Current<wbr>Configuration<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_configuration_.html#configuration" class="tsd-signature-type">Configuration</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/UserAgentApplication.ts#L2284">src/UserAgentApplication.ts:2284</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Use to get the current <a href="../modules/_configuration_.html#configuration">Configuration</a> object in MSAL</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="../modules/_configuration_.html#configuration" class="tsd-signature-type">Configuration</a></h4>
<p><a href="../modules/_configuration_.html#configuration">Configuration</a></p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getlogininprogress" class="tsd-anchor"></a>
<h3>get<wbr>Login<wbr>InProgress</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Login<wbr>InProgress<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/UserAgentApplication.ts#L2180">src/UserAgentApplication.ts:2180</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Return boolean flag to developer to help inform if login is in progress</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>true/false</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getpostlogoutredirecturi" class="tsd-anchor"></a>
<h3>get<wbr>Post<wbr>Logout<wbr>Redirect<wbr>Uri</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Post<wbr>Logout<wbr>Redirect<wbr>Uri<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/UserAgentApplication.ts#L2272">src/UserAgentApplication.ts:2272</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Use to get the post logout redirect uri configured in MSAL or null.
Evaluates postLogoutredirectUri if its a function, otherwise simply returns its value.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>post logout redirect URL</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getredirecturi" class="tsd-anchor"></a>
<h3>get<wbr>Redirect<wbr>Uri</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Redirect<wbr>Uri<span class="tsd-signature-symbol">(</span>reqRedirectUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/UserAgentApplication.ts#L2256">src/UserAgentApplication.ts:2256</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Use to get the redirect uri configured in MSAL or null.
Evaluates redirectUri if its a function, otherwise simply returns its value.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> reqRedirectUri: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>redirect URL</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="handleredirectcallback" class="tsd-anchor"></a>
<h3>handle<wbr>Redirect<wbr>Callback</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">handle<wbr>Redirect<wbr>Callback<span class="tsd-signature-symbol">(</span>authCallback<span class="tsd-signature-symbol">: </span><a href="../modules/_useragentapplication_.html#authresponsecallback" class="tsd-signature-type">authResponseCallback</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/UserAgentApplication.ts#L251">src/UserAgentApplication.ts:251</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>authCallback: <a href="../modules/_useragentapplication_.html#authresponsecallback" class="tsd-signature-type">authResponseCallback</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="loginpopup" class="tsd-anchor"></a>
<h3>login<wbr>Popup</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">login<wbr>Popup<span class="tsd-signature-symbol">(</span>userRequest<span class="tsd-signature-symbol">?: </span><a href="../modules/_authenticationparameters_.html#authenticationparameters" class="tsd-signature-type">AuthenticationParameters</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/_authresponse_.html#authresponse" class="tsd-signature-type">AuthResponse</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/UserAgentApplication.ts#L361">src/UserAgentApplication.ts:361</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Use when initiating the login process via opening a popup window in the user's browser</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> userRequest: <a href="../modules/_authenticationparameters_.html#authenticationparameters" class="tsd-signature-type">AuthenticationParameters</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/_authresponse_.html#authresponse" class="tsd-signature-type">AuthResponse</a><span class="tsd-signature-symbol">></span></h4>
<ul>
<li>a promise that is fulfilled when this function has completed, or rejected if an error was raised. Returns the <a href="../modules/_authresponse_.html#authresponse">AuthResponse</a> object</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="loginredirect" class="tsd-anchor"></a>
<h3>login<wbr>Redirect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">login<wbr>Redirect<span class="tsd-signature-symbol">(</span>userRequest<span class="tsd-signature-symbol">?: </span><a href="../modules/_authenticationparameters_.html#authenticationparameters" class="tsd-signature-type">AuthenticationParameters</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/UserAgentApplication.ts#L332">src/UserAgentApplication.ts:332</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Use when initiating the login process by redirecting the user's browser to the authorization endpoint.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> userRequest: <a href="../modules/_authenticationparameters_.html#authenticationparameters" class="tsd-signature-type">AuthenticationParameters</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="logout" class="tsd-anchor"></a>
<h3>logout</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">logout<span class="tsd-signature-symbol">(</span>correlationId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/UserAgentApplication.ts#L1036">src/UserAgentApplication.ts:1036</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Use to log out the current user, and redirect the user to the postLogoutRedirectUri.
Default behaviour is to redirect the user to <code>window.location.href</code>.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> correlationId: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="setlogger" class="tsd-anchor"></a>
<h3>set<wbr>Logger</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Logger<span class="tsd-signature-symbol">(</span>logger<span class="tsd-signature-symbol">: </span><a href="_logger_.logger.html" class="tsd-signature-type">Logger</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/UserAgentApplication.ts#L2242">src/UserAgentApplication.ts:2242</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sets the logger callback.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>logger: <a href="_logger_.logger.html" class="tsd-signature-type">Logger</a></h5>
<div class="tsd-comment tsd-typography">
<p>Logger callback</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="ssosilent" class="tsd-anchor"></a>
<h3>sso<wbr>Silent</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">sso<wbr>Silent<span class="tsd-signature-symbol">(</span>request<span class="tsd-signature-symbol">: </span><a href="../modules/_authenticationparameters_.html#authenticationparameters" class="tsd-signature-type">AuthenticationParameters</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/_authresponse_.html#authresponse" class="tsd-signature-type">AuthResponse</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/UserAgentApplication.ts#L663">src/UserAgentApplication.ts:663</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>API interfacing idToken request when applications already have a session/hint acquired by authorization client applications</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>request: <a href="../modules/_authenticationparameters_.html#authenticationparameters" class="tsd-signature-type">AuthenticationParameters</a></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/_authresponse_.html#authresponse" class="tsd-signature-type">AuthResponse</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="urlcontainshash" class="tsd-anchor"></a>
<h3>url<wbr>Contains<wbr>Hash</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">url<wbr>Contains<wbr>Hash<span class="tsd-signature-symbol">(</span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/UserAgentApplication.ts#L277">src/UserAgentApplication.ts:277</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Public API to verify if the URL contains the hash with known properties</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>hash: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class="current tsd-kind-external-module">
<a href="../modules/_useragentapplication_.html">"<wbr>User<wbr>Agent<wbr>Application"</a>
<ul>
<li class=" tsd-kind-module tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_useragentapplication_.__global.html">__global</a>
</li>
</ul>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-external-module">
<a href="_useragentapplication_.useragentapplication.html" class="tsd-kind-icon">User<wbr>Agent<wbr>Application</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="_useragentapplication_.useragentapplication.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-accessor tsd-parent-kind-class">
<a href="_useragentapplication_.useragentapplication.html#authority" class="tsd-kind-icon">authority</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_useragentapplication_.useragentapplication.html#acquiretokenpopup" class="tsd-kind-icon">acquire<wbr>Token<wbr>Popup</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_useragentapplication_.useragentapplication.html#acquiretokenredirect" class="tsd-kind-icon">acquire<wbr>Token<wbr>Redirect</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_useragentapplication_.useragentapplication.html#acquiretokensilent" class="tsd-kind-icon">acquire<wbr>Token<wbr>Silent</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_useragentapplication_.useragentapplication.html#getaccount" class="tsd-kind-icon">get<wbr>Account</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_useragentapplication_.useragentapplication.html#getallaccounts" class="tsd-kind-icon">get<wbr>All<wbr>Accounts</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_useragentapplication_.useragentapplication.html#getauthorityinstance" class="tsd-kind-icon">get<wbr>Authority<wbr>Instance</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_useragentapplication_.useragentapplication.html#getcurrentconfiguration" class="tsd-kind-icon">get<wbr>Current<wbr>Configuration</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_useragentapplication_.useragentapplication.html#getlogininprogress" class="tsd-kind-icon">get<wbr>Login<wbr>InProgress</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_useragentapplication_.useragentapplication.html#getpostlogoutredirecturi" class="tsd-kind-icon">get<wbr>Post<wbr>Logout<wbr>Redirect<wbr>Uri</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_useragentapplication_.useragentapplication.html#getredirecturi" class="tsd-kind-icon">get<wbr>Redirect<wbr>Uri</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_useragentapplication_.useragentapplication.html#handleredirectcallback" class="tsd-kind-icon">handle<wbr>Redirect<wbr>Callback</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_useragentapplication_.useragentapplication.html#loginpopup" class="tsd-kind-icon">login<wbr>Popup</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_useragentapplication_.useragentapplication.html#loginredirect" class="tsd-kind-icon">login<wbr>Redirect</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_useragentapplication_.useragentapplication.html#logout" class="tsd-kind-icon">logout</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_useragentapplication_.useragentapplication.html#setlogger" class="tsd-kind-icon">set<wbr>Logger</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_useragentapplication_.useragentapplication.html#ssosilent" class="tsd-kind-icon">sso<wbr>Silent</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_useragentapplication_.useragentapplication.html#urlcontainshash" class="tsd-kind-icon">url<wbr>Contains<wbr>Hash</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="../modules/_useragentapplication_.html#authresponsecallback" class="tsd-kind-icon">auth<wbr>Response<wbr>Callback</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="../modules/_useragentapplication_.html#errorreceivedcallback" class="tsd-kind-icon">error<wbr>Received<wbr>Callback</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="../modules/_useragentapplication_.html#tokenreceivedcallback" class="tsd-kind-icon">token<wbr>Received<wbr>Callback</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_useragentapplication_.html#default_authority" class="tsd-kind-icon">DEFAULT_<wbr>AUTHORITY</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>