UNPKG

msal

Version:
344 lines 20.9 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>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> </ul> <h1> msal</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <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>External modules</h3> <ul class="tsd-index-list"> <li class="tsd-kind-external-module"><a href="modules/_aadauthority_.html" class="tsd-kind-icon">"<wbr>Aad<wbr>Authority"</a></li> <li class="tsd-kind-external-module"><a href="modules/_accesstokencacheitem_.html" class="tsd-kind-icon">"<wbr>Access<wbr>Token<wbr>Cache<wbr>Item"</a></li> <li class="tsd-kind-external-module"><a href="modules/_accesstokenkey_.html" class="tsd-kind-icon">"<wbr>Access<wbr>Token<wbr>Key"</a></li> <li class="tsd-kind-external-module"><a href="modules/_accesstokenvalue_.html" class="tsd-kind-icon">"<wbr>Access<wbr>Token<wbr>Value"</a></li> <li class="tsd-kind-external-module"><a href="modules/_account_.html" class="tsd-kind-icon">"<wbr>Account"</a></li> <li class="tsd-kind-external-module"><a href="modules/_authresponse_.html" class="tsd-kind-icon">"<wbr>Auth<wbr>Response"</a></li> <li class="tsd-kind-external-module"><a href="modules/_authenticationparameters_.html" class="tsd-kind-icon">"<wbr>Authentication<wbr>Parameters"</a></li> <li class="tsd-kind-external-module"><a href="modules/_authority_.html" class="tsd-kind-icon">"<wbr>Authority"</a></li> <li class="tsd-kind-external-module"><a href="modules/_authorityfactory_.html" class="tsd-kind-icon">"<wbr>Authority<wbr>Factory"</a></li> <li class="tsd-kind-external-module"><a href="modules/_b2cauthority_.html" class="tsd-kind-icon">"<wbr>B2c<wbr>Authority"</a></li> <li class="tsd-kind-external-module"><a href="modules/_clientinfo_.html" class="tsd-kind-icon">"<wbr>Client<wbr>Info"</a></li> <li class="tsd-kind-external-module"><a href="modules/_configuration_.html" class="tsd-kind-icon">"<wbr>Configuration"</a></li> <li class="tsd-kind-external-module"><a href="modules/_iinstancediscoveryresponse_.html" class="tsd-kind-icon">"IInstance<wbr>Discovery<wbr>Response"</a></li> <li class="tsd-kind-external-module"><a href="modules/_itenantdiscoveryresponse_.html" class="tsd-kind-icon">"ITenant<wbr>Discovery<wbr>Response"</a></li> <li class="tsd-kind-external-module"><a href="modules/_iuri_.html" class="tsd-kind-icon">"IUri"</a></li> <li class="tsd-kind-external-module"><a href="modules/_idtoken_.html" class="tsd-kind-icon">"<wbr>IdToken"</a></li> <li class="tsd-kind-external-module"><a href="modules/_logger_.html" class="tsd-kind-icon">"<wbr>Logger"</a></li> <li class="tsd-kind-external-module"><a href="modules/_msaltypes_.html" class="tsd-kind-icon">"<wbr>Msal<wbr>Types"</a></li> <li class="tsd-kind-external-module"><a href="modules/_scopeset_.html" class="tsd-kind-icon">"<wbr>Scope<wbr>Set"</a></li> <li class="tsd-kind-external-module"><a href="modules/_serverrequestparameters_.html" class="tsd-kind-icon">"<wbr>Server<wbr>Request<wbr>Parameters"</a></li> <li class="tsd-kind-external-module"><a href="modules/_storage_.html" class="tsd-kind-icon">"<wbr>Storage"</a></li> <li class="tsd-kind-external-module"><a href="modules/_useragentapplication_.html" class="tsd-kind-icon">"<wbr>User<wbr>Agent<wbr>Application"</a></li> <li class="tsd-kind-external-module"><a href="modules/_xhrclient_.html" class="tsd-kind-icon">"XHRClient"</a></li> <li class="tsd-kind-external-module"><a href="modules/_error_autherror_.html" class="tsd-kind-icon">"error/<wbr>Auth<wbr>Error"</a></li> <li class="tsd-kind-external-module"><a href="modules/_error_clientautherror_.html" class="tsd-kind-icon">"error/<wbr>Client<wbr>Auth<wbr>Error"</a></li> <li class="tsd-kind-external-module"><a href="modules/_error_clientconfigurationerror_.html" class="tsd-kind-icon">"error/<wbr>Client<wbr>Configuration<wbr>Error"</a></li> <li class="tsd-kind-external-module"><a href="modules/_error_interactionrequiredautherror_.html" class="tsd-kind-icon">"error/<wbr>Interaction<wbr>Required<wbr>Auth<wbr>Error"</a></li> <li class="tsd-kind-external-module"><a href="modules/_error_servererror_.html" class="tsd-kind-icon">"error/<wbr>Server<wbr>Error"</a></li> <li class="tsd-kind-external-module"><a href="modules/_index_.html" class="tsd-kind-icon">"index"</a></li> <li class="tsd-kind-external-module"><a href="modules/_telemetry_apievent_.html" class="tsd-kind-icon">"telemetry/<wbr>Api<wbr>Event"</a></li> <li class="tsd-kind-external-module"><a href="modules/_telemetry_cacheevent_.html" class="tsd-kind-icon">"telemetry/<wbr>Cache<wbr>Event"</a></li> <li class="tsd-kind-external-module"><a href="modules/_telemetry_defaultevent_.html" class="tsd-kind-icon">"telemetry/<wbr>Default<wbr>Event"</a></li> <li class="tsd-kind-external-module"><a href="modules/_telemetry_httpevent_.html" class="tsd-kind-icon">"telemetry/<wbr>Http<wbr>Event"</a></li> <li class="tsd-kind-external-module"><a href="modules/_telemetry_telemetryconstants_.html" class="tsd-kind-icon">"telemetry/<wbr>Telemetry<wbr>Constants"</a></li> <li class="tsd-kind-external-module"><a href="modules/_telemetry_telemetryevent_.html" class="tsd-kind-icon">"telemetry/<wbr>Telemetry<wbr>Event"</a></li> <li class="tsd-kind-external-module"><a href="modules/_telemetry_telemetrymanager_.html" class="tsd-kind-icon">"telemetry/<wbr>Telemetry<wbr>Manager"</a></li> <li class="tsd-kind-external-module"><a href="modules/_telemetry_telemetrytypes_.html" class="tsd-kind-icon">"telemetry/<wbr>Telemetry<wbr>Types"</a></li> <li class="tsd-kind-external-module"><a href="modules/_telemetry_telemetryutils_.html" class="tsd-kind-icon">"telemetry/<wbr>Telemetry<wbr>Utils"</a></li> <li class="tsd-kind-external-module"><a href="modules/_telemetry_uievent_.html" class="tsd-kind-icon">"telemetry/<wbr>UiEvent"</a></li> <li class="tsd-kind-external-module"><a href="modules/_utils_constants_.html" class="tsd-kind-icon">"utils/<wbr>Constants"</a></li> <li class="tsd-kind-external-module"><a href="modules/_utils_cryptoutils_.html" class="tsd-kind-icon">"utils/<wbr>Crypto<wbr>Utils"</a></li> <li class="tsd-kind-external-module"><a href="modules/_utils_responseutils_.html" class="tsd-kind-icon">"utils/<wbr>Response<wbr>Utils"</a></li> <li class="tsd-kind-external-module"><a href="modules/_utils_stringutils_.html" class="tsd-kind-icon">"utils/<wbr>String<wbr>Utils"</a></li> <li class="tsd-kind-external-module"><a href="modules/_utils_timeutils_.html" class="tsd-kind-icon">"utils/<wbr>Time<wbr>Utils"</a></li> <li class="tsd-kind-external-module"><a href="modules/_utils_tokenutils_.html" class="tsd-kind-icon">"utils/<wbr>Token<wbr>Utils"</a></li> <li class="tsd-kind-external-module"><a href="modules/_utils_urlutils_.html" class="tsd-kind-icon">"utils/<wbr>Url<wbr>Utils"</a></li> </ul> </section> </div> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals current "> <a href="globals.html"><em>Globals</em></a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_aadauthority_.html">"<wbr>Aad<wbr>Authority"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_accesstokencacheitem_.html">"<wbr>Access<wbr>Token<wbr>Cache<wbr>Item"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_accesstokenkey_.html">"<wbr>Access<wbr>Token<wbr>Key"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_accesstokenvalue_.html">"<wbr>Access<wbr>Token<wbr>Value"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_account_.html">"<wbr>Account"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_authresponse_.html">"<wbr>Auth<wbr>Response"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_authenticationparameters_.html">"<wbr>Authentication<wbr>Parameters"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_authority_.html">"<wbr>Authority"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_authorityfactory_.html">"<wbr>Authority<wbr>Factory"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_b2cauthority_.html">"<wbr>B2c<wbr>Authority"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_clientinfo_.html">"<wbr>Client<wbr>Info"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_configuration_.html">"<wbr>Configuration"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_iinstancediscoveryresponse_.html">"IInstance<wbr>Discovery<wbr>Response"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_itenantdiscoveryresponse_.html">"ITenant<wbr>Discovery<wbr>Response"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_iuri_.html">"IUri"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_idtoken_.html">"<wbr>IdToken"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_logger_.html">"<wbr>Logger"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_msaltypes_.html">"<wbr>Msal<wbr>Types"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_scopeset_.html">"<wbr>Scope<wbr>Set"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_serverrequestparameters_.html">"<wbr>Server<wbr>Request<wbr>Parameters"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_storage_.html">"<wbr>Storage"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_useragentapplication_.html">"<wbr>User<wbr>Agent<wbr>Application"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_xhrclient_.html">"XHRClient"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_error_autherror_.html">"error/<wbr>Auth<wbr>Error"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_error_clientautherror_.html">"error/<wbr>Client<wbr>Auth<wbr>Error"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_error_clientconfigurationerror_.html">"error/<wbr>Client<wbr>Configuration<wbr>Error"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_error_interactionrequiredautherror_.html">"error/<wbr>Interaction<wbr>Required<wbr>Auth<wbr>Error"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_error_servererror_.html">"error/<wbr>Server<wbr>Error"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_index_.html">"index"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_telemetry_apievent_.html">"telemetry/<wbr>Api<wbr>Event"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_telemetry_cacheevent_.html">"telemetry/<wbr>Cache<wbr>Event"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_telemetry_defaultevent_.html">"telemetry/<wbr>Default<wbr>Event"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_telemetry_httpevent_.html">"telemetry/<wbr>Http<wbr>Event"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_telemetry_telemetryconstants_.html">"telemetry/<wbr>Telemetry<wbr>Constants"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_telemetry_telemetryevent_.html">"telemetry/<wbr>Telemetry<wbr>Event"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_telemetry_telemetrymanager_.html">"telemetry/<wbr>Telemetry<wbr>Manager"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_telemetry_telemetrytypes_.html">"telemetry/<wbr>Telemetry<wbr>Types"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_telemetry_telemetryutils_.html">"telemetry/<wbr>Telemetry<wbr>Utils"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_telemetry_uievent_.html">"telemetry/<wbr>UiEvent"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_utils_constants_.html">"utils/<wbr>Constants"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_utils_cryptoutils_.html">"utils/<wbr>Crypto<wbr>Utils"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_utils_responseutils_.html">"utils/<wbr>Response<wbr>Utils"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_utils_stringutils_.html">"utils/<wbr>String<wbr>Utils"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_utils_timeutils_.html">"utils/<wbr>Time<wbr>Utils"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_utils_tokenutils_.html">"utils/<wbr>Token<wbr>Utils"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_utils_urlutils_.html">"utils/<wbr>Url<wbr>Utils"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </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> </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="http://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>