fluro
Version:
Promise based HTTP Fluro client for the browser and node.js
241 lines (77 loc) • 11.6 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>FluroAsset - 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">
<script src="scripts/nav.js" defer></script>
<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.html">fluro</a></li><li><a href="fluro.access.html">access</a><ul class='methods'><li data-type='method'><a href="fluro.access.html#.addEventListener">addEventListener</a></li><li data-type='method'><a href="fluro.access.html#.can">can</a></li><li data-type='method'><a href="fluro.access.html#.canDeleteItem">canDeleteItem</a></li><li data-type='method'><a href="fluro.access.html#.canEditItem">canEditItem</a></li><li data-type='method'><a href="fluro.access.html#.canKnowOf">canKnowOf</a></li><li data-type='method'><a href="fluro.access.html#.canViewItem">canViewItem</a></li><li data-type='method'><a href="fluro.access.html#.has">has</a></li><li data-type='method'><a href="fluro.access.html#.isAuthor">isAuthor</a></li><li data-type='method'><a href="fluro.access.html#.removeAllListeners">removeAllListeners</a></li><li data-type='method'><a href="fluro.access.html#.removeEventListener">removeEventListener</a></li><li data-type='method'><a href="fluro.access.html#.retrieveActionableRealms">retrieveActionableRealms</a></li><li data-type='method'><a href="fluro.access.html#.retrieveCurrentSession">retrieveCurrentSession</a></li><li data-type='method'><a href="fluro.access.html#.setDefaultApplication">setDefaultApplication</a></li></ul></li><li><a href="fluro.api.html">api</a><ul class='methods'><li data-type='method'><a href="fluro.api.html#.delete">delete</a></li><li data-type='method'><a href="fluro.api.html#.get">get</a></li><li data-type='method'><a href="fluro.api.html#.post">post</a></li><li data-type='method'><a href="fluro.api.html#.put">put</a></li></ul></li><li><a href="fluro.auth.html">auth</a><ul class='methods'><li data-type='method'><a href="fluro.auth.html#.addEventListener">addEventListener</a></li><li data-type='method'><a href="fluro.auth.html#.changeAccount">changeAccount</a></li><li data-type='method'><a href="fluro.auth.html#.getCurrentToken">getCurrentToken</a></li><li data-type='method'><a href="fluro.auth.html#.getCurrentUser">getCurrentUser</a></li><li data-type='method'><a href="fluro.auth.html#.impersonate">impersonate</a></li><li data-type='method'><a href="fluro.auth.html#.login">login</a></li><li data-type='method'><a href="fluro.auth.html#.logout">logout</a></li><li data-type='method'><a href="fluro.auth.html#.refreshAccessToken">refreshAccessToken</a></li><li data-type='method'><a href="fluro.auth.html#.removeAllListeners">removeAllListeners</a></li><li data-type='method'><a href="fluro.auth.html#.removeEventListener">removeEventListener</a></li><li data-type='method'><a href="fluro.auth.html#.retrieveUserFromResetToken">retrieveUserFromResetToken</a></li><li data-type='method'><a href="fluro.auth.html#.sendResetPasswordRequest">sendResetPasswordRequest</a></li><li data-type='method'><a href="fluro.auth.html#.set">set</a></li><li data-type='method'><a href="fluro.auth.html#.signup">signup</a></li><li data-type='method'><a href="fluro.auth.html#.updateUserWithToken">updateUserWithToken</a></li></ul></li><li><a href="fluro.cache.html">cache</a><ul class='methods'><li data-type='method'><a href="fluro.cache.html#.get">get</a></li><li data-type='method'><a href="fluro.cache.html#.reset">reset</a></li></ul></li><li><a href="fluro.components.html">components</a><ul class='methods'><li data-type='method'><a href="fluro.components.html#.hydrateModel">hydrateModel</a></li></ul></li><li><a href="fluro.content.html">content</a><ul class='methods'><li data-type='method'><a href="fluro.content.html#.duplicate">duplicate</a></li><li data-type='method'><a href="fluro.content.html#.external">external</a></li><li data-type='method'><a href="fluro.content.html#.form">form</a></li><li data-type='method'><a href="fluro.content.html#.get">get</a></li><li data-type='method'><a href="fluro.content.html#.keys">keys</a></li><li data-type='method'><a href="fluro.content.html#.query">query</a></li><li data-type='method'><a href="fluro.content.html#.related">related</a></li><li data-type='method'><a href="fluro.content.html#.retrieve">retrieve</a></li><li data-type='method'><a href="fluro.content.html#.slug">slug</a></li><li data-type='method'><a href="fluro.content.html#.submitInteraction">submitInteraction</a></li><li data-type='method'><a href="fluro.content.html#.submitPost">submitPost</a></li><li data-type='method'><a href="fluro.content.html#.thread">thread</a></li><li data-type='method'><a href="fluro.content.html#.values">values</a></li></ul></li><li><a href="fluro.date.html">date</a><ul class='methods'><li data-type='method'><a href="fluro.date.html#.countdown">countdown</a></li><li data-type='method'><a href="fluro.date.html#.dateFromID">dateFromID</a></li><li data-type='method'><a href="fluro.date.html#.formatDate">formatDate</a></li><li data-type='method'><a href="fluro.date.html#.getAge">getAge</a></li><li data-type='method'><a href="fluro.date.html#.groupEventByDate">groupEventByDate</a></li><li data-type='method'><a href="fluro.date.html#.isDifferentTimezoneThanUser">isDifferentTimezoneThanUser</a></li><li data-type='method'><a href="fluro.date.html#.isMultiDayEvent">isMultiDayEvent</a></li><li data-type='method'><a href="fluro.date.html#.localDate">localDate</a></li><li data-type='method'><a href="fluro.date.html#.readableEventDate">readableEventDate</a></li><li data-type='method'><a href="fluro.date.html#.readableEventTime">readableEventTime</a></li><li data-type='method'><a href="fluro.date.html#.timeago">timeago</a></li><li data-type='method'><a href="fluro.date.html#.timeline">timeline</a></li><li data-type='method'><a href="fluro.date.html#.timestampToAmPm">timestampToAmPm</a></li><li data-type='method'><a href="fluro.date.html#.timezones">timezones</a></li></ul></li><li><a href="fluro.types.html">types</a><ul class='methods'><li data-type='method'><a href="fluro.types.html#.all">all</a></li><li data-type='method'><a href="fluro.types.html#.basicTypes">basicTypes</a></li><li data-type='method'><a href="fluro.types.html#.get">get</a></li><li data-type='method'><a href="fluro.types.html#.mapDefinitionItems">mapDefinitionItems</a></li><li data-type='method'><a href="fluro.types.html#.parentType">parentType</a></li><li data-type='method'><a href="fluro.types.html#.postableTypes">postableTypes</a></li><li data-type='method'><a href="fluro.types.html#.readable">readable</a></li><li data-type='method'><a href="fluro.types.html#.reloadTerminology">reloadTerminology</a></li><li data-type='method'><a href="fluro.types.html#.retrieve">retrieve</a></li><li data-type='method'><a href="fluro.types.html#.subTypes">subTypes</a></li><li data-type='method'><a href="fluro.types.html#.term">term</a></li></ul></li><li><a href="fluro.utils.html">utils</a><ul class='methods'><li data-type='method'><a href="fluro.utils.html#.arrayIDs">arrayIDs</a></li><li data-type='method'><a href="fluro.utils.html#.comma">comma</a></li><li data-type='method'><a href="fluro.utils.html#.currencySymbol">currencySymbol</a></li><li data-type='method'><a href="fluro.utils.html#.errorMessage">errorMessage</a></li><li data-type='method'><a href="fluro.utils.html#.formatCurrency">formatCurrency</a></li><li data-type='method'><a href="fluro.utils.html#.getDefaultValueForField">getDefaultValueForField</a></li><li data-type='method'><a href="fluro.utils.html#.getFlattenedFields">getFlattenedFields</a></li><li data-type='method'><a href="fluro.utils.html#.getStringID">getStringID</a></li><li data-type='method'><a href="fluro.utils.html#.guid">guid</a></li><li data-type='method'><a href="fluro.utils.html#.hash">hash</a></li><li data-type='method'><a href="fluro.utils.html#.injectScript">injectScript</a></li><li data-type='method'><a href="fluro.utils.html#.machineName">machineName</a></li><li data-type='method'><a href="fluro.utils.html#.mapParameters">mapParameters</a></li><li data-type='method'><a href="fluro.utils.html#.matchInArray">matchInArray</a></li><li data-type='method'><a href="fluro.utils.html#.processCardPrioritySort">processCardPrioritySort</a></li></ul></li><li><a href="fluro.video.html">video</a><ul class='methods'><li data-type='method'><a href="fluro.video.html#.hhmmss">hhmmss</a></li><li data-type='method'><a href="fluro.video.html#.readableMilliseconds">readableMilliseconds</a></li><li data-type='method'><a href="fluro.video.html#.readableSeconds">readableSeconds</a></li></ul></li><li><a href="FluroAsset.html">FluroAsset</a></li></ul>
</nav>
<div id="main">
<h1 class="page-title">FluroAsset</h1>
<section>
<header>
<h2>
FluroAsset
</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="FluroAsset"><span class="type-signature"></span>new FluroAsset<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#line14">line 14</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">FluroCore</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>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Aug 06 2020 08:03:50 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>