Skip to content
Browse files

added generated API docs

  • Loading branch information...
1 parent 75b348d commit 7e825d13c89492131e7662cc95627d560aaca66c @funkatron funkatron committed Sep 29, 2010
Sorry, we could not display the entire diff because it was too big.
View
588 docs/files.html
@@ -0,0 +1,588 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+
+
+ <title>JsDoc Reference - File Index</title>
+ <meta name="generator" content="JsDoc Toolkit" />
+
+ <link href="stylesheets/default.css" type="text/css" rel="stylesheet" media="all" />
+
+</head>
+
+<body id="file_index">
+ <div id="body_wrapper">
+ <div id="wrapper">
+ <div id="box">
+ <span id="blue_label"></span>
+ <div id="box_wrapper">
+
+ <div id="nav">
+ <h2>Classes</h2>
+<ul>
+
+ <li><em><a href="symbols/_global_.html">_global_</a></em></li>
+
+ <li><a href="symbols/sc.html">sc</a></li>
+
+ <li><a href="symbols/sc.app.html">sc.app</a></li>
+
+ <li><a href="symbols/sc.helpers.html">sc.helpers</a></li>
+
+ <li><a href="symbols/sc.helpers.Base64.html">sc.helpers.Base64</a></li>
+
+ <li><a href="symbols/sc.helpers.Utf8.html">sc.helpers.Utf8</a></li>
+
+ <li><a href="symbols/sch.html">sch</a></li>
+
+ <li><a href="symbols/SpazAccounts.html">SpazAccounts</a></li>
+
+ <li><a href="symbols/SpazAuth.html">SpazAuth</a></li>
+
+ <li><a href="symbols/SpazBasicAuth.html">SpazBasicAuth</a></li>
+
+ <li><a href="symbols/SpazFileUploader.html">SpazFileUploader</a></li>
+
+ <li><a href="symbols/SpazFilterChain.html">SpazFilterChain</a></li>
+
+ <li><a href="symbols/SpazImageUploader.html">SpazImageUploader</a></li>
+
+ <li><a href="symbols/SpazImageURL.html">SpazImageURL</a></li>
+
+ <li><a href="symbols/SpazInstapaper.html">SpazInstapaper</a></li>
+
+ <li><a href="symbols/SpazOAuth.html">SpazOAuth</a></li>
+
+ <li><a href="symbols/SpazPhotoMailer.html">SpazPhotoMailer</a></li>
+
+ <li><a href="symbols/SpazPrefs.html">SpazPrefs</a></li>
+
+ <li><a href="symbols/SpazShortText.html">SpazShortText</a></li>
+
+ <li><a href="symbols/SpazShortURL.html">SpazShortURL</a></li>
+
+ <li><a href="symbols/SpazTemplate.html">SpazTemplate</a></li>
+
+ <li><a href="symbols/SpazTimeline.html">SpazTimeline</a></li>
+
+ <li><a href="symbols/SpazTimelineFilter.html">SpazTimelineFilter</a></li>
+
+ <li><a href="symbols/SpazTimelineNav.html">SpazTimelineNav</a></li>
+
+ <li><a href="symbols/SpazTMDB.html">SpazTMDB</a></li>
+
+ <li><a href="symbols/SpazTwit.html">SpazTwit</a></li>
+
+ <li><a href="symbols/SpazTwitterStream.html">SpazTwitterStream</a></li>
+
+</ul>
+
+<p class="class_index index_link"><span>&#x21A9;</span> <a href="index.html">Class Index</a></p>
+<p class="class_index index_link"><span>&#x21A9;</span> <a href="files.html">File Index</a></p>
+
+ </div>
+
+ <div id="content">
+ <h1>File Index</h1>
+ <div id="content_wrapper">
+
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_libs_spaztimeline.js.html">spaztimeline.js</a></h2>
+
+File containing the SpazTimeline object definition
+ <dl>
+
+ <dt class="heading">Author:</dt>
+ <dd><a href="mailto:coj@funkatron.com">coj@funkatron.com</a></dd>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_helpers_datetime.js.html">/Users/coj/Sites/spazcore/helpers/datetime.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_helpers_event.js.html">/Users/coj/Sites/spazcore/helpers/event.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_helpers_file.js.html">/Users/coj/Sites/spazcore/helpers/file.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_helpers_hash.js.html">/Users/coj/Sites/spazcore/helpers/hash.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_helpers_javascript.js.html">/Users/coj/Sites/spazcore/helpers/javascript.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_helpers_json.js.html">/Users/coj/Sites/spazcore/helpers/json.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_helpers_keyboard.js.html">/Users/coj/Sites/spazcore/helpers/keyboard.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_helpers_location.js.html">/Users/coj/Sites/spazcore/helpers/location.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_helpers_network.js.html">/Users/coj/Sites/spazcore/helpers/network.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_helpers_string.js.html">/Users/coj/Sites/spazcore/helpers/string.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_helpers_sys.js.html">/Users/coj/Sites/spazcore/helpers/sys.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_helpers_url.js.html">/Users/coj/Sites/spazcore/helpers/url.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_helpers_view.js.html">/Users/coj/Sites/spazcore/helpers/view.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_helpers_window.js.html">/Users/coj/Sites/spazcore/helpers/window.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_helpers_xml.js.html">/Users/coj/Sites/spazcore/helpers/xml.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_libs_spazaccounts.js.html">/Users/coj/Sites/spazcore/libs/spazaccounts.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_libs_spazauth.js.html">/Users/coj/Sites/spazcore/libs/spazauth.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_libs_spazcore.js.html">/Users/coj/Sites/spazcore/libs/spazcore.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_libs_spazfileuploader.js.html">/Users/coj/Sites/spazcore/libs/spazfileuploader.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_libs_spazfilterchain.js.html">/Users/coj/Sites/spazcore/libs/spazfilterchain.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_libs_spazimageuploader.js.html">/Users/coj/Sites/spazcore/libs/spazimageuploader.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_libs_spazimageurl.js.html">/Users/coj/Sites/spazcore/libs/spazimageurl.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_libs_spazinstapaper.js.html">/Users/coj/Sites/spazcore/libs/spazinstapaper.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_libs_spazphotomailer.js.html">/Users/coj/Sites/spazcore/libs/spazphotomailer.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_libs_spazprefs.js.html">/Users/coj/Sites/spazcore/libs/spazprefs.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_libs_spazshorttext.js.html">/Users/coj/Sites/spazcore/libs/spazshorttext.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_libs_spazshorturl.js.html">/Users/coj/Sites/spazcore/libs/spazshorturl.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_libs_spaztemplate.js.html">/Users/coj/Sites/spazcore/libs/spaztemplate.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_libs_spaztimelinefilter.js.html">/Users/coj/Sites/spazcore/libs/spaztimelinefilter.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_libs_spaztimelinenav.js.html">/Users/coj/Sites/spazcore/libs/spaztimelinenav.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_libs_spaztmdb.js.html">/Users/coj/Sites/spazcore/libs/spaztmdb.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_libs_spaztwit.js.html">/Users/coj/Sites/spazcore/libs/spaztwit.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div class="module">
+
+
+ <h2><a href="symbols/src/_Users_coj_Sites_spazcore_libs_spaztwitterstream.js.html">/Users/coj/Sites/spazcore/libs/spaztwitterstream.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ </div><!-- #content_wrapper -->
+ </div><!-- #content -->
+
+ <hr/>
+
+ </div><!-- #box_wrapper -->
+ </div><!-- #box -->
+
+ <div id="footer">
+
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Wed Sep 29 2010 23:25:53 GMT-0400 (EDT)
+ </div><!-- #footer -->
+
+ </div><!-- #wrapper -->
+ </div><!-- #body_wrapper -->
+</body>
+</html>
View
242 docs/index.html
@@ -0,0 +1,242 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+
+ <title>JsDoc Reference - Index</title>
+ <meta name="generator" content="JsDoc Toolkit" />
+
+ <link href="stylesheets/default.css" type="text/css" rel="stylesheet" media="all" />
+</head>
+
+<body id="class_index">
+ <div id="body_wrapper">
+ <div id="wrapper">
+ <div id="box">
+ <span id="blue_label"></span>
+ <div id="box_wrapper">
+
+ <div id="nav">
+ <h2>Classes</h2>
+<ul>
+
+ <li><em><a href="symbols/_global_.html">_global_</a></em></li>
+
+ <li><a href="symbols/sc.html">sc</a></li>
+
+ <li><a href="symbols/sc.app.html">sc.app</a></li>
+
+ <li><a href="symbols/sc.helpers.html">sc.helpers</a></li>
+
+ <li><a href="symbols/sc.helpers.Base64.html">sc.helpers.Base64</a></li>
+
+ <li><a href="symbols/sc.helpers.Utf8.html">sc.helpers.Utf8</a></li>
+
+ <li><a href="symbols/sch.html">sch</a></li>
+
+ <li><a href="symbols/SpazAccounts.html">SpazAccounts</a></li>
+
+ <li><a href="symbols/SpazAuth.html">SpazAuth</a></li>
+
+ <li><a href="symbols/SpazBasicAuth.html">SpazBasicAuth</a></li>
+
+ <li><a href="symbols/SpazFileUploader.html">SpazFileUploader</a></li>
+
+ <li><a href="symbols/SpazFilterChain.html">SpazFilterChain</a></li>
+
+ <li><a href="symbols/SpazImageUploader.html">SpazImageUploader</a></li>
+
+ <li><a href="symbols/SpazImageURL.html">SpazImageURL</a></li>
+
+ <li><a href="symbols/SpazInstapaper.html">SpazInstapaper</a></li>
+
+ <li><a href="symbols/SpazOAuth.html">SpazOAuth</a></li>
+
+ <li><a href="symbols/SpazPhotoMailer.html">SpazPhotoMailer</a></li>
+
+ <li><a href="symbols/SpazPrefs.html">SpazPrefs</a></li>
+
+ <li><a href="symbols/SpazShortText.html">SpazShortText</a></li>
+
+ <li><a href="symbols/SpazShortURL.html">SpazShortURL</a></li>
+
+ <li><a href="symbols/SpazTemplate.html">SpazTemplate</a></li>
+
+ <li><a href="symbols/SpazTimeline.html">SpazTimeline</a></li>
+
+ <li><a href="symbols/SpazTimelineFilter.html">SpazTimelineFilter</a></li>
+
+ <li><a href="symbols/SpazTimelineNav.html">SpazTimelineNav</a></li>
+
+ <li><a href="symbols/SpazTMDB.html">SpazTMDB</a></li>
+
+ <li><a href="symbols/SpazTwit.html">SpazTwit</a></li>
+
+ <li><a href="symbols/SpazTwitterStream.html">SpazTwitterStream</a></li>
+
+</ul>
+
+<p class="class_index index_link"><span>&#x21A9;</span> <a href="index.html">Class Index</a></p>
+<p class="class_index index_link"><span>&#x21A9;</span> <a href="files.html">File Index</a></p>
+
+ </div>
+
+ <div id="content">
+ <h1>Class Index</h1>
+ <div id="content_wrapper">
+
+
+ <div class="module">
+ <h2><a href="symbols/_global_.html">_global_</a></h2>
+
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/sc.html">sc</a></h2>
+
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/sc.app.html">sc.app</a></h2>
+
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/sc.helpers.html">sc.helpers</a></h2>
+
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/sc.helpers.Base64.html">sc.helpers.Base64</a></h2>
+
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/sc.helpers.Utf8.html">sc.helpers.Utf8</a></h2>
+
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/sch.html">sch</a></h2>
+ helper shortcuts
+this lets us write "sch.method" instead of "sc.helpers.method"
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/SpazAccounts.html">SpazAccounts</a></h2>
+
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/SpazAuth.html">SpazAuth</a></h2>
+ SpazAuth
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/SpazBasicAuth.html">SpazBasicAuth</a></h2>
+ SpazBasicAuth
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/SpazFileUploader.html">SpazFileUploader</a></h2>
+
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/SpazFilterChain.html">SpazFilterChain</a></h2>
+
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/SpazImageUploader.html">SpazImageUploader</a></h2>
+
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/SpazImageURL.html">SpazImageURL</a></h2>
+
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/SpazInstapaper.html">SpazInstapaper</a></h2>
+
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/SpazOAuth.html">SpazOAuth</a></h2>
+ SpazOAuth
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/SpazPhotoMailer.html">SpazPhotoMailer</a></h2>
+
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/SpazPrefs.html">SpazPrefs</a></h2>
+ SpazPrefs
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/SpazShortText.html">SpazShortText</a></h2>
+
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/SpazShortURL.html">SpazShortURL</a></h2>
+ SpazShortURL
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/SpazTemplate.html">SpazTemplate</a></h2>
+ SpazTemplate
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/SpazTimeline.html">SpazTimeline</a></h2>
+
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/SpazTimelineFilter.html">SpazTimelineFilter</a></h2>
+
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/SpazTimelineNav.html">SpazTimelineNav</a></h2>
+
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/SpazTMDB.html">SpazTMDB</a></h2>
+
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/SpazTwit.html">SpazTwit</a></h2>
+ SpazTwit
+ </div>
+
+ <div class="module">
+ <h2><a href="symbols/SpazTwitterStream.html">SpazTwitterStream</a></h2>
+
+ </div>
+
+ </div><!-- #content_wrapper -->
+ </div><!-- #content -->
+
+ <hr/>
+
+ </div><!-- #box_wrapper -->
+ </div><!-- #box -->
+
+ <div id="footer">
+
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Wed Sep 29 2010 23:25:53 GMT-0400 (EDT)
+ </div><!-- #footer -->
+
+ </div><!-- #wrapper -->
+ </div><!-- #body_wrapper -->
+</body>
+</html>
View
BIN docs/stylesheets/blue_label.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN docs/stylesheets/body_noise.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN docs/stylesheets/body_wrapper_noise.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN docs/stylesheets/box_noise.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN docs/stylesheets/box_wrapper_noise.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
237 docs/stylesheets/default.css
@@ -0,0 +1,237 @@
+html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, a, abbr, acronym, address, big, cite, code, del, dfn, em, font, img, ins, kbd, q, s, samp, small, strike, strong, sub, sup, tt, var, b, u, i, center, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td {
+ margin: 0;
+ padding: 0;
+ font-size: 100%;
+ vertical-align: baseline;
+ border: 0;
+ outline: 0;
+ background: transparent;
+}
+
+ol, ul {
+ list-style: none;
+}
+
+blockquote, q {
+ quotes: none;
+}
+
+table {
+ border-collapse: collapse;
+ border-spacing: 0;
+}
+
+body {
+ font-family: Arial, Helvetica, sans-serif;
+ font-size: x-small;
+ background: #DFE1E0 url("body_noise.gif");
+ color: #2D3438;
+ text-align: center;
+}
+
+a {
+ color: #006691;
+}
+
+hr {
+ display: block;
+ clear: both;
+ visibility: hidden;
+}
+
+h1 {
+ font-size: 2.5em;
+ font-weight: normal;
+ letter-spacing: -1px;
+ text-shadow: 0 1px 0 hsla(0, 0%, 0%, .1);
+ color: #262626;
+ border-bottom: 1px solid #D6D9D8;
+ padding: 0 0 10px 0;
+}
+
+dt {
+ display: block;
+ padding: 7px 0 3px 0;
+ font-weight: bold;
+}
+
+dd {
+ display: block;
+ padding: 0 0 0 15px;
+}
+
+#body_wrapper {
+ background: url("body_wrapper_noise.gif") repeat-x top;
+}
+
+#wrapper {
+ width: 950px;
+ margin: 0 auto;
+ padding: 25px 0;
+ text-align: left;
+}
+
+#box {
+ background: #F5F5F5 url("box_noise.gif");
+ border-top: 1px solid #DCDEDD;
+ border-left: 1px solid #D5D7D6;
+ border-right: 1px solid #D3D5D4;
+ border-bottom: 1px solid #CDCFCE;
+ font-size: 1.2em;
+}
+
+#box_wrapper {
+ padding: 35px 25px;
+ background-image: url("box_wrapper_noise.gif") repeat-x top;
+}
+
+#blue_label {
+ position: absolute;
+ display: block;
+ width: 16px;
+ height: 95px;
+ margin: 34px 0 0 -16px;
+ background: url("blue_label.gif") no-repeat left top;
+}
+
+#nav {
+ float: left;
+ width: 190px;
+}
+
+#nav h2 {
+ padding: 5px 10px;
+ font-size: 1.3em;
+ font-weight: normal;
+ text-shadow: 0 1px 0 hsla(0, 0%, 0%, .1);
+ background: #E1E3E3;
+}
+
+#nav ul {
+ padding-bottom: 20px;
+}
+
+#nav ul li {
+ padding: 4px 10px;
+ border-top: 1px solid #E1E3E3;
+}
+
+.index_link a {
+ color: #999999;
+}
+
+.index_link span {
+ color: #000000;
+}
+
+#content {
+ float: right;
+ width: 680px;
+}
+
+#content p {
+ padding-bottom: 10px;
+}
+
+#content p.defined {
+ color: #666;
+ padding-bottom: 10px;
+}
+
+#content_wrapper {
+ display: block;
+ border-top: 1px solid #FFFFFF;
+ padding: 15px 0;
+}
+
+#footer {
+ text-align: right;
+ color: #5D5D5D;
+ padding: 10px 0;
+ font-size: 1.1em;
+}
+
+#footer a {
+ color: #424242;
+}
+
+.module {
+ border-bottom: 1px solid #D5D6D7;
+ padding: 10px 0;
+}
+
+.module h2 {
+ font-size: 1.2em;
+ color: #006691;
+ font-family: "Consolas", monospace;
+ padding: 4px 20px;
+ margin-left: -20px;
+ background: url("title_bullet.gif") no-repeat left top;
+}
+
+#class_detail .module h2 {
+ color: #2D3438;
+}
+
+#class_detail .module h2 span,
+dt span,
+dd .fixedFont {
+ color: #95999B;
+ font-weight: normal;
+}
+
+.module h2 strong {
+ color: #006691;
+}
+
+.summaryTable {
+ width: 100%;
+ margin-top: 15px;
+}
+
+.summaryTable caption {
+ padding: 5px 10px;
+ font-size: 1.5em;
+ font-weight: normal;
+ text-shadow: 0 1px 0 hsla(0, 0%, 0%, .1);
+ background: #E1E3E3;
+ text-align: left;
+}
+
+.summaryTable thead,
+.summaryTable th {
+ display: none;
+}
+
+.summaryTable td {
+ padding: 10px 15px;
+ background: #FFFFFF;
+ border-bottom: 10px solid #F5F6F5;
+}
+
+.summaryTable td.attributes {
+ width: 50px;
+ font-family: "Consolas", monospace;
+ color: #95999B;
+}
+
+.sectionTitle {
+ margin-top: 15px;
+ padding: 5px 10px;
+ font-size: 1.5em;
+ font-weight: normal;
+ text-shadow: 0 1px 0 hsla(0, 0%, 0%, .1);
+ background: #E1E3E3;
+ text-align: left;
+}
+
+pre {
+ padding: 10px;
+ background: #FFFFFF;
+ font-family: "Consolas", monospace;
+ color: #95999B;
+}
+
+.fixedFont {
+ font-family: "Consolas", monospace;
+}
View
BIN docs/stylesheets/title_bullet.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
1,072 docs/symbols/SpazAccounts.html
@@ -0,0 +1,1072 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+
+
+ <title>JsDoc Reference - SpazAccounts</title>
+ <meta name="generator" content="JsDoc Toolkit" />
+
+ <link href="../stylesheets/default.css" type="text/css" rel="stylesheet" media="all" />
+</head>
+
+<body id="class_detail">
+ <div id="body_wrapper">
+ <div id="wrapper">
+ <div id="box">
+ <span id="blue_label"></span>
+ <div id="box_wrapper">
+
+ <div id="nav">
+ <h2>Classes</h2>
+<ul>
+
+ <li><em><a href="../symbols/_global_.html">_global_</a></em></li>
+
+ <li><a href="../symbols/sc.html">sc</a></li>
+
+ <li><a href="../symbols/sc.app.html">sc.app</a></li>
+
+ <li><a href="../symbols/sc.helpers.html">sc.helpers</a></li>
+
+ <li><a href="../symbols/sc.helpers.Base64.html">sc.helpers.Base64</a></li>
+
+ <li><a href="../symbols/sc.helpers.Utf8.html">sc.helpers.Utf8</a></li>
+
+ <li><a href="../symbols/sch.html">sch</a></li>
+
+ <li><a href="../symbols/SpazAccounts.html">SpazAccounts</a></li>
+
+ <li><a href="../symbols/SpazAuth.html">SpazAuth</a></li>
+
+ <li><a href="../symbols/SpazBasicAuth.html">SpazBasicAuth</a></li>
+
+ <li><a href="../symbols/SpazFileUploader.html">SpazFileUploader</a></li>
+
+ <li><a href="../symbols/SpazFilterChain.html">SpazFilterChain</a></li>
+
+ <li><a href="../symbols/SpazImageUploader.html">SpazImageUploader</a></li>
+
+ <li><a href="../symbols/SpazImageURL.html">SpazImageURL</a></li>
+
+ <li><a href="../symbols/SpazInstapaper.html">SpazInstapaper</a></li>
+
+ <li><a href="../symbols/SpazOAuth.html">SpazOAuth</a></li>
+
+ <li><a href="../symbols/SpazPhotoMailer.html">SpazPhotoMailer</a></li>
+
+ <li><a href="../symbols/SpazPrefs.html">SpazPrefs</a></li>
+
+ <li><a href="../symbols/SpazShortText.html">SpazShortText</a></li>
+
+ <li><a href="../symbols/SpazShortURL.html">SpazShortURL</a></li>
+
+ <li><a href="../symbols/SpazTemplate.html">SpazTemplate</a></li>
+
+ <li><a href="../symbols/SpazTimeline.html">SpazTimeline</a></li>
+
+ <li><a href="../symbols/SpazTimelineFilter.html">SpazTimelineFilter</a></li>
+
+ <li><a href="../symbols/SpazTimelineNav.html">SpazTimelineNav</a></li>
+
+ <li><a href="../symbols/SpazTMDB.html">SpazTMDB</a></li>
+
+ <li><a href="../symbols/SpazTwit.html">SpazTwit</a></li>
+
+ <li><a href="../symbols/SpazTwitterStream.html">SpazTwitterStream</a></li>
+
+</ul>
+
+<p class="class_index index_link"><span>&#x21A9;</span> <a href="../index.html">Class Index</a></p>
+<p class="class_index index_link"><span>&#x21A9;</span> <a href="../files.html">File Index</a></p>
+
+ </div>
+
+ <div id="content">
+ <h1>
+
+ Class SpazAccounts
+ </h1>
+ <div id="content_wrapper">
+
+
+
+
+ <p>
+
+ </p>
+
+
+ <p class="defined">
+ Defined in: <a href="../symbols/src/_Users_coj_Sites_spazcore_libs_spazaccounts.js.html">spazaccounts.js</a>.
+ </p>
+
+
+ <!-- ============================== constructor summary ==================== -->
+
+ <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class SpazAccounts.">
+ <caption>Class Summary</caption>
+ <thead>
+ <tr>
+ <th scope="col">Constructor Attributes</th>
+ <th scope="col">Constructor Name and Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td class="attributes">
+ &nbsp;
+ </td>
+ <td class="nameDescription" >
+ <div class="fixedFont">
+ <strong><a href="../symbols/SpazAccounts.html#constructor">SpazAccounts</a></strong>((Object))
+ </div>
+ <p class="description">This creates a new SpazAccounts object, and optionally associates it with an existing preferences object</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+
+ <!-- ============================== properties summary ===================== -->
+
+
+
+ <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class SpazAccounts.">
+ <caption>Field Summary</caption>
+ <thead>
+ <tr>
+ <th scope="col">Field Attributes</th>
+ <th scope="col">Field Name and Description</th>
+ </tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td class="attributes">
+ &nbsp;
+ </td>
+ <td class="nameDescription">
+ <div class="fixedFont">
+ <strong><a href="../symbols/SpazAccounts.html#prefskey">prefskey</a></strong>
+ </div>
+ <p class="description">the key used inside the prefs object</p>
+ </td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <!-- ============================== methods summary ======================== -->
+
+
+
+ <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class SpazAccounts.">
+ <caption>Method Summary</caption>
+ <thead>
+ <tr>
+ <th scope="col">Method Attributes</th>
+ <th scope="col">Method Name and Description</th>
+ </tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td class="attributes">
+ &nbsp;
+ </td>
+ <td class="nameDescription">
+ <div class="fixedFont"><strong><a href="../symbols/SpazAccounts.html#add">add</a></strong>(username, auth, type)
+ </div>
+ <p class="description">add a new account</p>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">
+ &nbsp;
+ </td>
+ <td class="nameDescription">
+ <div class="fixedFont"><strong><a href="../symbols/SpazAccounts.html#generateID">generateID</a></strong>()
+ </div>
+ <p class="description"></p>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">
+ &nbsp;
+ </td>
+ <td class="nameDescription">
+ <div class="fixedFont"><strong><a href="../symbols/SpazAccounts.html#get">get</a></strong>(id, type)
+ </div>
+ <p class="description">retrives the user object by user and type</p>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">
+ &nbsp;
+ </td>
+ <td class="nameDescription">
+ <div class="fixedFont"><strong><a href="../symbols/SpazAccounts.html#getAll">getAll</a></strong>()
+ </div>
+ <p class="description">returns the array of accounts</p>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">
+ &nbsp;
+ </td>
+ <td class="nameDescription">
+ <div class="fixedFont"><strong><a href="../symbols/SpazAccounts.html#getByType">getByType</a></strong>(type)
+ </div>
+ <p class="description"></p>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">
+ &nbsp;
+ </td>
+ <td class="nameDescription">
+ <div class="fixedFont"><strong><a href="../symbols/SpazAccounts.html#getByUsername">getByUsername</a></strong>(username)
+ </div>
+ <p class="description"></p>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">
+ &nbsp;
+ </td>
+ <td class="nameDescription">
+ <div class="fixedFont"><strong><a href="../symbols/SpazAccounts.html#getByUsernameAndType">getByUsernameAndType</a></strong>(username, type)
+ </div>
+ <p class="description"></p>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">
+ &nbsp;
+ </td>
+ <td class="nameDescription">
+ <div class="fixedFont"><strong><a href="../symbols/SpazAccounts.html#getMeta">getMeta</a></strong>(id, key)
+ </div>
+ <p class="description"></p>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">
+ &nbsp;
+ </td>
+ <td class="nameDescription">
+ <div class="fixedFont"><strong><a href="../symbols/SpazAccounts.html#initAccounts">initAccounts</a></strong>()
+ </div>
+ <p class="description">wipes the accounts array and saves it</p>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">
+ &nbsp;
+ </td>
+ <td class="nameDescription">
+ <div class="fixedFont"><strong><a href="../symbols/SpazAccounts.html#load">load</a></strong>()
+ </div>
+ <p class="description">loads the accounts array from the prefs object</p>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">
+ &nbsp;
+ </td>
+ <td class="nameDescription">
+ <div class="fixedFont"><strong><a href="../symbols/SpazAccounts.html#remove">remove</a></strong>(id)
+ </div>
+ <p class="description"></p>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">
+ &nbsp;
+ </td>
+ <td class="nameDescription">
+ <div class="fixedFont"><strong><a href="../symbols/SpazAccounts.html#save">save</a></strong>()
+ </div>
+ <p class="description">saves the accounts array to the prefs obj</p>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">
+ &nbsp;
+ </td>
+ <td class="nameDescription">
+ <div class="fixedFont"><strong><a href="../symbols/SpazAccounts.html#setAll">setAll</a></strong>(accounts_array)
+ </div>
+ <p class="description">Set all users by passing in a hash.</p>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">
+ &nbsp;
+ </td>
+ <td class="nameDescription">
+ <div class="fixedFont"><strong><a href="../symbols/SpazAccounts.html#setMeta">setMeta</a></strong>(id, key, value)
+ </div>
+ <p class="description"></p>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">
+ &nbsp;
+ </td>
+ <td class="nameDescription">
+ <div class="fixedFont"><strong><a href="../symbols/SpazAccounts.html#update">update</a></strong>(id, acctobj)
+ </div>
+ <p class="description"></p>
+ </td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <!-- ============================== events summary ======================== -->
+
+
+
+ <!-- ============================== constructor details ==================== -->
+
+ <div class="details"><a name="constructor"> </a>
+ <div class="sectionTitle">
+ Class Detail
+ </div>
+
+ <div class="module">
+
+ <h2><strong>
+ SpazAccounts((Object))</strong>
+ </h2>
+
+ <p class="description">
+ This creates a new SpazAccounts object, and optionally associates it with an existing preferences object
+
+ </p>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <strong>(Object)</strong>
+
+ </dt>
+ <dd>prefsObj An existing SpazPrefs object (optional)</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+
+
+
+ <!-- ============================== field details ========================== -->
+
+ <div class="sectionTitle">
+ Field Detail
+ </div>
+
+ <div class="module">
+ <a name="prefskey"> </a>
+ <h2><span></span>
+
+
+ <strong>prefskey</strong>
+
+ </h2>
+ <p class="description">
+ the key used inside the prefs object
+ </p>
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+
+
+ <!-- ============================== method details ========================= -->
+
+ <div class="sectionTitle">
+ Method Detail
+ </div>
+
+ <div class="module">
+ <a name="add"> </a>
+ <h2><span></span>
+
+ <span>{object}</span>
+ <strong>add</strong>(username, auth, type)
+
+ </h2>
+ <p class="description">
+ add a new account
+ </p>
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">{string}</span> <strong>username</strong>
+
+ </dt>
+ <dd>the username of the account</dd>
+
+ <dt>
+ <span class="fixedFont">{string}</span> <strong>auth</strong>
+
+ </dt>
+ <dd>serialized authentication key, generated by SpazAuth.save()</dd>
+
+ <dt>
+ <span class="fixedFont">{string}</span> <strong>type</strong>
+
+ </dt>
+ <dd>the type of account</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont">{object}</span> the account object just added</dd>
+
+ </dl>
+
+
+
+ </div>
+
+ <div class="module">
+ <a name="generateID"> </a>
+ <h2><span></span>
+
+ <span>{string}</span>
+ <strong>generateID</strong>()
+
+ </h2>
+ <p class="description">
+
+ </p>
+
+
+
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont">{string}</span> returns the generated UUID</dd>
+
+ </dl>
+
+
+
+ </div>
+
+ <div class="module">
+ <a name="get"> </a>
+ <h2><span></span>
+
+
+ <strong>get</strong>(id, type)
+
+ </h2>
+ <p class="description">
+ retrives the user object by user and type
+ </p>
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">{string}</span> <strong>id</strong>
+
+ </dt>
+ <dd>the user id UUID</dd>
+
+ <dt>
+ <span class="fixedFont">{string}</span> <strong>type</strong>
+
+ </dt>
+ <dd></dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+
+ <div class="module">
+ <a name="getAll"> </a>
+ <h2><span></span>
+
+ <span>{array}</span>
+ <strong>getAll</strong>()
+
+ </h2>
+ <p class="description">
+ returns the array of accounts
+ </p>
+
+
+
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont">{array}</span> the accounts</dd>
+
+ </dl>
+
+
+
+ </div>
+
+ <div class="module">
+ <a name="getByType"> </a>
+ <h2><span></span>
+
+ <span>{array}</span>
+ <strong>getByType</strong>(type)
+
+ </h2>
+ <p class="description">
+
+ </p>
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">{string}</span> <strong>type</strong>
+
+ </dt>
+ <dd>the type of accounts to retrieve</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont">{array}</span> the array of matching accounts</dd>
+
+ </dl>
+
+
+
+ </div>
+
+ <div class="module">
+ <a name="getByUsername"> </a>
+ <h2><span></span>
+
+ <span>{array}</span>
+ <strong>getByUsername</strong>(username)
+
+ </h2>
+ <p class="description">
+
+ </p>
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">{string}</span> <strong>username</strong>
+
+ </dt>
+ <dd>the username to search for</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont">{array}</span> an array of matching accounts</dd>
+
+ </dl>
+
+
+
+ </div>
+
+ <div class="module">
+ <a name="getByUsernameAndType"> </a>
+ <h2><span></span>
+
+ <span>{array}</span>
+ <strong>getByUsernameAndType</strong>(username, type)
+
+ </h2>
+ <p class="description">
+
+ </p>
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">{string}</span> <strong>username</strong>
+
+ </dt>
+ <dd>the username to search for</dd>
+
+ <dt>
+ <span class="fixedFont">{string}</span> <strong>type</strong>
+
+ </dt>
+ <dd>the type to search for</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont">{array}</span> an array of matching accounts</dd>
+
+ </dl>
+
+
+
+ </div>
+
+ <div class="module">
+ <a name="getMeta"> </a>
+ <h2><span></span>
+
+ <span>{String|Object|Array|Boolean|Number}</span>
+ <strong>getMeta</strong>(id, key)
+
+ </h2>
+ <p class="description">
+
+ </p>
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">{string}</span> <strong>id</strong>
+
+ </dt>
+ <dd>the user's UUID</dd>
+
+ <dt>
+ <span class="fixedFont">{string}</span> <strong>key</strong>
+
+ </dt>
+ <dd>the key for the metadata entry</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont">{String|Object|Array|Boolean|Number}</span> returns the set value, or null if user ID or meta entry is not found</dd>
+
+ </dl>
+
+
+
+ </div>
+
+ <div class="module">
+ <a name="initAccounts"> </a>
+ <h2><span></span>
+
+
+ <strong>initAccounts</strong>()
+
+ </h2>
+ <p class="description">
+ wipes the accounts array and saves it
+ </p>
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+ <div class="module">
+ <a name="load"> </a>
+ <h2><span></span>
+
+
+ <strong>load</strong>()
+
+ </h2>
+ <p class="description">
+ loads the accounts array from the prefs object
+ </p>
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+ <div class="module">
+ <a name="remove"> </a>
+ <h2><span></span>
+
+
+ <strong>remove</strong>(id)
+
+ </h2>
+ <p class="description">
+
+ </p>
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">{string}</span> <strong>id</strong>
+
+ </dt>
+ <dd>the UUID of the account to delete</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+
+ <div class="module">
+ <a name="save"> </a>
+ <h2><span></span>
+
+
+ <strong>save</strong>()
+
+ </h2>
+ <p class="description">
+ saves the accounts array to the prefs obj
+ </p>
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+ <div class="module">
+ <a name="setAll"> </a>
+ <h2><span></span>
+
+
+ <strong>setAll</strong>(accounts_array)
+
+ </h2>
+ <p class="description">
+ Set all users by passing in a hash. overwrites all existing data!
+ </p>
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">{array}</span> <strong>accounts_array</strong>
+
+ </dt>
+ <dd>an array of account objects</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+
+ <div class="module">
+ <a name="setMeta"> </a>
+ <h2><span></span>
+
+ <span>{String|Object|Array|Boolean|Number}</span>
+ <strong>setMeta</strong>(id, key, value)
+
+ </h2>
+ <p class="description">
+
+ </p>
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">{string}</span> <strong>id</strong>
+
+ </dt>
+ <dd>the user's UUID</dd>
+
+ <dt>
+ <span class="fixedFont">{string}</span> <strong>key</strong>
+
+ </dt>
+ <dd>the key for the metadata entry</dd>
+
+ <dt>
+ <span class="fixedFont">{String|Object|Array|Boolean|Number}</span> <strong>value</strong>
+
+ </dt>
+ <dd>the value of the metadata entry</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont">{String|Object|Array|Boolean|Number}</span> returns the set value, or null if user ID is not found</dd>
+
+ </dl>
+
+
+
+ </div>
+
+ <div class="module">
+ <a name="update"> </a>
+ <h2><span></span>
+
+
+ <strong>update</strong>(id, acctobj)
+
+ </h2>
+ <p class="description">
+
+ </p>
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">{string}</span> <strong>id</strong>
+
+ </dt>
+ <dd>the UUID to update</dd>
+
+ <dt>
+ <span class="fixedFont">{object}</span> <strong>acctobj</strong>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <span class="fixedFont">{string}</span> <strong>acctobj.username</strong>
+ <em>Optional</em>
+ </dt>
+ <dd>a new username</dd>
+
+ <dt>
+ <span class="fixedFont">{string}</span> <strong>acctobj.password</strong>
+ <em>Optional</em>
+ </dt>
+ <dd>a new password</dd>
+
+ <dt>
+ <span class="fixedFont">{string}</span> <strong>acctobj.type</strong>
+ <em>Optional</em>
+ </dt>
+ <dd>a new account type</dd>
+
+ <dt>
+ <span class="fixedFont">{object}</span> <strong>acctobj.meta</strong>
+ <em>Optional</em>
+ </dt>
+ <dd>the hash of metadata; you should probably use SpazAccounts.setMeta() instead</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+
+
+
+ <!-- ============================== event details ========================= -->
+
+
+ </div><!-- #content_wrapper -->
+ </div><!-- #content -->
+
+ <hr/>
+
+ </div><!-- #box_wrapper -->
+ </div><!-- #box -->
+
+ <div id="footer">
+
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Wed Sep 29 2010 23:25:49 GMT-0400 (EDT)
+ </div><!-- #footer -->
+
+ </div><!-- #wrapper -->
+ </div><!-- #body_wrapper -->
+</body>
+</html>
View
289 docs/symbols/SpazAuth.html
@@ -0,0 +1,289 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+
+
+ <title>JsDoc Reference - SpazAuth</title>
+ <meta name="generator" content="JsDoc Toolkit" />
+
+ <link href="../stylesheets/default.css" type="text/css" rel="stylesheet" media="all" />
+</head>
+
+<body id="class_detail">
+ <div id="body_wrapper">
+ <div id="wrapper">
+ <div id="box">
+ <span id="blue_label"></span>
+ <div id="box_wrapper">
+
+ <div id="nav">
+ <h2>Classes</h2>
+<ul>
+
+ <li><em><a href="../symbols/_global_.html">_global_</a></em></li>
+
+ <li><a href="../symbols/sc.html">sc</a></li>
+
+ <li><a href="../symbols/sc.app.html">sc.app</a></li>
+
+ <li><a href="../symbols/sc.helpers.html">sc.helpers</a></li>
+
+ <li><a href="../symbols/sc.helpers.Base64.html">sc.helpers.Base64</a></li>
+
+ <li><a href="../symbols/sc.helpers.Utf8.html">sc.helpers.Utf8</a></li>
+
+ <li><a href="../symbols/sch.html">sch</a></li>
+
+ <li><a href="../symbols/SpazAccounts.html">SpazAccounts</a></li>
+
+ <li><a href="../symbols/SpazAuth.html">SpazAuth</a></li>
+
+ <li><a href="../symbols/SpazBasicAuth.html">SpazBasicAuth</a></li>
+
+ <li><a href="../symbols/SpazFileUploader.html">SpazFileUploader</a></li>
+
+ <li><a href="../symbols/SpazFilterChain.html">SpazFilterChain</a></li>
+
+ <li><a href="../symbols/SpazImageUploader.html">SpazImageUploader</a></li>
+
+ <li><a href="../symbols/SpazImageURL.html">SpazImageURL</a></li>
+
+ <li><a href="../symbols/SpazInstapaper.html">SpazInstapaper</a></li>
+
+ <li><a href="../symbols/SpazOAuth.html">SpazOAuth</a></li>
+
+ <li><a href="../symbols/SpazPhotoMailer.html">SpazPhotoMailer</a></li>
+
+ <li><a href="../symbols/SpazPrefs.html">SpazPrefs</a></li>
+
+ <li><a href="../symbols/SpazShortText.html">SpazShortText</a></li>
+
+ <li><a href="../symbols/SpazShortURL.html">SpazShortURL</a></li>
+
+ <li><a href="../symbols/SpazTemplate.html">SpazTemplate</a></li>
+
+ <li><a href="../symbols/SpazTimeline.html">SpazTimeline</a></li>
+
+ <li><a href="../symbols/SpazTimelineFilter.html">SpazTimelineFilter</a></li>
+
+ <li><a href="../symbols/SpazTimelineNav.html">SpazTimelineNav</a></li>
+
+ <li><a href="../symbols/SpazTMDB.html">SpazTMDB</a></li>
+
+ <li><a href="../symbols/SpazTwit.html">SpazTwit</a></li>
+
+ <li><a href="../symbols/SpazTwitterStream.html">SpazTwitterStream</a></li>
+
+</ul>
+
+<p class="class_index index_link"><span>&#x21A9;</span> <a href="../index.html">Class Index</a></p>
+<p class="class_index index_link"><span>&#x21A9;</span> <a href="../files.html">File Index</a></p>
+
+ </div>
+
+ <div id="content">
+ <h1>
+
+ Class SpazAuth
+ </h1>
+ <div id="content_wrapper">
+
+
+
+
+ <p>
+ SpazAuth
+ </p>
+
+
+ <p class="defined">
+ Defined in: <a href="../symbols/src/_Users_coj_Sites_spazcore_libs_spazauth.js.html">spazauth.js</a>.
+ </p>
+
+
+ <!-- ============================== constructor summary ==================== -->
+
+ <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class SpazAuth.">
+ <caption>Class Summary</caption>
+ <thead>
+ <tr>
+ <th scope="col">Constructor Attributes</th>
+ <th scope="col">Constructor Name and Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td class="attributes">
+ &nbsp;
+ </td>
+ <td class="nameDescription" >
+ <div class="fixedFont">
+ <strong><a href="../symbols/SpazAuth.html#constructor">SpazAuth</a></strong>(service)
+ </div>
+ <p class="description">Construct a new authentication object.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+
+ <!-- ============================== properties summary ===================== -->
+
+
+ <!-- ============================== methods summary ======================== -->
+
+
+
+ <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class SpazAuth.