fluro

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>fluro - Documentation</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script>  <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="access.html">access</a><ul class='methods'><li data-type='method'><a href="access.html#.addEventListener">addEventListener</a></li><li data-type='method'><a href="access.html#.can">can</a></li><li data-type='method'><a href="access.html#.canDeleteItem">canDeleteItem</a></li><li data-type='method'><a href="access.html#.canEditItem">canEditItem</a></li><li data-type='method'><a href="access.html#.canKnowOf">canKnowOf</a></li><li data-type='method'><a href="access.html#.canViewItem">canViewItem</a></li><li data-type='method'><a href="access.html#.has">has</a></li><li data-type='method'><a href="access.html#.isAuthor">isAuthor</a></li><li data-type='method'><a href="access.html#.removeAllListeners">removeAllListeners</a></li><li data-type='method'><a href="access.html#.removeEventListener">removeEventListener</a></li><li data-type='method'><a href="access.html#.retrieveActionableRealms">retrieveActionableRealms</a></li><li data-type='method'><a href="access.html#.retrieveCurrentSession">retrieveCurrentSession</a></li><li data-type='method'><a href="access.html#.setDefaultApplication">setDefaultApplication</a></li></ul></li><li><a href="api.html">api</a><ul class='methods'><li data-type='method'><a href="api.html#.delete">delete</a></li><li data-type='method'><a href="api.html#.generateEndpointURL">generateEndpointURL</a></li><li data-type='method'><a href="api.html#.get">get</a></li><li data-type='method'><a href="api.html#.post">post</a></li><li data-type='method'><a href="api.html#.put">put</a></li></ul></li><li><a href="app.device.html">device</a></li><li><a href="asset.html">asset</a><ul class='methods'><li data-type='method'><a href="asset.html#.avatarUrl">avatarUrl</a></li><li data-type='method'><a href="asset.html#.downloadUrl">downloadUrl</a></li><li data-type='method'><a href="asset.html#.filesize">filesize</a></li><li data-type='method'><a href="asset.html#.getUrl">getUrl</a></li><li data-type='method'><a href="asset.html#.imageUrl">imageUrl</a></li><li data-type='method'><a href="asset.html#.playerUrl">playerUrl</a></li><li data-type='method'><a href="asset.html#.posterUrl">posterUrl</a></li><li data-type='method'><a href="asset.html#.typeFromMime">typeFromMime</a></li></ul></li><li><a href="auth.html">auth</a><ul class='methods'><li data-type='method'><a href="auth.html#.addEventListener">addEventListener</a></li><li data-type='method'><a href="auth.html#.changeAccount">changeAccount</a></li><li data-type='method'><a href="auth.html#.getCurrentToken">getCurrentToken</a></li><li data-type='method'><a href="auth.html#.getCurrentUser">getCurrentUser</a></li><li data-type='method'><a href="auth.html#.impersonate">impersonate</a></li><li data-type='method'><a href="auth.html#.login">login</a></li><li data-type='method'><a href="auth.html#.logout">logout</a></li><li data-type='method'><a href="auth.html#.refreshAccessToken">refreshAccessToken</a></li><li data-type='method'><a href="auth.html#.removeAllListeners">removeAllListeners</a></li><li data-type='method'><a href="auth.html#.removeEventListener">removeEventListener</a></li><li data-type='method'><a href="auth.html#.retrieveUserFromResetToken">retrieveUserFromResetToken</a></li><li data-type='method'><a href="auth.html#.sendResetPasswordRequest">sendResetPasswordRequest</a></li><li data-type='method'><a href="auth.html#.set">set</a></li><li data-type='method'><a href="auth.html#.signup">signup</a></li><li data-type='method'><a href="auth.html#.updateUserWithToken">updateUserWithToken</a></li></ul></li><li><a href="cache.html">cache</a><ul class='methods'><li data-type='method'><a href="cache.html#.get">get</a></li><li data-type='method'><a href="cache.html#.reset">reset</a></li></ul></li><li><a href="components.html">components</a><ul class='methods'><li data-type='method'><a href="components.html#.hydrateModel">hydrateModel</a></li></ul></li><li><a href="content.html">content</a><ul class='methods'><li data-type='method'><a href="content.html#.duplicate">duplicate</a></li><li data-type='method'><a href="content.html#.external">external</a></li><li data-type='method'><a href="content.html#.filter">filter</a></li><li data-type='method'><a href="content.html#.form">form</a></li><li data-type='method'><a href="content.html#.get">get</a></li><li data-type='method'><a href="content.html#.getMultiple">getMultiple</a></li><li data-type='method'><a href="content.html#.keys">keys</a></li><li data-type='method'><a href="content.html#.list">list</a></li><li data-type='method'><a href="content.html#.query">query</a></li><li data-type='method'><a href="content.html#.related">related</a></li><li data-type='method'><a href="content.html#.retrieve">retrieve</a></li><li data-type='method'><a href="content.html#.slug">slug</a></li><li data-type='method'><a href="content.html#.submitInteraction">submitInteraction</a></li><li data-type='method'><a href="content.html#.submitPost">submitPost</a></li><li data-type='method'><a href="content.html#.thread">thread</a></li><li data-type='method'><a href="content.html#.values">values</a></li></ul></li><li><a href="date.html">date</a><ul class='methods'><li data-type='method'><a href="date.html#.countdown">countdown</a></li><li data-type='method'><a href="date.html#.dateFromID">dateFromID</a></li><li data-type='method'><a href="date.html#.formatDate">formatDate</a></li><li data-type='method'><a href="date.html#.getAge">getAge</a></li><li data-type='method'><a href="date.html#.groupEventByDate">groupEventByDate</a></li><li data-type='method'><a href="date.html#.isDifferentTimezoneThanUser">isDifferentTimezoneThanUser</a></li><li data-type='method'><a href="date.html#.isMultiDayEvent">isMultiDayEvent</a></li><li data-type='method'><a href="date.html#.localDate">localDate</a></li><li data-type='method'><a href="date.html#.militaryTimestamp">militaryTimestamp</a></li><li data-type='method'><a href="date.html#.readableEventDate">readableEventDate</a></li><li data-type='method'><a href="date.html#.readableEventTime">readableEventTime</a></li><li data-type='method'><a href="date.html#.timeago">timeago</a></li><li data-type='method'><a href="date.html#.timeline">timeline</a></li><li data-type='method'><a href="date.html#.timestampToAmPm">timestampToAmPm</a></li><li data-type='method'><a href="date.html#.timezones">timezones</a></li></ul></li><li><a href="fluro.html">fluro</a></li><li><a href="types.html">types</a><ul class='methods'><li data-type='method'><a href="types.html#.all">all</a></li><li data-type='method'><a href="types.html#.basicTypes">basicTypes</a></li><li data-type='method'><a href="types.html#.get">get</a></li><li data-type='method'><a href="types.html#.mapDefinitionItems">mapDefinitionItems</a></li><li data-type='method'><a href="types.html#.parentType">parentType</a></li><li data-type='method'><a href="types.html#.postableTypes">postableTypes</a></li><li data-type='method'><a href="types.html#.readable">readable</a></li><li data-type='method'><a href="types.html#.reloadTerminology">reloadTerminology</a></li><li data-type='method'><a href="types.html#.retrieve">retrieve</a></li><li data-type='method'><a href="types.html#.subTypes">subTypes</a></li><li data-type='method'><a href="types.html#.term">term</a></li></ul></li><li><a href="utils.html">utils</a><ul class='methods'><li data-type='method'><a href="utils.html#.arrayIDs">arrayIDs</a></li><li data-type='method'><a href="utils.html#.comma">comma</a></li><li data-type='method'><a href="utils.html#.currencySymbol">currencySymbol</a></li><li data-type='method'><a href="utils.html#.errorMessage">errorMessage</a></li><li data-type='method'><a href="utils.html#.extractFromArray">extractFromArray</a></li><li data-type='method'><a href="utils.html#.formatCurrency">formatCurrency</a></li><li data-type='method'><a href="utils.html#.getDefaultValueForField">getDefaultValueForField</a></li><li data-type='method'><a href="utils.html#.getFlattenedFields">getFlattenedFields</a></li><li data-type='method'><a href="utils.html#.getStringID">getStringID</a></li><li data-type='method'><a href="utils.html#.guid">guid</a></li><li data-type='method'><a href="utils.html#.hash">hash</a></li><li data-type='method'><a href="utils.html#.injectScript">injectScript</a></li><li data-type='method'><a href="utils.html#.machineName">machineName</a></li><li data-type='method'><a href="utils.html#.mapParameters">mapParameters</a></li><li data-type='method'><a href="utils.html#.matchInArray">matchInArray</a></li><li data-type='method'><a href="utils.html#.processCardPrioritySort">processCardPrioritySort</a></li></ul></li><li><a href="video.html">video</a><ul class='methods'><li data-type='method'><a href="video.html#.hhmmss">hhmmss</a></li><li data-type='method'><a href="video.html#.readableMilliseconds">readableMilliseconds</a></li><li data-type='method'><a href="video.html#.readableSeconds">readableSeconds</a></li></ul></li></ul> </nav> <div id="main"> <h1 class="page-title">fluro</h1> <section> <header> <h2> fluro </h2> </header> <article> <div class="container-overview"> <h4 class="name" id="fluro"><span class="type-signature"></span>new fluro<span class="signature">(options)</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.core.js.html">fluro.core.js</a>, <a href="fluro.core.js.html#line64">line 64</a> </li></ul></dd> </dl> <div class="description"> Creates a new FluroCore instance including all of the default sub modules </div> <h5>Example</h5> <pre class="prettyprint"><code>//Import the Fluro package import Fluro from 'fluro'; //Create a new Fluro instance var fluro = new Fluro(); //Request the current user session endpoint from the Fluro API fluro.api.get('/session').then(function(res) { console.log('User session is ', res.data); }) .catch(function(err) { console.log('There was an error', err); }); //Use the FluroAsset package to generate an image url var link = fluro.asset.imageUrl('5ca3d64dd2bb085eb9d450db', 1920, 1080)</code></pre> <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>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"> <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>apiURL</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The remote URL of the Fluro API you want to connect to. Options are 'staging', 'production' or you may set a specific URL eg. 'https://api.fluro.io' (do not include trailing slash). If no value is provided, will default to 'production'.</td> </tr> <tr> <td class="name"><code>applicationToken</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">When running as a static application, (for example a website) you may set the application's access token before you initialize the Fluro instance here.</td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </div> <h3 class="subsection-title">Members</h3> <h4 class="name" id="~access"><span class="type-signature">(inner) </span>access<span class="type-signature"> :FluroAccess</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="fluro.core.js.html">fluro.core.js</a>, <a href="fluro.core.js.html#line291">line 291</a> </li></ul></dd> </dl> <div class="description"> A helper service for understanding a user's access permissions </div> <h5>Type:</h5> <ul> <li> <span class="param-type">FluroAccess</span> </li> </ul> <h4 class="name" id="~api"><span class="type-signature">(inner) </span>api<span class="type-signature"> :FluroAPI</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="fluro.core.js.html">fluro.core.js</a>, <a href="fluro.core.js.html#line190">line 190</a> </li></ul></dd> </dl> <div class="description"> The default service for interacting with the Fluro REST API, it's a wrapper around the axios library that works in conjunction with the other Fluro modules </div> <h5>Type:</h5> <ul> <li> <span class="param-type">FluroAPI</span> </li> </ul> <h4 class="name" id="~asset"><span class="type-signature">(inner) </span>asset<span class="type-signature"> :FluroAsset</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="fluro.core.js.html">fluro.core.js</a>, <a href="fluro.core.js.html#line258">line 258</a> </li></ul></dd> </dl> <div class="description"> The default service for managing, rendering and handling files and media from Fluro. It contains helper functions for managing connecting to image, audio, asset and video api endpoints. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">FluroAsset</span> </li> </ul> <h4 class="name" id="~auth"><span class="type-signature">(inner) </span>auth<span class="type-signature"> :FluroAuth</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="fluro.core.js.html">fluro.core.js</a>, <a href="fluro.core.js.html#line218">line 218</a> </li></ul></dd> </dl> <div class="description"> The default service for managing authentication handles automatic refreshing of access tokens, and provides login, logout and other user/application specific functionality </div> <h5>Type:</h5> <ul> <li> <span class="param-type">FluroAuth</span> </li> </ul> <h4 class="name" id="~cache"><span class="type-signature">(inner) </span>cache<span class="type-signature"> :FluroCache</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="fluro.core.js.html">fluro.core.js</a>, <a href="fluro.core.js.html#line125">line 125</a> </li></ul></dd> </dl> <div class="description"> Provides a cache service, used for creating, clearing and storing API requests and other information in memory </div> <h5>Type:</h5> <ul> <li> <span class="param-type">FluroCache</span> </li> </ul> <h4 class="name" id="~components"><span class="type-signature">(inner) </span>components<span class="type-signature"> :FluroComponents</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="fluro.core.js.html">fluro.core.js</a>, <a href="fluro.core.js.html#line229">line 229</a> </li></ul></dd> </dl> <div class="description"> Provides helper functions for working with Fluro Components </div> <h5>Type:</h5> <ul> <li> <span class="param-type">FluroComponents</span> </li> </ul> <h4 class="name" id="~content"><span class="type-signature">(inner) </span>content<span class="type-signature"> :FluroContent</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="fluro.core.js.html">fluro.core.js</a>, <a href="fluro.core.js.html#line206">line 206</a> </li></ul></dd> </dl> <div class="description"> A helper service for CRUD operations that wraps around the fluro.api service </div> <h5>Type:</h5> <ul> <li> <span class="param-type">FluroContent</span> </li> </ul> <h4 class="name" id="~date"><span class="type-signature">(inner) </span>date<span class="type-signature"> :FluroDate</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="fluro.core.js.html">fluro.core.js</a>, <a href="fluro.core.js.html#line178">line 178</a> </li></ul></dd> </dl> <div class="description"> Provides date functions, filters and utilities for working with dates and timezones </div> <h5>Type:</h5> <ul> <li> <span class="param-type">FluroDate</span> </li> </ul> <h4 class="name" id="~device"><span class="type-signature">(inner) </span>device<span class="type-signature"> :FluroDevice</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="fluro.core.js.html">fluro.core.js</a>, <a href="fluro.core.js.html#line149">line 149</a> </li></ul></dd> </dl> <div class="description"> Provides helper functions for understanding the users device </div> <h5>Type:</h5> <ul> <li> <span class="param-type">FluroDevice</span> </li> </ul> <h4 class="name" id="~stats"><span class="type-signature">(inner) </span>stats<span class="type-signature"> :FluroStats</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="fluro.core.js.html">fluro.core.js</a>, <a href="fluro.core.js.html#line270">line 270</a> </li></ul></dd> </dl> <div class="description"> The default service for handling a user's 'stats' eg. (likes, views, favorites, downvotes etc...) This service creates and syncs user's stats when they 'stat' items from Fluro. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">FluroStats</span> </li> </ul> <h4 class="name" id="~types"><span class="type-signature">(inner) </span>types<span class="type-signature"> :FluroTypes</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="fluro.core.js.html">fluro.core.js</a>, <a href="fluro.core.js.html#line281">line 281</a> </li></ul></dd> </dl> <div class="description"> A helper service for retrieving, translating and rendering content types and definitions defined within Fluro. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">FluroTypes</span> </li> </ul> <h4 class="name" id="~utils"><span class="type-signature">(inner) </span>utils<span class="type-signature"> :FluroUtils</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="fluro.core.js.html">fluro.core.js</a>, <a href="fluro.core.js.html#line137">line 137</a> </li></ul></dd> </dl> <div class="description"> Provides helper functions for working with Fluro data </div> <h5>Type:</h5> <ul> <li> <span class="param-type">FluroUtils</span> </li> </ul> <h4 class="name" id="~video"><span class="type-signature">(inner) </span>video<span class="type-signature"> :FluroVideo</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="fluro.core.js.html">fluro.core.js</a>, <a href="fluro.core.js.html#line245">line 245</a> </li></ul></dd> </dl> <div class="description"> Provides helper functions for working with Fluro Video data </div> <h5>Type:</h5> <ul> <li> <span class="param-type">FluroVideo</span> </li> </ul> </article> </section> </div> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 29 2021 08:38:17 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>