fluro
Version:
Promise based HTTP Fluro client for the browser and node.js
1,075 lines (287 loc) • 20.1 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>FluroCore - 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="FluroAccess.html">FluroAccess</a><ul class='methods'><li data-type='method'><a href="FluroAccess.html#.addEventListener">addEventListener</a></li><li data-type='method'><a href="FluroAccess.html#.can">can</a></li><li data-type='method'><a href="FluroAccess.html#.canDeleteItem">canDeleteItem</a></li><li data-type='method'><a href="FluroAccess.html#.canEditItem">canEditItem</a></li><li data-type='method'><a href="FluroAccess.html#.canViewItem">canViewItem</a></li><li data-type='method'><a href="FluroAccess.html#.has">has</a></li><li data-type='method'><a href="FluroAccess.html#.isAuthor">isAuthor</a></li><li data-type='method'><a href="FluroAccess.html#.removeAllListeners">removeAllListeners</a></li><li data-type='method'><a href="FluroAccess.html#.removeEventListener">removeEventListener</a></li><li data-type='method'><a href="FluroAccess.html#.retrieveActionableRealms">retrieveActionableRealms</a></li><li data-type='method'><a href="FluroAccess.html#.retrieveCurrentSession">retrieveCurrentSession</a></li><li data-type='method'><a href="FluroAccess.html#.setDefaultApplication">setDefaultApplication</a></li></ul></li><li><a href="FluroAPI.html">FluroAPI</a><ul class='methods'><li data-type='method'><a href="FluroAPI.html#.delete">delete</a></li><li data-type='method'><a href="FluroAPI.html#.get">get</a></li><li data-type='method'><a href="FluroAPI.html#.post">post</a></li><li data-type='method'><a href="FluroAPI.html#.put">put</a></li></ul></li><li><a href="FluroAsset.html">FluroAsset</a><ul class='methods'><li data-type='method'><a href="FluroAsset.html#.avatarUrl">avatarUrl</a></li><li data-type='method'><a href="FluroAsset.html#.downloadUrl">downloadUrl</a></li><li data-type='method'><a href="FluroAsset.html#.filesize">filesize</a></li><li data-type='method'><a href="FluroAsset.html#.getUrl">getUrl</a></li><li data-type='method'><a href="FluroAsset.html#.imageUrl">imageUrl</a></li><li data-type='method'><a href="FluroAsset.html#.playerUrl">playerUrl</a></li><li data-type='method'><a href="FluroAsset.html#.posterUrl">posterUrl</a></li></ul></li><li><a href="FluroAuth.html">FluroAuth</a><ul class='methods'><li data-type='method'><a href="FluroAuth.html#.addEventListener">addEventListener</a></li><li data-type='method'><a href="FluroAuth.html#.changeAccount">changeAccount</a></li><li data-type='method'><a href="FluroAuth.html#.getCurrentToken">getCurrentToken</a></li><li data-type='method'><a href="FluroAuth.html#.getCurrentUser">getCurrentUser</a></li><li data-type='method'><a href="FluroAuth.html#.login">login</a></li><li data-type='method'><a href="FluroAuth.html#.logout">logout</a></li><li data-type='method'><a href="FluroAuth.html#.refreshAccessToken">refreshAccessToken</a></li><li data-type='method'><a href="FluroAuth.html#.removeAllListeners">removeAllListeners</a></li><li data-type='method'><a href="FluroAuth.html#.removeEventListener">removeEventListener</a></li><li data-type='method'><a href="FluroAuth.html#.retrieveUserFromResetToken">retrieveUserFromResetToken</a></li><li data-type='method'><a href="FluroAuth.html#.sendResetPasswordRequest">sendResetPasswordRequest</a></li><li data-type='method'><a href="FluroAuth.html#.set">set</a></li><li data-type='method'><a href="FluroAuth.html#.signup">signup</a></li><li data-type='method'><a href="FluroAuth.html#.sync">sync</a></li><li data-type='method'><a href="FluroAuth.html#.updateUserWithToken">updateUserWithToken</a></li></ul></li><li><a href="FluroCache.html">FluroCache</a><ul class='methods'><li data-type='method'><a href="FluroCache.html#.get">get</a></li><li data-type='method'><a href="FluroCache.html#.reset">reset</a></li></ul></li><li><a href="FluroContent.html">FluroContent</a><ul class='methods'><li data-type='method'><a href="FluroContent.html#.external">external</a></li><li data-type='method'><a href="FluroContent.html#.form">form</a></li><li data-type='method'><a href="FluroContent.html#.get">get</a></li><li data-type='method'><a href="FluroContent.html#.keys">keys</a></li><li data-type='method'><a href="FluroContent.html#.query">query</a></li><li data-type='method'><a href="FluroContent.html#.related">related</a></li><li data-type='method'><a href="FluroContent.html#.retrieve">retrieve</a></li><li data-type='method'><a href="FluroContent.html#.slug">slug</a></li><li data-type='method'><a href="FluroContent.html#.submitInteraction">submitInteraction</a></li><li data-type='method'><a href="FluroContent.html#.submitPost">submitPost</a></li><li data-type='method'><a href="FluroContent.html#.thread">thread</a></li><li data-type='method'><a href="FluroContent.html#.values">values</a></li></ul></li><li><a href="FluroCore.html">FluroCore</a></li><li><a href="FluroDate.html">FluroDate</a><ul class='methods'><li data-type='method'><a href="FluroDate.html#.dateFromID">dateFromID</a></li><li data-type='method'><a href="FluroDate.html#.formatDate">formatDate</a></li><li data-type='method'><a href="FluroDate.html#.isMultiDayEvent">isMultiDayEvent</a></li><li data-type='method'><a href="FluroDate.html#.localDate">localDate</a></li><li data-type='method'><a href="FluroDate.html#.readableEventDate">readableEventDate</a></li><li data-type='method'><a href="FluroDate.html#.readableEventTime">readableEventTime</a></li><li data-type='method'><a href="FluroDate.html#.timeago">timeago</a></li><li data-type='method'><a href="FluroDate.html#.timezones">timezones</a></li></ul></li><li><a href="FluroTypes.html">FluroTypes</a><ul class='methods'><li data-type='method'><a href="FluroTypes.html#.all">all</a></li><li data-type='method'><a href="FluroTypes.html#.get">get</a></li><li data-type='method'><a href="FluroTypes.html#.readable">readable</a></li><li data-type='method'><a href="FluroTypes.html#.reloadTerminology">reloadTerminology</a></li><li data-type='method'><a href="FluroTypes.html#.retrieve">retrieve</a></li></ul></li><li><a href="FluroUtils.html">FluroUtils</a><ul class='methods'><li data-type='method'><a href="FluroUtils.html#.arrayIDs">arrayIDs</a></li><li data-type='method'><a href="FluroUtils.html#.comma">comma</a></li><li data-type='method'><a href="FluroUtils.html#.errorMessage">errorMessage</a></li><li data-type='method'><a href="FluroUtils.html#.getDefaultValueForField">getDefaultValueForField</a></li><li data-type='method'><a href="FluroUtils.html#.getStringID">getStringID</a></li><li data-type='method'><a href="FluroUtils.html#.guid">guid</a></li><li data-type='method'><a href="FluroUtils.html#.hash">hash</a></li><li data-type='method'><a href="FluroUtils.html#.mapParameters">mapParameters</a></li><li data-type='method'><a href="FluroUtils.html#.matchInArray">matchInArray</a></li></ul></li></ul>
</nav>
<div id="main">
<h1 class="page-title">FluroCore</h1>
<section>
<header>
<h2>
FluroCore
</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="FluroCore"><span class="type-signature"></span>new FluroCore<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#line61">line 61</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"> :<a href="FluroAccess.html">FluroAccess</a></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#line200">line 200</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"><a href="FluroAccess.html">FluroAccess</a></span>
</li>
</ul>
<h4 class="name" id="~api"><span class="type-signature">(inner) </span>api<span class="type-signature"> :<a href="FluroAPI.html">FluroAPI</a></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#line168">line 168</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"><a href="FluroAPI.html">FluroAPI</a></span>
</li>
</ul>
<h4 class="name" id="~asset"><span class="type-signature">(inner) </span>asset<span class="type-signature"> :<a href="FluroAsset.html">FluroAsset</a></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#line213">line 213</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"><a href="FluroAsset.html">FluroAsset</a></span>
</li>
</ul>
<h4 class="name" id="~auth"><span class="type-signature">(inner) </span>auth<span class="type-signature"> :<a href="FluroAuth.html">FluroAuth</a></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 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"><a href="FluroAuth.html">FluroAuth</a></span>
</li>
</ul>
<h4 class="name" id="~cache"><span class="type-signature">(inner) </span>cache<span class="type-signature"> :<a href="FluroCache.html">FluroCache</a></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#line115">line 115</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"><a href="FluroCache.html">FluroCache</a></span>
</li>
</ul>
<h4 class="name" id="~content"><span class="type-signature">(inner) </span>content<span class="type-signature"> :<a href="FluroContent.html">FluroContent</a></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">
A helper service for CRUD operations that wraps around the fluro.api service
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="FluroContent.html">FluroContent</a></span>
</li>
</ul>
<h4 class="name" id="~date"><span class="type-signature">(inner) </span>date<span class="type-signature"> :<a href="FluroDate.html">FluroDate</a></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#line156">line 156</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"><a href="FluroDate.html">FluroDate</a></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#line225">line 225</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"> :<a href="FluroTypes.html">FluroTypes</a></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#line236">line 236</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"><a href="FluroTypes.html">FluroTypes</a></span>
</li>
</ul>
<h4 class="name" id="~utils"><span class="type-signature">(inner) </span>utils<span class="type-signature"> :<a href="FluroUtils.html">FluroUtils</a></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#line127">line 127</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"><a href="FluroUtils.html">FluroUtils</a></span>
</li>
</ul>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Sep 05 2019 21:42:53 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>