fluro
Version:
Promise based HTTP Fluro client for the browser and node.js
426 lines (126 loc) • 5.53 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>asset - Documentation</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.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav >
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Fluro.asset.html">asset</a><ul class='methods'><li data-type='method'><a href="Fluro.asset.html#.getUrl">getUrl</a></li></ul></li><li><a href="FluroAPI.html">FluroAPI</a></li><li><a href="FluroCore.html">FluroCore</a></li></ul><h3>Modules</h3><ul><li><a href="fluro.module_asset.html">asset</a></li></ul>
</nav>
<div id="main">
<h1 class="page-title">asset</h1>
<section>
<header>
<h2>
asset
</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="asset"><span class="type-signature"></span>new asset<span class="signature">(fluro)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fluro.asset.js.html">fluro.asset.js</a>, <a href="fluro.asset.js.html#line17">line 17</a>
</li></ul></dd>
</dl>
<div class="description">
Creates a new FluroAsset instance.
This module provides a number of helper functions for managing asset, image, video and audio items in Fluro
</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>fluro</code></td>
<td class="type">
<span class="param-type"><a href="FluroCore.html">FluroCore</a></span>
</td>
<td class="description last">A reference to the parent instance of the FluroCore module. The FluroAsset module is usually created by a FluroCore instance that passes itself in as the first argument.</td>
</tr>
</tbody>
</table>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".getUrl"><span class="type-signature">(static) </span>getUrl<span class="signature">(assetID, params)</span><span class="type-signature"> → {string}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fluro.asset.js.html">fluro.asset.js</a>, <a href="fluro.asset.js.html#line94">line 94</a>
</li></ul></dd>
</dl>
<div class="description">
This function generates a url for the binary data of an
asset, image, audio, or video file that has been uploaded to Fluro
</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>assetID</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The _id of the item you want to retrieve</td>
</tr>
<tr>
<td class="name"><code>params</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
A valid Fluro URL
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 13 2019 22:12:51 GMT+1000 (Australian Eastern Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/polyfill.js"></script>
<script src="scripts/linenumber.js"></script>
</body>
</html>