Skip to content

Commit

Permalink
Update docs and files to distribute
Browse files Browse the repository at this point in the history
  • Loading branch information
Travis committed Jun 10, 2016
1 parent 8a701d8 commit be3351b
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 7 deletions.
6 changes: 3 additions & 3 deletions 2.4/js/docs-setup.js
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ NG_DOCS={
"type": "function",
"moduleName": "authentication",
"shortDescription": "Get the access token for the user.",
"keywords": "access api authcode authentication call calls code docs don ensure familysearch function functions getauthcode https making org passed promise requests require resolves returned store token user"
"keywords": "access allow api app authcode authentication call calls code docs don ensure familysearch function functions getauthcode getoauth2authorizeurl handle herokuapp https initiate making method org passed piece popup process promise recieve redirects requests require resolves returned sample site store token user"
},
{
"section": "api",
Expand Down Expand Up @@ -90,8 +90,8 @@ NG_DOCS={
"shortName": "getOAuth2AuthorizeURL",
"type": "function",
"moduleName": "authentication",
"shortDescription": "Get the URL that a user should be redirected to to begin",
"keywords": "api authentication authorize function functions oauth2 optional parameter redirected url user"
"shortDescription": "Get the URL that a user should be redirected to for initiating",
"keywords": "api app authentication authorize example function functions herokuapp https initiating oauth2 optional parameter redirect redirected sample url user"
},
{
"section": "api",
Expand Down
4 changes: 4 additions & 0 deletions 2.4/partials/api/authentication.functions.getAccessToken.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@ <h1><code ng:non-bindable="">getAccessToken</code>
Call this function before making any requests that require authentication.</p>
<p>You don&#39;t need to store the access token returned by this function; you just need to ensure that the promise
returned by this function resolves before making calls that require authentication.</p>
<p>This method does not allow your site to handle any piece of the auth process.
Use <a href="#/api/authentication.functions:getOAuth2AuthorizeURL">getOAuth2AuthorizeURL</a> if you want to
initiate and recieve the redirects yourself.</p>
<p><a href="https://familysearch.org/developers/docs/api/authentication/Access_Token_resource">FamilySearch API docs</a></p>
<p><a href="https://fs-javascript-sdk-sample-app.herokuapp.com/examples/authentication">Popup Authentication in the Sample App</a></p>
</div></div>
<h2 id="usage">Usage</h2>
<div class="usage"><pre class="prettyprint linenums">getAccessToken([authCode]);</pre>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ <h1><code ng:non-bindable="">getOAuth2AuthorizeURL</code>
</div>
</h1>
<div><h2 id="description">Description</h2>
<div class="description"><div class="authentication-functions-page authentication-functions-getoauth2authorizeurl-page"><p>Get the URL that a user should be redirected to to begin
<div class="description"><div class="authentication-functions-page authentication-functions-getoauth2authorizeurl-page"><p>Get the URL that a user should be redirected to for initiating
OAuth2 authentication.</p>
<p><a href="https://fs-javascript-sdk-sample-app.herokuapp.com/examples/authentication-redirect">Redirect Authentication Example in the Sample App</a></p>
</div></div>
<h2 id="usage">Usage</h2>
<div class="usage"><pre class="prettyprint linenums">getOAuth2AuthorizeURL([Optional]);</pre>
Expand Down
12 changes: 9 additions & 3 deletions familysearch-javascript-sdk.js
Original file line number Diff line number Diff line change
Expand Up @@ -8537,9 +8537,14 @@ FS.prototype.handleAccessTokenResponse = function(response) {
*
* You don't need to store the access token returned by this function; you just need to ensure that the promise
* returned by this function resolves before making calls that require authentication.
*
* This method does not allow your site to handle any piece of the auth process.
* Use {@link authentication.functions:getOAuth2AuthorizeURL getOAuth2AuthorizeURL} if you want to
* initiate and recieve the redirects yourself.
*
* {@link https://familysearch.org/developers/docs/api/authentication/Access_Token_resource FamilySearch API docs}
*
*
* {@link https://fs-javascript-sdk-sample-app.herokuapp.com/examples/authentication Popup Authentication in the Sample App}
*
* @param {String=} authCode auth code from getAuthCode; if not passed in, this function will call getAuthCode
* @return {Object} a promise for the (string) access token.
Expand Down Expand Up @@ -8628,12 +8633,13 @@ FS.prototype.getAccessTokenWithClientCredentials = function(){
/**
* @ngdoc function
* @name authentication.functions:getOAuth2AuthorizeURL
*
* @description
* Get the URL that a user should be redirected to to begin
* Get the URL that a user should be redirected to for initiating
* OAuth2 authentication.
*
* {@link https://fs-javascript-sdk-sample-app.herokuapp.com/examples/authentication-redirect Redirect Authentication Example in the Sample App}
*
* @param {String=} Optional state parameter
* @return {string} The OAuth2 authorize URL the user should be sent to
*/
Expand Down

0 comments on commit be3351b

Please sign in to comment.