Permalink
Browse files

Update JS API docs to latest

  • Loading branch information...
1 parent c6937b4 commit c03767de11c28c5cce34c7e53f34547e2ada8633 @kborchers kborchers committed Mar 26, 2013
@@ -50,6 +50,7 @@ <h4 class="name" id="Rest"><span class="type-signature"></span>new Rest<span cla
<div class="description">
The REST adapter is the default type used when creating a new authentication module. It uses jQuery.ajax to communicate with the server.
+ This constructor is instantiated when the "Auth.add()" method is called
</div>
@@ -354,7 +355,7 @@ <h4 class="name" id="Rest"><span class="type-signature"></span>new Rest<span cla
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="rest.js.html">authentication/adapters/rest.js</a>, line 46
+ <a href="rest.js.html">authentication/adapters/rest.js</a>, line 47
</li></ul></dd>
@@ -397,24 +398,24 @@ <h4 class="name" id="Rest"><span class="type-signature"></span>new Rest<span cla
<h5>Example</h5>
- <pre class="prettyprint"><code> //Create an empty Authenticator
- var auth = AeroGear.Auth();
-
- //Add a custom REST module to it
- auth.add( "module1", {
- agAuth: true,
- baseURL: "http://customURL.com"
- });
-
- //Add a custom REST module to it with custom security endpoints
- auth.add( "module2", {
- agAuth: true,
- endpoints: {
- enroll: "register",
- login: "go",
- logout: "leave"
- }
- });</code></pre>
+ <pre class="prettyprint"><code>//Create an empty Authenticator
+var auth = AeroGear.Auth();
+
+//Add a custom REST module to it
+auth.add( "module1", {
+ agAuth: true,
+ baseURL: "http://customURL.com"
+});
+
+//Add a custom REST module to it with custom security endpoints
+auth.add( "module2", {
+ agAuth: true,
+ endpoints: {
+ enroll: "register",
+ login: "go",
+ logout: "leave"
+ }
+});</code></pre>
</dd>
@@ -793,7 +794,7 @@ <h4 class="name" id="enroll"><span class="type-signature"></span>enroll<span cla
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="rest.js.html">authentication/adapters/rest.js</a>, line 223
+ <a href="rest.js.html">authentication/adapters/rest.js</a>, line 224
</li></ul></dd>
@@ -836,30 +837,30 @@ <h4 class="name" id="enroll"><span class="type-signature"></span>enroll<span cla
<h5>Example</h5>
- <pre class="prettyprint"><code> var auth = AeroGear.Auth( "userAuth" ).modules[ 0 ],
- data = { userName: "user", password: "abc123", name: "John" };
+ <pre class="prettyprint"><code>var auth = AeroGear.Auth( "userAuth" ).modules[ 0 ],
+ data = { userName: "user", password: "abc123", name: "John" };
- // Enroll a new user
- auth.enroll( data );
+// Enroll a new user
+auth.enroll( data );
- //Add a custom REST module to it with custom security endpoints
- var custom = AeroGear.Auth({
- name: "customModule",
- settings: {
- agAuth: true,
- endpoints: {
- enroll: "register",
- login: "go",
- logout: "leave"
- }
- }).modules[ 0 ],
- data = { userName: "user", password: "abc123", name: "John" };
+//Add a custom REST module to it with custom security endpoints
+var custom = AeroGear.Auth({
+ name: "customModule",
+ settings: {
+ agAuth: true,
+ endpoints: {
+ enroll: "register",
+ login: "go",
+ logout: "leave"
+ }
+}).modules[ 0 ],
+data = { userName: "user", password: "abc123", name: "John" };
- custom.enroll( data, {
- baseURL: "http://customurl/",
- success: function( data ) { ... },
- error: function( error ) { ... }
- });</code></pre>
+custom.enroll( data, {
+ baseURL: "http://customurl/",
+ success: function( data ) { ... },
+ error: function( error ) { ... }
+});</code></pre>
</dd>
@@ -1220,7 +1221,7 @@ <h4 class="name" id="login"><span class="type-signature"></span>login<span class
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="rest.js.html">authentication/adapters/rest.js</a>, line 309
+ <a href="rest.js.html">authentication/adapters/rest.js</a>, line 310
</li></ul></dd>
@@ -1263,30 +1264,30 @@ <h4 class="name" id="login"><span class="type-signature"></span>login<span class
<h5>Example</h5>
- <pre class="prettyprint"><code> var auth = AeroGear.Auth( "userAuth" ).modules[ 0 ],
- data = { userName: "user", password: "abc123" };
+ <pre class="prettyprint"><code>var auth = AeroGear.Auth( "userAuth" ).modules[ 0 ],
+ data = { userName: "user", password: "abc123" };
- // Enroll a new user
- auth.login( data );
+// Enroll a new user
+auth.login( data );
- //Add a custom REST module to it with custom security endpoints
- var custom = AeroGear.Auth({
- name: "customModule",
- settings: {
- agAuth: true,
- endpoints: {
- enroll: "register",
- login: "go",
- logout: "leave"
- }
- }).modules[ 0 ],
- data = { userName: "user", password: "abc123", name: "John" };
+//Add a custom REST module to it with custom security endpoints
+var custom = AeroGear.Auth({
+ name: "customModule",
+ settings: {
+ agAuth: true,
+ endpoints: {
+ enroll: "register",
+ login: "go",
+ logout: "leave"
+ }
+}).modules[ 0 ],
+data = { userName: "user", password: "abc123", name: "John" };
- custom.login( data, {
- baseURL: "http://customurl/",
- success: function( data ) { ... },
- error: function( error ) { ... }
- });</code></pre>
+custom.login( data, {
+ baseURL: "http://customurl/",
+ success: function( data ) { ... },
+ error: function( error ) { ... }
+});</code></pre>
</dd>
@@ -1552,7 +1553,7 @@ <h4 class="name" id="logout"><span class="type-signature"></span>logout<span cla
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="rest.js.html">authentication/adapters/rest.js</a>, line 391
+ <a href="rest.js.html">authentication/adapters/rest.js</a>, line 392
</li></ul></dd>
@@ -1595,29 +1596,29 @@ <h4 class="name" id="logout"><span class="type-signature"></span>logout<span cla
<h5>Example</h5>
- <pre class="prettyprint"><code> var auth = AeroGear.Auth( "userAuth" ).modules[ 0 ];
-
- // Enroll a new user
- auth.logout();
-
- //Add a custom REST module to it with custom security endpoints
- var custom = AeroGear.Auth({
- name: "customModule",
- settings: {
- agAuth: true,
- endpoints: {
- enroll: "register",
- login: "go",
- logout: "leave"
- }
- }).modules[ 0 ],
- data = { userName: "user", password: "abc123", name: "John" };
+ <pre class="prettyprint"><code>var auth = AeroGear.Auth( "userAuth" ).modules[ 0 ];
+
+// Enroll a new user
+auth.logout();
+
+ //Add a custom REST module to it with custom security endpoints
+var custom = AeroGear.Auth({
+ name: "customModule",
+ settings: {
+ agAuth: true,
+ endpoints: {
+ enroll: "register",
+ login: "go",
+ logout: "leave"
+ }
+}).modules[ 0 ],
+data = { userName: "user", password: "abc123", name: "John" };
- custom.logout({
- baseURL: "http://customurl/",
- success: function( data ) { ... },
- error: function( error ) { ... }
- });</code></pre>
+custom.logout({
+ baseURL: "http://customurl/",
+ success: function( data ) { ... },
+ error: function( error ) { ... }
+});</code></pre>
</dd>
@@ -1644,7 +1645,7 @@ <h4 class="name" id="logout"><span class="type-signature"></span>logout<span cla
<br clear="both">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> on Mon Mar 25 2013 16:20:09 GMT-0500 (CDT)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> on Tue Mar 26 2013 09:37:03 GMT-0500 (CDT)
</footer>
<script> prettyPrint(); </script>
@@ -245,7 +245,7 @@ <h4 class="name" id="Auth"><span class="type-signature"></span>new Auth<span cla
</td>
- <td class="description last">the settings to be passed to the adapter. Form specific settings, see the documentation for the adapter you are using.</td>
+ <td class="description last">the settings to be passed to the adapter. For specific settings, see the documentation for the adapter you are using.</td>
</tr>
@@ -282,7 +282,7 @@ <h4 class="name" id="Auth"><span class="type-signature"></span>new Auth<span cla
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="aerogear.auth.js.html">authentication/aerogear.auth.js</a>, line 34
+ <a href="aerogear.auth.js.html">authentication/aerogear.auth.js</a>, line 52
</li></ul></dd>
@@ -325,14 +325,32 @@ <h4 class="name" id="Auth"><span class="type-signature"></span>new Auth<span cla
<h5>Example</h5>
- <pre class="prettyprint"><code> // Create an empty authenticator
- var auth = AeroGear.Auth();
-
- // Create a single module using the default adapter
- var auth2 = AeroGear.Auth( "myAuth" );
-
- // Create multiple modules using the default adapter
- var auth3 = AeroGear.Auth( [ "someAuth", "anotherAuth" ] );</code></pre>
+ <pre class="prettyprint"><code>// Create an empty authenticator
+var auth = AeroGear.Auth();
+
+// Create a single module using the default adapter
+var auth2 = AeroGear.Auth( "myAuth" );
+
+// Create multiple modules using the default adapter
+var auth3 = AeroGear.Auth( [ "someAuth", "anotherAuth" ] );
+
+//Create a single module by passing an object using the default adapter
+var auth4 = AeroGear.Auth(
+ {
+ name: "objectAuth"
+ }
+);
+
+//Create multiple modules by passing an array of objects using the default adapter
+var auth5 = AeroGear.Auth([
+ {
+ name: "objectAuth"
+ },
+ {
+ name: "objectAuth2",
+ settings: { ... }
+ }
+]);</code></pre>
</dd>
@@ -390,7 +408,7 @@ <h4 class="name" id="adapters"><span class="type-signature">&lt;static> </span>a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="aerogear.auth.js.html">authentication/aerogear.auth.js</a>, line 63
+ <a href="aerogear.auth.js.html">authentication/aerogear.auth.js</a>, line 81
</li></ul></dd>
@@ -445,7 +463,7 @@ <h4 class="name" id="this.collectionName"><span class="type-signature">&lt;stati
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="aerogear.auth.js.html">authentication/aerogear.auth.js</a>, line 51
+ <a href="aerogear.auth.js.html">authentication/aerogear.auth.js</a>, line 69
</li></ul></dd>
@@ -484,7 +502,7 @@ <h4 class="name" id="this.collectionName"><span class="type-signature">&lt;stati
<br clear="both">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> on Mon Mar 25 2013 16:20:09 GMT-0500 (CDT)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> on Tue Mar 26 2013 09:37:03 GMT-0500 (CDT)
</footer>
<script> prettyPrint(); </script>
Oops, something went wrong.

0 comments on commit c03767d

Please sign in to comment.