Skip to content

Commit f653434

Browse files
author
Eric Koleda
committed
Regenerate documentation.
1 parent 525c4f6 commit f653434

File tree

4 files changed

+1233
-6
lines changed

4 files changed

+1233
-6
lines changed

docs/Service_.html

Lines changed: 261 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -610,6 +610,112 @@ <h5>Returns:</h5>
610610

611611

612612

613+
<h4 class="name" id="getStorage"><span class="type-signature"></span>getStorage<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="Storage.html">Storage</a>}</span></h4>
614+
615+
616+
617+
618+
619+
620+
<div class="description">
621+
Gets the storage layer for this service, used to persist tokens.
622+
Custom values associated with the service can be stored here as well.
623+
The key <code>null</code> is used to to store the token and should not
624+
be used.
625+
</div>
626+
627+
628+
629+
630+
631+
632+
633+
634+
635+
636+
637+
638+
639+
<dl class="details">
640+
641+
642+
643+
644+
645+
646+
647+
648+
649+
650+
651+
652+
653+
654+
655+
656+
657+
658+
659+
660+
661+
662+
663+
664+
665+
666+
667+
668+
669+
670+
671+
672+
</dl>
673+
674+
675+
676+
677+
678+
679+
680+
681+
682+
683+
684+
685+
686+
<h5>Returns:</h5>
687+
688+
689+
<div class="param-desc">
690+
The service's storage.
691+
</div>
692+
693+
694+
695+
<dl>
696+
<dt>
697+
Type
698+
</dt>
699+
<dd>
700+
701+
<span class="param-type"><a href="Storage.html">Storage</a></span>
702+
703+
704+
</dd>
705+
</dl>
706+
707+
708+
709+
710+
711+
712+
713+
714+
715+
716+
717+
718+
613719
<h4 class="name" id="getToken"><span class="type-signature"></span>getToken<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
614720

615721

@@ -2636,6 +2742,159 @@ <h5>Parameters:</h5>
26362742

26372743

26382744

2745+
2746+
2747+
2748+
2749+
2750+
2751+
2752+
2753+
2754+
2755+
2756+
2757+
</dl>
2758+
2759+
2760+
2761+
2762+
2763+
2764+
2765+
2766+
2767+
2768+
2769+
2770+
2771+
<h5>Returns:</h5>
2772+
2773+
2774+
<div class="param-desc">
2775+
This service, for chaining.
2776+
</div>
2777+
2778+
2779+
2780+
<dl>
2781+
<dt>
2782+
Type
2783+
</dt>
2784+
<dd>
2785+
2786+
<span class="param-type"><a href="Service_.html">Service_</a></span>
2787+
2788+
2789+
</dd>
2790+
</dl>
2791+
2792+
2793+
2794+
2795+
2796+
2797+
2798+
2799+
2800+
2801+
2802+
2803+
2804+
<h4 class="name" id="setRefreshUrl"><span class="type-signature"></span>setRefreshUrl<span class="signature">(refreshUrl)</span><span class="type-signature"> &rarr; {<a href="Service_.html">Service_</a>}</span></h4>
2805+
2806+
2807+
2808+
2809+
2810+
2811+
<div class="description">
2812+
Sets the service's refresh URL. Some OAuth providers require a different URL
2813+
to be used when generating access tokens from a refresh token.
2814+
</div>
2815+
2816+
2817+
2818+
2819+
2820+
2821+
2822+
2823+
2824+
<h5>Parameters:</h5>
2825+
2826+
2827+
<table class="params">
2828+
<thead>
2829+
<tr>
2830+
2831+
<th>Name</th>
2832+
2833+
2834+
<th>Type</th>
2835+
2836+
2837+
2838+
2839+
2840+
<th class="last">Description</th>
2841+
</tr>
2842+
</thead>
2843+
2844+
<tbody>
2845+
2846+
2847+
<tr>
2848+
2849+
<td class="name"><code>refreshUrl</code></td>
2850+
2851+
2852+
<td class="type">
2853+
2854+
2855+
<span class="param-type">string</span>
2856+
2857+
2858+
2859+
</td>
2860+
2861+
2862+
2863+
2864+
2865+
<td class="description last">The refresh endpoint URL.</td>
2866+
</tr>
2867+
2868+
2869+
</tbody>
2870+
</table>
2871+
2872+
2873+
2874+
2875+
2876+
2877+
<dl class="details">
2878+
2879+
2880+
2881+
2882+
2883+
2884+
2885+
2886+
2887+
2888+
2889+
2890+
2891+
2892+
2893+
2894+
2895+
2896+
2897+
26392898

26402899

26412900

@@ -3647,13 +3906,13 @@ <h5>Returns:</h5>
36473906
</div>
36483907

36493908
<nav>
3650-
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Service_.html">Service_</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createService">createService</a></li><li><a href="global.html#getRedirectUri">getRedirectUri</a></li><li><a href="global.html#STATE_PARAMETER_LOCATION">STATE_PARAMETER_LOCATION</a></li><li><a href="global.html#TOKEN_FORMAT">TOKEN_FORMAT</a></li></ul>
3909+
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Service_.html">Service_</a></li><li><a href="Storage.html">Storage</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createService">createService</a></li><li><a href="global.html#extend_">extend_</a></li><li><a href="global.html#getRedirectUri">getRedirectUri</a></li><li><a href="global.html#STATE_PARAMETER_LOCATION">STATE_PARAMETER_LOCATION</a></li><li><a href="global.html#TOKEN_FORMAT">TOKEN_FORMAT</a></li></ul>
36513910
</nav>
36523911

36533912
<br class="clear">
36543913

36553914
<footer>
3656-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 07 2018 22:26:04 GMT-0800 (PST)
3915+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 14 2018 22:45:11 GMT-0500 (STD)
36573916
</footer>
36583917

36593918
<script> prettyPrint(); </script>

0 commit comments

Comments
 (0)