@loopback/docs
Version:
Documentation for LoopBack 4
2,024 lines (1,306 loc) • 45.2 kB
HTML
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js"> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title></title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="css/bootstrap.min.css">
<link rel="stylesheet" href="css/code-themes/sl-theme.css">
<link rel="stylesheet" href="css/main.css">
</head>
<body>
<div class="navbar navbar-inverse navbar-static-top" role="navigation">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/">docs.strongloop.com</a>
</div>
<div id="modules"></div>
</div>
<div class="row">
<div class="col-lg-3 column scroll-spy-target">
<ul class="nav nav-pills nav-stacked">
<div id="versions"></div>
<li class="depth-3">
<a href="#AuthenticationComponent">Class: AuthenticationComponent</a>
</li>
<li class="depth-4">
<a href="#112">constructor</a>
</li>
<li class="depth-3">
<a href="#AuthenticationMetadata">Interface: AuthenticationMetadata</a>
</li>
<li class="depth-3">
<a href="#80">Function: authenticate</a>
</li>
<li class="depth-3">
<a href="#90">Function: getAuthenticateMetadata</a>
</li>
<li class="depth-3">
<a href="#AuthMetadataProvider">Class: AuthMetadataProvider</a>
</li>
<li class="depth-4">
<a href="#103">constructor</a>
</li>
<li class="depth-4">
<a href="#107">value</a>
</li>
<li class="depth-3">
<a href="#AuthenticateActionProvider">Class: AuthenticateActionProvider</a>
</li>
<li class="depth-4">
<a href="#64">constructor</a>
</li>
<li class="depth-4">
<a href="#72">action</a>
</li>
<li class="depth-4">
<a href="#70">value</a>
</li>
<li class="depth-3">
<a href="#AuthenticateFn">Interface: AuthenticateFn</a>
</li>
<li class="depth-3">
<a href="#UserProfile">Interface: UserProfile</a>
</li>
<li class="depth-3">
<a href="#PassportRequest">Type alias: PassportRequest</a>
</li>
<li class="depth-3">
<a href="#ShimRequest">Class: ShimRequest</a>
</li>
<li class="depth-4">
<a href="#8">constructor</a>
</li>
<li class="depth-4">
<a href="#43">isAuthenticated</a>
</li>
<li class="depth-4">
<a href="#45">isUnauthenticated</a>
</li>
<li class="depth-4">
<a href="#25">logIn</a>
</li>
<li class="depth-4">
<a href="#41">logOut</a>
</li>
<li class="depth-4">
<a href="#11">login</a>
</li>
<li class="depth-4">
<a href="#39">logout</a>
</li>
<li class="depth-3">
<a href="#StrategyAdapter">Class: StrategyAdapter</a>
</li>
<li class="depth-4">
<a href="#48">constructor</a>
</li>
<li class="depth-4">
<a href="#51">authenticate</a>
</li>
</ul>
</div>
<div class="col-lg-9 col-lg-offset-3 column" data-spy="scroll" data-target=".scroll-spy-target" data-offset="0">
<div class="readability">
<section class="code-doc ">
<a name="AuthenticationComponent"></a>
<h3 class="code-ref">Class: authenticationcomponent = new AuthenticationComponent()</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</section>
<section class="code-doc">
<div class="code-arguments-hdr">Properties</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">providers</strong>
</td>
<td class="code-arg-types">
<code><a href="#ProviderMap">ProviderMap</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="112"></a>
<h4 class="code-ref">constructor() : AuthenticationComponent</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</section>
<section class="code-doc ">
<a name="AuthenticationMetadata"></a>
<h3 class="code-ref">Interface: AuthenticationMetadata</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Authentication metadata stored via Reflection API</p>
</p>
<p></p>
</div>
</section>
<section class="code-doc">
<div class="code-arguments-hdr">Properties</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">options</strong>
</td>
<td class="code-arg-types">
<code><a href="#Object">Object</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Authentication metadata stored via Reflection API</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">strategy</strong>
</td>
<td class="code-arg-types">
<code>string</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Authentication metadata stored via Reflection API</p>
</p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="80"></a>
<h3 class="code-ref">Function: authenticate</h3>
<section class="code-doc ">
<a name="80"></a>
<h4 class="code-ref">authenticate(strategyName: string, options: <a href="#Object">Object</a>) : </h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Mark a controller method as requiring authenticated user.</p>
</p>
<p></p>
</div>
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">strategyName</strong>
</td>
<td class="code-arg-types">
<code>string</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>The name of the authentication strategy to use.</p>
</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">options</strong>
</td>
<td class="code-arg-types">
<code><a href="#Object">Object</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Additional options to configure the authentication.</p>
</p>
</div>
</td>
</tr>
</table>
</section>
</section>
<section class="code-doc ">
<a name="90"></a>
<h3 class="code-ref">Function: getAuthenticateMetadata</h3>
<section class="code-doc ">
<a name="90"></a>
<h4 class="code-ref">getAuthenticateMetadata(controllerClass: <a href="#Constructor">Constructor</a>, methodName: string) : <a href="#AuthenticationMetadata">AuthenticationMetadata</a> | undefined</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Fetch authentication metadata stored by <code>@authenticate</code> decorator.</p>
</p>
<p></p>
</div>
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">controllerClass</strong>
</td>
<td class="code-arg-types">
<code><a href="#Constructor">Constructor</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Target controller</p>
</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">methodName</strong>
</td>
<td class="code-arg-types">
<code>string</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Target method</p>
</p>
</div>
</td>
</tr>
</table>
</section>
</section>
<section class="code-doc ">
<a name="AuthMetadataProvider"></a>
<h3 class="code-ref">Class: authmetadataprovider = new AuthMetadataProvider()</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p></p>
</div>
</section>
<section class="code-doc ">
<a name="103"></a>
<h4 class="code-ref">constructor(controllerClass: <a href="#Constructor">Constructor</a>, methodName: string) : AuthMetadataProvider</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">controllerClass</strong>
</td>
<td class="code-arg-types">
<code><a href="#Constructor">Constructor</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">methodName</strong>
</td>
<td class="code-arg-types">
<code>string</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="107"></a>
<h4 class="code-ref">value() : <a href="#AuthenticationMetadata">AuthenticationMetadata</a> | undefined</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p></p>
</div>
Returns: <p><p>AuthenticationMetadata</p>
</p>
</section>
<section class="code-doc ">
<a name="AuthenticateActionProvider"></a>
<h3 class="code-ref">Class: authenticateactionprovider = new AuthenticateActionProvider()</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p></p>
</div>
</section>
<section class="code-doc">
<div class="code-arguments-hdr">Properties</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">getStrategy</strong>
</td>
<td class="code-arg-types">
<code><a href="#Getter">Getter</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">setCurrentUser</strong>
</td>
<td class="code-arg-types">
<code><a href="#Setter">Setter</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="64"></a>
<h4 class="code-ref">constructor(getStrategy: <a href="#Getter">Getter</a>, setCurrentUser: <a href="#Setter">Setter</a>) : AuthenticateActionProvider</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">getStrategy</strong>
</td>
<td class="code-arg-types">
<code><a href="#Getter">Getter</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">setCurrentUser</strong>
</td>
<td class="code-arg-types">
<code><a href="#Setter">Setter</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="72"></a>
<h4 class="code-ref">action(request: <a href="#ParsedRequest">ParsedRequest</a>) : Promise</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>The implementation of authenticate() sequence action.</p>
</p>
<p></p>
</div>
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">request</strong>
</td>
<td class="code-arg-types">
<code><a href="#ParsedRequest">ParsedRequest</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Parsed Request</p>
</p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="70"></a>
<h4 class="code-ref">value() : AuthenticateFn</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p></p>
</div>
Returns: <p><p>authenticateFn</p>
</p>
</section>
<section class="code-doc ">
<a name="AuthenticateFn"></a>
<h3 class="code-ref">Interface: AuthenticateFn</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>interface definition of a function which accepts a request
and returns an authenticated user</p>
</p>
<p></p>
</div>
</section>
<section class="code-doc ">
<a name="UserProfile"></a>
<h3 class="code-ref">Interface: UserProfile</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>interface definition of a user profile
<a href="http://openid.net/specs/openid-connect-core-1_0.html#StandardClaims">http://openid.net/specs/openid-connect-core-1_0.html#StandardClaims</a></p>
</p>
<p></p>
</div>
</section>
<section class="code-doc">
<div class="code-arguments-hdr">Properties</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">email</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>interface definition of a user profile
<a href="http://openid.net/specs/openid-connect-core-1_0.html#StandardClaims">http://openid.net/specs/openid-connect-core-1_0.html#StandardClaims</a></p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">id</strong>
</td>
<td class="code-arg-types">
<code>string</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>interface definition of a user profile
<a href="http://openid.net/specs/openid-connect-core-1_0.html#StandardClaims">http://openid.net/specs/openid-connect-core-1_0.html#StandardClaims</a></p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">name</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>interface definition of a user profile
<a href="http://openid.net/specs/openid-connect-core-1_0.html#StandardClaims">http://openid.net/specs/openid-connect-core-1_0.html#StandardClaims</a></p>
</p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="ShimRequest"></a>
<h3 class="code-ref">Class: shimrequest = new ShimRequest()</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Shimmed Request to satisfy express requirements of passport strategies.</p>
</p>
<p></p>
</div>
</section>
<section class="code-doc">
<div class="code-arguments-hdr">Properties</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">headers</strong>
</td>
<td class="code-arg-types">
<code><a href="#Object">Object</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Shimmed Request to satisfy express requirements of passport strategies.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">method</strong>
</td>
<td class="code-arg-types">
<code>string</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Shimmed Request to satisfy express requirements of passport strategies.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">path</strong>
</td>
<td class="code-arg-types">
<code>string</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Shimmed Request to satisfy express requirements of passport strategies.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">query</strong>
</td>
<td class="code-arg-types">
<code><a href="#Object">Object</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Shimmed Request to satisfy express requirements of passport strategies.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">url</strong>
</td>
<td class="code-arg-types">
<code>string</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Shimmed Request to satisfy express requirements of passport strategies.</p>
</p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="8"></a>
<h4 class="code-ref">constructor(request: <a href="#ParsedRequest">ParsedRequest</a>) : ShimRequest</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">request</strong>
</td>
<td class="code-arg-types">
<code><a href="#ParsedRequest">ParsedRequest</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Shimmed Request to satisfy express requirements of passport strategies.</p>
</p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="43"></a>
<h4 class="code-ref">isAuthenticated() : boolean</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</section>
<section class="code-doc ">
<a name="45"></a>
<h4 class="code-ref">isUnauthenticated() : boolean</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</section>
<section class="code-doc ">
<a name="25"></a>
<h4 class="code-ref">logIn(user: any, done: (err: any) => void) : void</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">user</strong>
</td>
<td class="code-arg-types">
<code>any</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Shimmed Request to satisfy express requirements of passport strategies.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">done</strong>
</td>
<td class="code-arg-types">
<code>Function</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Shimmed Request to satisfy express requirements of passport strategies.</p>
</p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="25"></a>
<h4 class="code-ref">logIn(user: any, options: any, done: (err: any) => void) : void</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">user</strong>
</td>
<td class="code-arg-types">
<code>any</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Shimmed Request to satisfy express requirements of passport strategies.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">options</strong>
</td>
<td class="code-arg-types">
<code>any</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Shimmed Request to satisfy express requirements of passport strategies.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">done</strong>
</td>
<td class="code-arg-types">
<code>Function</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Shimmed Request to satisfy express requirements of passport strategies.</p>
</p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="41"></a>
<h4 class="code-ref">logOut() : void</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</section>
<section class="code-doc ">
<a name="11"></a>
<h4 class="code-ref">login(user: any, done: (err: any) => void) : void</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">user</strong>
</td>
<td class="code-arg-types">
<code>any</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Shimmed Request to satisfy express requirements of passport strategies.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">done</strong>
</td>
<td class="code-arg-types">
<code>Function</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Shimmed Request to satisfy express requirements of passport strategies.</p>
</p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="11"></a>
<h4 class="code-ref">login(user: any, options: any, done: (err: any) => void) : void</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">user</strong>
</td>
<td class="code-arg-types">
<code>any</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Shimmed Request to satisfy express requirements of passport strategies.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">options</strong>
</td>
<td class="code-arg-types">
<code>any</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Shimmed Request to satisfy express requirements of passport strategies.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">done</strong>
</td>
<td class="code-arg-types">
<code>Function</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Shimmed Request to satisfy express requirements of passport strategies.</p>
</p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="39"></a>
<h4 class="code-ref">logout() : void</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</section>
<section class="code-doc ">
<a name="StrategyAdapter"></a>
<h3 class="code-ref">Class: strategyadapter = new StrategyAdapter()</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Adapter class to invoke passport-strategy</p>
<ol>
<li>provides express dependencies to the passport strategies</li>
<li>provides shimming of requests for passport authentication</li>
<li>provides lifecycle similar to express to the passport-strategy</li>
<li>provides state methods to the strategy instance
see: <a href="https://github.com/jaredhanson/passport">https://github.com/jaredhanson/passport</a></li>
</ol>
</p>
<p></p>
</div>
</section>
<section class="code-doc ">
<a name="48"></a>
<h4 class="code-ref">constructor(strategy: <a href="#Strategy">Strategy</a>) : StrategyAdapter</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p></p>
</div>
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">strategy</strong>
</td>
<td class="code-arg-types">
<code><a href="#Strategy">Strategy</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>instance of a class which implements a passport-strategy;</p>
</p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="51"></a>
<h4 class="code-ref">authenticate(req: <a href="#ParsedRequest">ParsedRequest</a>) : Promise</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p><p>The function to invoke the contained passport strategy.</p></p>
<pre><code>1. Create an<span class="hljs-built_in"> instance </span>of the strategy
2. <span class="hljs-builtin-name">add</span> success <span class="hljs-keyword">and</span> failure state handlers
3. authenticate using the strategy
</code></pre></p>
<p></p>
</div>
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">req</strong>
</td>
<td class="code-arg-types">
<code><a href="#ParsedRequest">ParsedRequest</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>The incoming request.</p>
</p>
</div>
</td>
</tr>
</table>
</section>
</div>
<div class="intentionally-left-blank"></div>
</div>
</div>
<script src="js/vendor/jquery-1.10.1.min.js"></script>
<script src="js/vendor/jquery.scrollTo-1.4.3.1.js"></script>
<script src="js/vendor/bootstrap.min.js"></script>
<script src="js/main.js"></script>
</body>
</html>