node-ovh-objectstorage
Version:
Simple library to use OVH Public Cloud Object Storage.
4,251 lines • 58.2 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Objects - Documentation
</title>
<link href="https://www.braintreepayments.com/images/favicon-ccda0b14.png" rel="icon" type="image/png">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.7.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script>
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
<link type="text/css" rel="stylesheet" href="styles/collapse.css">
<!-- start Mixpanel -->
<script type="text/javascript">(function(e,a){if(!a.__SV){var b=window;try{var c,l,i,j=b.location,g=j.hash;c=function(a,b){return(l=a.match(RegExp(b+"=([^&]*)")))?l[1]:null};g&&c(g,"state")&&(i=JSON.parse(decodeURIComponent(c(g,"state"))),"mpeditor"===i.action&&(b.sessionStorage.setItem("_mpcehash",g),history.replaceState(i.desiredHash||"",e.title,j.pathname+j.search)))}catch(m){}var k,h;window.mixpanel=a;a._i=[];a.init=function(b,c,f){function e(b,a){var c=a.split(".");2==c.length&&(b=b[c[0]],a=c[1]);b[a]=function(){b.push([a].concat(Array.prototype.slice.call(arguments,
0)))}}var d=a;"undefined"!==typeof f?d=a[f]=[]:f="mixpanel";d.people=d.people||[];d.toString=function(b){var a="mixpanel";"mixpanel"!==f&&(a+="."+f);b||(a+=" (stub)");return a};d.people.toString=function(){return d.toString(1)+".people (stub)"};k="disable time_event track track_pageview track_links track_forms register register_once alias unregister identify name_tag set_config reset people.set people.set_once people.increment people.append people.union people.track_charge people.clear_charges people.delete_user".split(" ");
for(h=0;h<k.length;h++)e(d,k[h]);a._i.push([b,c,f])};a.__SV=1.2;b=e.createElement("script");b.type="text/javascript";b.async=!0;b.src="undefined"!==typeof MIXPANEL_CUSTOM_LIB_URL?MIXPANEL_CUSTOM_LIB_URL:"file:"===e.location.protocol&&"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js".match(/^\/\//)?"https://cdn.mxpnl.com/libs/mixpanel-2-latest.min.js":"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js";c=e.getElementsByTagName("script")[0];c.parentNode.insertBefore(b,c)}})(document,window.mixpanel||[]);
mixpanel.init("1919205b2da72e4da3b9b6639b444d59");</script>
<!-- end Mixpanel -->
</head>
<body>
<svg style="display: none;">
<defs>
<symbol id="linkIcon" fill="#706d77" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
<path d="M0 0h24v24H0z" fill="none"/>
<path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"/>
</symbol>
</defs>
</svg>
<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>
<div class="top-nav-wrapper">
<ul>
<li >
<a href="index.html">
<svg fill="#6D6D6D" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
<path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z"/>
<path d="M0 0h24v24H0z" fill="none"/>
</svg>
</a>
</li>
</ul>
</div>
<nav>
<h3 class="reference-title">
OVH Object Storage
</h3>
<h3>Classes</h3><ul><li id="Account-nav"><a href="Account.html">Account</a><ul class='methods'><li data-type="method" id="Account-all-nav"><a href="Account.html#all">all</a></li><li data-type="method" id="Account-containers-nav"><a href="Account.html#containers">containers</a></li><li data-type="method" id="Account-details-nav"><a href="Account.html#details">details</a></li><li data-type="method" id="Account-generateKey-nav"><a href="Account.html#generateKey">generateKey</a></li><li data-type="method" id="Account-metas-nav"><a href="Account.html#metas">metas</a></li></ul></li><li id="AccountMeta-nav"><a href="AccountMeta.html">AccountMeta</a><ul class='methods'><li data-type="method" id="AccountMeta-all-nav"><a href="AccountMeta.html#all">all</a></li><li data-type="method" id="AccountMeta-create-nav"><a href="AccountMeta.html#create">create</a></li><li data-type="method" id="AccountMeta-create_with_result-nav"><a href="AccountMeta.html#create_with_result">create_with_result</a></li><li data-type="method" id="AccountMeta-delete-nav"><a href="AccountMeta.html#delete">delete</a></li><li data-type="method" id="AccountMeta-delete_with_result-nav"><a href="AccountMeta.html#delete_with_result">delete_with_result</a></li><li data-type="method" id="AccountMeta-get-nav"><a href="AccountMeta.html#get">get</a></li><li data-type="method" id="AccountMeta-has-nav"><a href="AccountMeta.html#has">has</a></li><li data-type="method" id="AccountMeta-update-nav"><a href="AccountMeta.html#update">update</a></li><li data-type="method" id="AccountMeta-update_with_result-nav"><a href="AccountMeta.html#update_with_result">update_with_result</a></li></ul></li><li id="Containers-nav"><a href="Containers.html">Containers</a><ul class='methods'><li data-type="method" id="Containers-create-nav"><a href="Containers.html#create">create</a></li><li data-type="method" id="Containers-create_with_result-nav"><a href="Containers.html#create_with_result">create_with_result</a></li><li data-type="method" id="Containers-delete-nav"><a href="Containers.html#delete">delete</a></li><li data-type="method" id="Containers-delete_objects-nav"><a href="Containers.html#delete_objects">delete_objects</a></li><li data-type="method" id="Containers-delete_objects_with_result-nav"><a href="Containers.html#delete_objects_with_result">delete_objects_with_result</a></li><li data-type="method" id="Containers-delete_with_result-nav"><a href="Containers.html#delete_with_result">delete_with_result</a></li><li data-type="method" id="Containers-exist-nav"><a href="Containers.html#exist">exist</a></li><li data-type="method" id="Containers-info-nav"><a href="Containers.html#info">info</a></li><li data-type="method" id="Containers-list-nav"><a href="Containers.html#list">list</a></li><li data-type="method" id="Containers-metas-nav"><a href="Containers.html#metas">metas</a></li></ul></li><li id="ContainersMeta-nav"><a href="ContainersMeta.html">ContainersMeta</a><ul class='methods'><li data-type="method" id="ContainersMeta-all-nav"><a href="ContainersMeta.html#all">all</a></li><li data-type="method" id="ContainersMeta-create-nav"><a href="ContainersMeta.html#create">create</a></li><li data-type="method" id="ContainersMeta-create_with_result-nav"><a href="ContainersMeta.html#create_with_result">create_with_result</a></li><li data-type="method" id="ContainersMeta-delete-nav"><a href="ContainersMeta.html#delete">delete</a></li><li data-type="method" id="ContainersMeta-delete_with_result-nav"><a href="ContainersMeta.html#delete_with_result">delete_with_result</a></li><li data-type="method" id="ContainersMeta-get-nav"><a href="ContainersMeta.html#get">get</a></li><li data-type="method" id="ContainersMeta-has-nav"><a href="ContainersMeta.html#has">has</a></li><li data-type="method" id="ContainersMeta-update-nav"><a href="ContainersMeta.html#update">update</a></li><li data-type="method" id="ContainersMeta-update_with_result-nav"><a href="ContainersMeta.html#update_with_result">update_with_result</a></li></ul></li><li id="Objects-nav"><a href="Objects.html">Objects</a><ul class='methods'><li data-type="method" id="Objects-copy-nav"><a href="Objects.html#copy">copy</a></li><li data-type="method" id="Objects-copy_with_result-nav"><a href="Objects.html#copy_with_result">copy_with_result</a></li><li data-type="method" id="Objects-delete-nav"><a href="Objects.html#delete">delete</a></li><li data-type="method" id="Objects-delete_with_result-nav"><a href="Objects.html#delete_with_result">delete_with_result</a></li><li data-type="method" id="Objects-deletes-nav"><a href="Objects.html#deletes">deletes</a></li><li data-type="method" id="Objects-deletes_with_result-nav"><a href="Objects.html#deletes_with_result">deletes_with_result</a></li><li data-type="method" id="Objects-download-nav"><a href="Objects.html#download">download</a></li><li data-type="method" id="Objects-exist-nav"><a href="Objects.html#exist">exist</a></li><li data-type="method" id="Objects-expire_after-nav"><a href="Objects.html#expire_after">expire_after</a></li><li data-type="method" id="Objects-expire_after_with_result-nav"><a href="Objects.html#expire_after_with_result">expire_after_with_result</a></li><li data-type="method" id="Objects-expire_at-nav"><a href="Objects.html#expire_at">expire_at</a></li><li data-type="method" id="Objects-expire_at_with_result-nav"><a href="Objects.html#expire_at_with_result">expire_at_with_result</a></li><li data-type="method" id="Objects-get-nav"><a href="Objects.html#get">get</a></li><li data-type="method" id="Objects-getTempLink-nav"><a href="Objects.html#getTempLink">getTempLink</a></li><li data-type="method" id="Objects-info-nav"><a href="Objects.html#info">info</a></li><li data-type="method" id="Objects-metas-nav"><a href="Objects.html#metas">metas</a></li><li data-type="method" id="Objects-save-nav"><a href="Objects.html#save">save</a></li><li data-type="method" id="Objects-save_with_result-nav"><a href="Objects.html#save_with_result">save_with_result</a></li><li data-type="method" id="Objects-saveData-nav"><a href="Objects.html#saveData">saveData</a></li><li data-type="method" id="Objects-saveFile-nav"><a href="Objects.html#saveFile">saveFile</a></li><li data-type="method" id="Objects-set-nav"><a href="Objects.html#set">set</a></li><li data-type="method" id="Objects-set_with_result-nav"><a href="Objects.html#set_with_result">set_with_result</a></li></ul></li><li id="ObjectsMeta-nav"><a href="ObjectsMeta.html">ObjectsMeta</a><ul class='methods'><li data-type="method" id="ObjectsMeta-all-nav"><a href="ObjectsMeta.html#all">all</a></li><li data-type="method" id="ObjectsMeta-create-nav"><a href="ObjectsMeta.html#create">create</a></li><li data-type="method" id="ObjectsMeta-create_with_result-nav"><a href="ObjectsMeta.html#create_with_result">create_with_result</a></li><li data-type="method" id="ObjectsMeta-delete-nav"><a href="ObjectsMeta.html#delete">delete</a></li><li data-type="method" id="ObjectsMeta-delete_with_result-nav"><a href="ObjectsMeta.html#delete_with_result">delete_with_result</a></li><li data-type="method" id="ObjectsMeta-get-nav"><a href="ObjectsMeta.html#get">get</a></li><li data-type="method" id="ObjectsMeta-has-nav"><a href="ObjectsMeta.html#has">has</a></li><li data-type="method" id="ObjectsMeta-update-nav"><a href="ObjectsMeta.html#update">update</a></li><li data-type="method" id="ObjectsMeta-update_with_result-nav"><a href="ObjectsMeta.html#update_with_result">update_with_result</a></li></ul></li><li id="OVHStorage-nav"><a href="OVHStorage.html">OVHStorage</a><ul class='methods'><li data-type="method" id="OVHStorage-account-nav"><a href="OVHStorage.html#account">account</a></li><li data-type="method" id="OVHStorage-connection-nav"><a href="OVHStorage.html#connection">connection</a></li><li data-type="method" id="OVHStorage-containers-nav"><a href="OVHStorage.html#containers">containers</a></li><li data-type="method" id="OVHStorage-getConnectionDetails-nav"><a href="OVHStorage.html#getConnectionDetails">getConnectionDetails</a></li><li data-type="method" id="OVHStorage-objects-nav"><a href="OVHStorage.html#objects">objects</a></li></ul></li></ul><h3 id="global-nav"><a href="global.html">Global</a></h3>
</nav>
<div id="main">
<h1 class="page-title">
Objects
</h1>
<section>
<header>
<h2>
Objects
</h2>
<div class="class-description">
<p>Put, edit, remove, downloads objects files</p>
<p><strong>Available methods :</strong> *download(), *get(), *save(), *save_with_result(), <em>set()</em>, <em>set_with_result()</em>, <em>copy()</em>, <em>copy_with_result()</em>, <em>delete()</em>, <em>delete_with_result()</em>, <em>deletes()</em>, <em>deletes_with_result()</em>, <em>exist()</em>, <em>info()</em>, <em>expire_at()</em>, <em>expire_at_with_result()</em>, <em>expire_after()</em>, <em>expire_after_with_result()</em>, <em>metas()</em></p>
</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<span class='name-container'>
<a class="link-icon" href="#Objects">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="Objects">
<span class="type-signature"></span>new Objects<span class="signature">(context)</span><span class="type-signature"></span>
</h4>
</span>
<div class="description">
<p>Object constructor</p>
</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>context</code></td>
<td class="type">
<span class="param-type">
<a href="OVHStorage.html">OVHStorage</a>
</span>
</td>
<td class="description last">
<p>OVHObjectStorage context</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Objects.js.html">Objects.js</a>, <a href="Objects.js.html#line14">line 14</a>
</li>
</ul>
</dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<span class='name-container'>
<a class="link-icon" href="#copy">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="copy">
<span class="type-signature">(async) </span>copy<span class="signature">(pathOrigin, pathToPaste)</span><span class="type-signature"> → {Promise.<Object>}</span>
</h4>
</span>
<div class="description">
<p>Copy online file from another destination on account</p>
</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>pathOrigin</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Source file path to copy</p>
</td>
</tr>
<tr>
<td class="name"><code>pathToPaste</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Destination file path to paste</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Objects.js.html">Objects.js</a>, <a href="Objects.js.html#line357">line 357</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#copy_with_result">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="copy_with_result">
<span class="type-signature">(async) </span>copy_with_result<span class="signature">(pathOrigin, pathToPaste)</span><span class="type-signature"> → {Promise.<Boolean>}</span>
</h4>
</span>
<div class="description">
<p>Copy online file from another destination on account and return boolean as result</p>
</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>pathOrigin</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Source file path to copy</p>
</td>
</tr>
<tr>
<td class="name"><code>pathToPaste</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Destination file path to paste</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Objects.js.html">Objects.js</a>, <a href="Objects.js.html#line433">line 433</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#delete">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="delete">
<span class="type-signature">(async) </span>delete<span class="signature">(path, checkContainer<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Object>}</span>
</h4>
</span>
<div class="description">
<p>Delete file object</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>path</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">
<p>Path of file with container</p>
</td>
</tr>
<tr>
<td class="name"><code>checkContainer</code></td>
<td class="type">
<span class="param-type">
Boolean
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">
<p>Boolean to disable check existence of container</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Objects.js.html">Objects.js</a>, <a href="Objects.js.html#line501">line 501</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#delete_with_result">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="delete_with_result">
<span class="type-signature">(async) </span>delete_with_result<span class="signature">(path, checkContainer<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Boolean>}</span>
</h4>
</span>
<div class="description">
<p>Delete file object and return boolean as result</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>path</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">
<p>Path of file with container</p>
</td>
</tr>
<tr>
<td class="name"><code>checkContainer</code></td>
<td class="type">
<span class="param-type">
Boolean
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">
<p>Boolean to disable check existence of container</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Objects.js.html">Objects.js</a>, <a href="Objects.js.html#line557">line 557</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#deletes">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="deletes">
<span class="type-signature">(async) </span>deletes<span class="signature">(paths, checkContainer<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<<a href="Objects.html">Objects</a>>>}</span>
</h4>
</span>
<div class="description">
<p>Delete multiple files object</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>paths</code></td>
<td class="type">
<span class="param-type">
Array.<string>
</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">
<p>Array of path file</p>
</td>
</tr>
<tr>
<td class="name"><code>checkContainer</code></td>
<td class="type">
<span class="param-type">
Boolean
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">
<p>Boolean to disable check existence of container</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Objects.js.html">Objects.js</a>, <a href="Objects.js.html#line575">line 575</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#deletes_with_result">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="deletes_with_result">
<span class="type-signature">(async) </span>deletes_with_result<span class="signature">(paths, checkContainer<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Boolean>}</span>
</h4>
</span>
<div class="description">
<p>Delete multiple files object and return boolean as result</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>paths</code></td>
<td class="type">
<span class="param-type">
Array.<string>
</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">
<p>Array of path file</p>
</td>
</tr>
<tr>
<td class="name"><code>checkContainer</code></td>
<td class="type">
<span class="param-type">
Boolean
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">
<p>Boolean to disable check existence of container</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Objects.js.html">Objects.js</a>, <a href="Objects.js.html#line609">line 609</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#download">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="download">
<span class="type-signature">(async) </span>download<span class="signature">(path, pathLocal)</span><span class="type-signature"> → {Promise.<(Boolean|Error)>}</span>
</h4>
</span>
<div class="description">
<p>Download file</p>
</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>path</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Online path of file with container</p>
</td>
</tr>
<tr>
<td class="name"><code>pathLocal</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Local path to download file</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Objects.js.html">Objects.js</a>, <a href="Objects.js.html#line33">line 33</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#exist">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="exist">
<span class="type-signature">(async) </span>exist<span class="signature">(path)</span><span class="type-signature"> → {Promise.<Boolean>}</span>
</h4>
</span>
<div class="description">
<p>Check if file object exist</p>
</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>path</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Path of file with container</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Objects.js.html">Objects.js</a>, <a href="Objects.js.html#line626">line 626</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#expire_after">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="expire_after">
<span class="type-signature">(async) </span>expire_after<span class="signature">(path, delete_seconds)</span><span class="type-signature"> → {Promise.<Object>}</span>
</h4>
</span>
<div class="description">
<p>Expire file after X seconds</p>
</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>path</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Path of file with container</p>
</td>
</tr>
<tr>
<td class="name"><code>delete_seconds</code></td>
<td class="type">
<span class="param-type">
number
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Objects.js.html">Objects.js</a>, <a href="Objects.js.html#line824">line 824</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#expire_after_with_result">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="expire_after_with_result">
<span class="type-signature">(async) </span>expire_after_with_result<span class="signature">(path, delete_seconds)</span><span class="type-signature"> → {Promise.<Boolean>}</span>
</h4>
</span>
<div class="description">
<p>Expire file after X seconds and return boolean as result</p>
</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>path</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Path of file with container</p>
</td>
</tr>
<tr>
<td class="name"><code>delete_seconds</code></td>
<td class="type">
<span class="param-type">
number
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Objects.js.html">Objects.js</a>, <a href="Objects.js.html#line874">line 874</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#expire_at">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="expire_at">
<span class="type-signature">(async) </span>expire_at<span class="signature">(path, expire_date)</span><span class="type-signature"> → {Promise.<Object>}</span>
</h4>
</span>
<div class="description">
<p>Expire file at datetime</p>
</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>path</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Path of file with container</p>
</td>
</tr>
<tr>
<td class="name"><code>expire_date</code></td>
<td class="type">
<span class="param-type">
Moment
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Objects.js.html">Objects.js</a>, <a href="Objects.js.html#line753">line 753</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#expire_at_with_result">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="expire_at_with_result">
<span class="type-signature">(async) </span>expire_at_with_result<span class="signature">(path, expire_date)</span><span class="type-signature"> → {Promise.<Boolean>}</span>
</h4>
</span>
<div class="description">
<p>Expire file at datetime and return boolean as result</p>
</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>path</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Path of file with container</p>
</td>
</tr>
<tr>
<td class="name"><code>expire_date</code></td>
<td class="type">
<span class="param-type">
Moment
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Objects.js.html">Objects.js</a>, <a href="Objects.js.html#line806">line 806</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#get">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="get">
<span class="type-signature">(async) </span>get<span class="signature">(path, encoding)</span><span class="type-signature"> → {Promise.<{content: *, headers: <a href="Objects.html">Objects</a>}>}</span>
</h4>
</span>
<div class="description">
<p>Get file</p>
</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>path</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Path of file with container</p>
</td>
</tr>
<tr>
<td class="name"><code>encoding</code></td>
<td class="type">
<span class="param-type">
String
</span>
|
<span class="param-type">
null
</span>
|
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
<p>If null, the body is returned as a Buffer by default it is utf8.</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Objects.js.html">Objects.js</a>, <a href="Objects.js.html#line103">line 103</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#getTempLink">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="getTempLink">
<span class="type-signature"></span>getTempLink<span class="signature">(path, validityDurationInSeconds, checkContainer)</span><span class="type-signature"> → {Promise.<String>}</span>
</h4>
</span>
<div class="description">
<p>Generate temporary link to download files in private containers</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>path</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="default">
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>validityDurationInSeconds</code></td>
<td class="type">
<span class="param-type">
Number
</span>
</td>
<td class="default">
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>checkContainer</code></td>
<td class="type">
<span class="param-type">
Boolean
</span>
</td>
<td class="default">
true
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Objects.js.html">Objects.js</a>, <a href="Objects.js.html#line450">line 450</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#info">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="info">
<span class="type-signature">(async) </span>info<span class="signature">(path)</span><span class="type-signature"> → {Promise.<Object>}</span>
</h4>
</span>
<div class="description">
<p>Get information details of file object</p>
</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>path</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Path of file with container</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Objects.js.html">Objects.js</a>, <a href="Objects.js.html#line697">line 697</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#metas">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="metas">
<span class="type-signature"></span>metas<span class="signature">()</span><span class="type-signature"> → {<a href="AccountMeta.html">AccountMeta</a>}</span>
</h4>
</span>
<div class="description">
<p>Manage meta data of object<br>
Available methods : create(), update(), delete(), all(), has(), get()</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Objects.js.html">Objects.js</a>, <a href="Objects.js.html#line889">line 889</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#save">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="save">
<span class="type-signature">(async) </span>save<span class="signature">(file, path)</span><span class="type-signature"> → {Promise.<Object>}</span>
</h4>
</span>
<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>file</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Local file path to save</p>
</td>
</tr>
<tr>
<td class="name"><code>path</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Path where to store the file</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="important tag-deprecated">Deprecated:</dt>
<dd>
<ul class="dummy">
<li>
Use saveFile(file, path)
Save file
</li>
</ul>
</dd>
<br>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Objects.js.html">Objects.js</a>, <a href="Objects.js.html#line164">line 164</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#save_with_result">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="save_with_result">
<span class="type-signature">(async) </span>save_with_result<span class="signature">(file, path)</span><span class="type-signature"> → {Promise.<Object>}</span>
</h4>
</span>
<div class="description">
<p>Save file and return boolean as result</p>
</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>file</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Local file path to save</p>
</td>
</tr>
<tr>
<td class="name"><code>path</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Path where to store the file</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Objects.js.html">Objects.js</a>, <a href="Objects.js.html#line304">line 304</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#saveData">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="saveData">
<span class="type-signature">(async) </span>saveData<span class="signature">(data, path)</span><span class="type-signature"> → {Promise.<Object>}</span>
</h4>
</span>
<div class="description">
<p>Save file data</p>
</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>data</code></td>
<td class="type">
<span class="param-type">
Buffer
</span>
|
<span class="param-type">
Uint8Array
</span>
|
<span class="param-type">
Blob
</span>
|
<span class="param-type">
string
</span>
|
<span class="param-type">
Readable
</span>
</td>
<td class="description last">
<p>data to save</p>
</td>
</tr>
<tr>
<td class="name"><code>path</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Path where to store the file</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Objects.js.html">Objects.js</a>, <a href="Objects.js.html#line177">line 177</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#saveFile">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="saveFile">
<span class="type-signature">(async) </span>saveFile<span class="signature">(file, path)</span><span class="type-signature"> → {Promise.<Object>}</span>
</h4>
</span>
<div class="description">
<p>Save file</p>
</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>file</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Local file path to save</p>
</td>
</tr>
<tr>
<td class="name"><code>path</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Path where to store the file</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Objects.js.html">Objects.js</a>, <a href="Objects.js.html#line238">line 238</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#set">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="set">
<span class="type-signature">(async) </span>set<span class="signature">(file, path)</span><span class="type-signature"> → {Promise.<Object>}</span>
</h4>
</span>
<div class="description">
<p>Set file<br>
Method deprecated prefer save() method</p>
</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>file</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Local file path to save</p>
</td>
</tr>
<tr>
<td class="name"><code>path</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Path where to store the file</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="important tag-deprecated">Deprecated:</dt>
<dd class="yes-def tag-deprecated">
<ul class="dummy">
<li>Yes</li>
</ul>
</dd>
<br>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Objects.js.html">Objects.js</a>, <a href="Objects.js.html#line324">line 324</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#set_with_result">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="set_with_result">
<span class="type-signature">(async) </span>set_with_result<span class="signature">(file, path)</span><span class="type-signature"> → {Promise.<Object>}</span>
</h4>
</span>
<div class="description">
<p>Set file and return boolean as result<br>
Method deprecated prefer save_with_result() method</p>
</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>file</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Local file path to save</p>
</td>
</tr>
<tr>
<td class="name"><code>path</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last">
<p>Path where to store the file</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="important tag-deprecated">Deprecated:</dt>
<dd class="yes-def tag-deprecated">
<ul class="dummy">
<li>Yes</li>
</ul>
</dd>
<br>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Objects.js.html">Objects.js</a>, <a href="Objects.js.html#line339">line 339</a>
</li>
</ul>
</dd>
</dl>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a>
</footer>
<script src="scripts/linenumber.js"></script>
<script src="scripts/pagelocation.js"></script>
</body>
</html>