Files
picasa/docs/Picasa.html
Esteban Uscanga 1fe6905397 Updated docu
2018-03-03 18:48:13 +01:00

533 lines
5.9 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Picasa</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: Picasa</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>Picasa<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">Main class</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="Picasa"><span class="type-signature"></span>new Picasa<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Creates an instance of Picasa.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="picasa.js.html">picasa.js</a>, <a href="picasa.js.html#line20">line 20</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="getAccessToken"><span class="type-signature"></span>getAccessToken<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Get Access Token
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="picasa.js.html">picasa.js</a>, <a href="picasa.js.html#line61">line 61</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getPhotos"><span class="type-signature"></span>getPhotos<span class="signature">(accessToken, options, callback)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<div class="description">
Get Photos
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>accessToken</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">See <a href="Picasa.html#getAccessToken">Picasa#getAccessToken</a></td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Can be empty object
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>maxResults</code></td>
<td class="type">
<span class="param-type">integer</span>
</td>
<td class="description last">By default get all photos</td>
</tr>
<tr>
<td class="name"><code>albumId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">By default all photos are selected</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">(error, response). If not provided, a promise will be returned</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="picasa.js.html">picasa.js</a>, <a href="picasa.js.html#line42">line 42</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Picasa.html">Picasa</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 28 2018 06:31:55 GMT+0100 (CET)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>