adal-angular
Version:
Windows Azure Active Directory Client Library for js
293 lines (101 loc) • 5.02 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: RequestInfo</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: RequestInfo</h1>
<section>
<header>
<h2>
RequestInfo
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="RequestInfo"><span class="type-signature"></span>new RequestInfo<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Request info object created from the response received from AAD.
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>parameters</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">object comprising of fields such as id_token/error, session_state, state, e.t.c.</td>
</tr>
<tr>
<td class="name"><code>requestType</code></td>
<td class="type">
<span class="param-type">REQUEST_TYPE</span>
</td>
<td class="description last">either LOGIN, RENEW_TOKEN or UNKNOWN.</td>
</tr>
<tr>
<td class="name"><code>stateMatch</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">true if state is valid, false otherwise.</td>
</tr>
<tr>
<td class="name"><code>stateResponse</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">unique guid used to match the response with the request.</td>
</tr>
<tr>
<td class="name"><code>valid</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">true if requestType contains id_token, access_token or error, false otherwise.</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#line893">line 893</a>
</li></ul></dd>
</dl>
</dd>
</div>
</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>