@harishreddym/baqend

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Baqend JavaScript SDK 2.14.1 - Class: FileFactory</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <link rel="shortcut icon" type="image/x-icon" href="img/favicon.ico"> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/bootstrap-baqend.min.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> <link type="text/css" rel="stylesheet" href="styles/font-awesome-4.7.0.css"> </head> <body> <nav class="navbar navbar-default navbar-fixed-top" role="navigation"> <div class="navbar-inner container">  <div class="navbar-header">  <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button>  <a class="navbar-brand" href="/"><img src="img/logo.png"></a> </div>  <div id="nav" class="navbar-collapse collapse">  <form class="navbar-right form-inline search-form"> <div class="form-group search-form-group"> <input type="search" class="form-control search-input" id="search-query" placeholder="Search Guide" name="q" autocomplete="off"> <div id="search-results" class="search-results"> <p class="search-no-results">Please enter a search query ...</p> </div> <i class="search-icon fa fa-search"></i> </div> </form>  <ul class="nav navbar-nav"> <li> <a href="https://dashboard.baqend.com/">Dashboard</a> </li>  <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Guide <b class="caret"></b></a> <ul class="dropdown-menu"> <li><a href="https://www.baqend.com/guide/">Home</a></li> <li><a href="https://www.baqend.com/guide/#speed-kit">Speed Kit</a></li> <li><a href="https://www.baqend.com/guide/#platform">Platform</a></li> <li><a href="https://www.baqend.com/guide/roadmap/">Roadmap</a></li> <li><a href="https://www.baqend.com/guide/topics/faq/">FAQ</a></li> </ul> </li>  <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Starter Kits <b class="caret"></b></a> <ul class="dropdown-menu"> <li><a href="https://www.baqend.com/guide/starter-kits/">Starter Kits Overview</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/angular2/">Angular 2 Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/react/">React and Redux Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/bootstrap/">Bootstrap Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/ionic2/">Ionic 2 Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/ionic/">Ionic Starter Kit</a></li> </ul> </li> <li class="active"> <a href="baqend.html">JS API</a> </li> <li> <a href="https://www.baqend.com/tutorial.html">Tutorial</a> </li> </ul> </div> </div> </nav> <div class="box gray pt-32 pb-32"> <div class="container"> <div class="row">  <div class="bs-sidebar hidden-print fixed affix" role="complementary"> <input class="filter form-control input-sm" type="text" placeholder="FILTER"/> <ul class="nav bs-sidenav"> <li class=""><a href="Acl.html" class="nav-name">Acl</a></li> <li class=""><a href="EntityManager.html" class="nav-name">EntityManager</a></li> <li class=""><a href="EntityManagerFactory.html" class="nav-name">EntityManagerFactory</a></li> <li class=""><a href="GeoPoint.html" class="nav-name">GeoPoint</a></li> <li class=""><a href="RealtimeEvent.html" class="nav-name">RealtimeEvent</a></li> <li class=""><a href="baqend.html" class="nav-name">baqend</a></li> <li class="active"> <a href="binding.html" class="nav-name">binding</a> <ul class="nav"> <li class=""><a href="binding.Accessor.html" class="nav-name">Accessor</a></li> <li class=""><a href="binding.DeviceFactory.html" class="nav-name">DeviceFactory</a></li> <li class=""><a href="binding.Enhancer.html" class="nav-name">Enhancer</a></li> <li class=""><a href="binding.Entity.html" class="nav-name">Entity</a></li> <li class=""><a href="binding.EntityFactory.html" class="nav-name">EntityFactory</a></li> <li class=""><a href="binding.Factory.html" class="nav-name">Factory</a></li> <li class=""><a href="binding.File.html" class="nav-name">File</a></li> <li class="active"><a href="binding.FileFactory.html" class="nav-name">FileFactory</a></li> <li class=""><a href="binding.Managed.html" class="nav-name">Managed</a></li> <li class=""><a href="binding.ManagedFactory.html" class="nav-name">ManagedFactory</a></li> <li class=""><a href="binding.Role.html" class="nav-name">Role</a></li> <li class=""><a href="binding.User.html" class="nav-name">User</a></li> <li class=""><a href="binding.UserFactory.html" class="nav-name">UserFactory</a></li> </ul> </li> <li class=""> <a href="caching.html" class="nav-name">caching</a> <ul class="nav"> <li class=""><a href="caching.BloomFilter.html" class="nav-name">BloomFilter</a></li> </ul> </li> <li class=""> <a href="connector.html" class="nav-name">connector</a> <ul class="nav"> <li class=""><a href="connector.Connector.html" class="nav-name">Connector</a></li> <li class=""><a href="connector.FetchConnector.html" class="nav-name">FetchConnector</a></li> <li class=""><a href="connector.IFrameConnector.html" class="nav-name">IFrameConnector</a></li> <li class=""><a href="connector.Message.html" class="nav-name">Message</a></li> <li class=""><a href="connector.NodeConnector.html" class="nav-name">NodeConnector</a></li> <li class=""><a href="connector.ObservableStream.html" class="nav-name">ObservableStream</a></li> <li class=""><a href="connector.WebSocketConnector.html" class="nav-name">WebSocketConnector</a></li> <li class=""><a href="connector.XMLHttpConnector.html" class="nav-name">XMLHttpConnector</a></li> <li class=""><a href="connector.ChannelMessage.html" class="nav-name">ChannelMessage</a></li> </ul> </li> <li class=""> <a href="error.html" class="nav-name">error</a> <ul class="nav"> <li class=""><a href="error.CommunicationError.html" class="nav-name">CommunicationError</a></li> <li class=""><a href="error.EntityExistsError.html" class="nav-name">EntityExistsError</a></li> <li class=""><a href="error.IllegalEntityError.html" class="nav-name">IllegalEntityError</a></li> <li class=""><a href="error.PersistentError.html" class="nav-name">PersistentError</a></li> <li class=""><a href="error.RollbackError.html" class="nav-name">RollbackError</a></li> </ul> </li> <li class=""> <a href="metamodel.html" class="nav-name">metamodel</a> <ul class="nav"> <li class=""><a href="metamodel.Attribute.html" class="nav-name">Attribute</a></li> <li class=""><a href="metamodel.BasicType.html" class="nav-name">BasicType</a></li> <li class=""><a href="metamodel.CollectionAttribute.html" class="nav-name">CollectionAttribute</a></li> <li class=""><a href="metamodel.DbIndex.html" class="nav-name">DbIndex</a></li> <li class=""><a href="metamodel.EmbeddableType.html" class="nav-name">EmbeddableType</a></li> <li class=""><a href="metamodel.EntityType.html" class="nav-name">EntityType</a></li> <li class=""><a href="metamodel.ListAttribute.html" class="nav-name">ListAttribute</a></li> <li class=""><a href="metamodel.ManagedType.html" class="nav-name">ManagedType</a></li> <li class=""><a href="metamodel.MapAttribute.html" class="nav-name">MapAttribute</a></li> <li class=""><a href="metamodel.Metamodel.html" class="nav-name">Metamodel</a></li> <li class=""><a href="metamodel.ModelBuilder.html" class="nav-name">ModelBuilder</a></li> <li class=""><a href="metamodel.PluralAttribute.html" class="nav-name">PluralAttribute</a></li> <li class=""><a href="metamodel.SetAttribute.html" class="nav-name">SetAttribute</a></li> <li class=""><a href="metamodel.SingularAttribute.html" class="nav-name">SingularAttribute</a></li> <li class=""><a href="metamodel.Type.html" class="nav-name">Type</a></li> </ul> </li> <li class=""> <a href="model.html" class="nav-name">model</a> <ul class="nav"> <li class=""><a href="model.Device.html" class="nav-name">Device</a></li> <li class=""><a href="model.Role.html" class="nav-name">Role</a></li> <li class=""><a href="model.User.html" class="nav-name">User</a></li> </ul> </li> <li class=""> <a href="partialupdate.html" class="nav-name">partialupdate</a> <ul class="nav"> <li class=""><a href="partialupdate.EntityPartialUpdateBuilder.html" class="nav-name">EntityPartialUpdateBuilder</a></li> <li class=""><a href="partialupdate.PartialUpdateBuilder.html" class="nav-name">PartialUpdateBuilder</a></li> <li class=""><a href="partialupdate.UpdateOperation.html" class="nav-name">UpdateOperation</a></li> </ul> </li> <li class=""> <a href="query.html" class="nav-name">query</a> <ul class="nav"> <li class=""><a href="query.Builder.html" class="nav-name">Builder</a></li> <li class=""><a href="query.Filter.html" class="nav-name">Filter</a></li> <li class=""><a href="query.Node.html" class="nav-name">Node</a></li> <li class=""><a href="query.Operator.html" class="nav-name">Operator</a></li> <li class=""><a href="query.Query.html" class="nav-name">Query</a></li> <li class=""><a href="query.Stream.html" class="nav-name">Stream</a></li> <li class=""><a href="query.Condition.html" class="nav-name">Condition</a></li> </ul> </li> <li class=""> <a href="util.html" class="nav-name">util</a> <ul class="nav"> <li class=""><a href="util.Code.html" class="nav-name">Code</a></li> <li class=""><a href="util.Lockable.html" class="nav-name">Lockable</a></li> <li class=""><a href="util.Logger.html" class="nav-name">Logger</a></li> <li class=""><a href="util.Metadata.html" class="nav-name">Metadata</a></li> <li class=""><a href="util.Modules.html" class="nav-name">Modules</a></li> <li class=""><a href="util.Permission.html" class="nav-name">Permission</a></li> <li class=""><a href="util.PushMessage.html" class="nav-name">PushMessage</a></li> <li class=""><a href="util.TokenStorage.html" class="nav-name">TokenStorage</a></li> <li class=""><a href="util.ValidationResult.html" class="nav-name">ValidationResult</a></li> <li class=""><a href="util.Validator.html" class="nav-name">Validator</a></li> <li class=""><a href="util.TokenStorageFactory.html" class="nav-name">TokenStorageFactory</a></li> </ul> </li> </ul> </div> <div class="col-md-12" id="main"> <div class="content"> <h1 class="page-title">Class: FileFactory</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span> <span class="ancestors"><a href="binding.html">binding</a>.</span>FileFactory<span class="signature">(properties<span class="signature-attributes">opt</span>, …arguments)</span><span class="type-signature"> → {<a href="binding.File.html">binding.File</a>}</span></h2> </header> <article> <div class="container-overview"> <h4 class="name" id="FileFactory"><span class="type-signature"></span>new FileFactory<span class="signature">(properties<span class="signature-attributes">opt</span>, …arguments)</span><span class="type-signature"> → {<a href="binding.File.html">binding.File</a>}</span></h4> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>properties</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>initial properties to set on the file</p></td> </tr> <tr> <td class="name"><code>arguments</code></td> <td class="type"> <span class="param-type">*</span> </td> <td class="attributes"> <repeatable><br> </td> <td class="description last"><p>Additional constructor params passed through the type constructor</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_binding_FileFactory.js.html">lib/binding/FileFactory.js</a>, <a href="lib_binding_FileFactory.js.html#line11">line 11</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The new managed instance</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="binding.File.html">binding.File</a></span> </dd> </dl> </div> <h3 class="subsection-title">Extends</h3> <ul> <li><a href="binding.Factory.html">binding.Factory</a></li> </ul> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="create"><span class="type-signature"></span>create<span class="signature">(db)</span><span class="type-signature"> → {<a href="binding.FileFactory.html">binding.FileFactory</a>}</span></h4> <div class="description"> <p>Creates a new FileFactory for the given type</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>db</code></td> <td class="type"> <span class="param-type"><a href="EntityManager.html">EntityManager</a></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="lib_binding_FileFactory.js.html">lib/binding/FileFactory.js</a>, <a href="lib_binding_FileFactory.js.html#line27">line 27</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>A new file factory</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="binding.FileFactory.html">binding.FileFactory</a></span> </dd> </dl> <h4 class="name" id="fromJSON"><span class="type-signature"></span>fromJSON<span class="signature">(json)</span><span class="type-signature"> → {<a href="binding.File.html">binding.File</a>}</span></h4> <div class="description"> <p>Deserialize the file metadata from a json object back to a new file instance</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>json</code></td> <td class="type"> <span class="param-type">json</span> </td> <td class="description last"><p>The file metadata as json</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_binding_FileFactory.js.html">lib/binding/FileFactory.js</a>, <a href="lib_binding_FileFactory.js.html#line51">line 51</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The deserialize File instance</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="binding.File.html">binding.File</a></span> </dd> </dl> <h4 class="name" id="listBuckets"><span class="type-signature"></span>listBuckets<span class="signature">(doneCallback<span class="signature-attributes">opt</span>, failCallback<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<binding.File>>}</span></h4> <div class="description"> <p>Lists all the buckets.</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>doneCallback</code></td> <td class="type"> <span class="param-type"><a href="binding.FileFactory.html#~fileListCallback">binding.FileFactory~fileListCallback</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The callback is invoked with the listed buckets</p></td> </tr> <tr> <td class="name"><code>failCallback</code></td> <td class="type"> <span class="param-type"><a href="binding.File.html#~failCallback">binding.File~failCallback</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The callback is invoked if any error has occurred</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_binding_FileFactory.js.html">lib/binding/FileFactory.js</a>, <a href="lib_binding_FileFactory.js.html#line115">line 115</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The listed buckets.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Array.<binding.File>></span> </dd> </dl> <h4 class="name" id="listFiles"><span class="type-signature"></span>listFiles<span class="signature">(folderOrPath, start, count, doneCallback<span class="signature-attributes">opt</span>, failCallback<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<binding.File>>}</span></h4> <div class="description"> <p>Lists the files (and folders) in the given folder.</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>folderOrPath</code></td> <td class="type"> <span class="param-type"><a href="binding.File.html">binding.File</a></span> | <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last"><p>The folder/path to list.</p></td> </tr> <tr> <td class="name"><code>start</code></td> <td class="type"> <span class="param-type"><a href="binding.File.html">binding.File</a></span> </td> <td class="attributes"> </td> <td class="description last"><p>The file/folder from where to start listing (not included)</p></td> </tr> <tr> <td class="name"><code>count</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="description last"><p>The maximum number of files to return.</p></td> </tr> <tr> <td class="name"><code>doneCallback</code></td> <td class="type"> <span class="param-type"><a href="binding.FileFactory.html#~fileListCallback">binding.FileFactory~fileListCallback</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The callback is invoked with the listed files</p></td> </tr> <tr> <td class="name"><code>failCallback</code></td> <td class="type"> <span class="param-type"><a href="binding.File.html#~failCallback">binding.File~failCallback</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The callback is invoked if any error has occurred</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_binding_FileFactory.js.html">lib/binding/FileFactory.js</a>, <a href="lib_binding_FileFactory.js.html#line131">line 131</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The listed files/folders.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Array.<binding.File>></span> </dd> </dl> <h4 class="name" id="loadMetadata"><span class="type-signature"></span>loadMetadata<span class="signature">(bucket, options<span class="signature-attributes">opt</span>, doneCallback<span class="signature-attributes">opt</span>, failCallback<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Object.<string, util.Permission>>}</span></h4> <div class="description"> <p>Gets the metadata of the root folder (formally the file "bucket")</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>bucket</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last"><p>The name of the root file directory</p></td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The load metadata options</p></td> </tr> <tr> <td colspan="4" class="subparams"> <h6>Properties</h6> <table class="params table"> <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>refresh</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>Force a revalidation while fetching the metadata</p></td> </tr> </tbody> </table> </td> </tr> <tr> <td class="name"><code>doneCallback</code></td> <td class="type"> <span class="param-type"><a href="binding.FileFactory.html#~bucketMetadataCallback">binding.FileFactory~bucketMetadataCallback</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The callback is invoked after the metadata is fetched</p></td> </tr> <tr> <td class="name"><code>failCallback</code></td> <td class="type"> <span class="param-type"><a href="binding.File.html#~failCallback">binding.File~failCallback</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The callback is invoked if any error has occurred</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_binding_FileFactory.js.html">lib/binding/FileFactory.js</a>, <a href="lib_binding_FileFactory.js.html#line90">line 90</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>A promise which will be fulfilled with the bucket acls</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Object.<string, util.Permission>></span> </dd> </dl> <h4 class="name" id="new"><span class="type-signature"></span>new<span class="signature">(fileOptions)</span><span class="type-signature"> → {<a href="binding.File.html">binding.File</a>}</span></h4> <div class="description"> <p>Creates a new file object which represents the file at the given ID</p> <p>Data provided to the constructor will be uploaded by invoking <code>upload()</code>.</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>fileOptions</code></td> <td class="type"> <span class="param-type">object</span> | <span class="param-type">string</span> </td> <td class="description last"><p>The fileOptions used to create a new file object, or just the id of the<br>file object</p></td> </tr> <tr> <td colspan="4" class="subparams"> <h6>Properties</h6> <table class="params table"> <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>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>The filename without the id. If omitted and data is provided as a file object,<br>the <code>File#name</code> will be used otherwise a uuid will be generated.</p></td> </tr> <tr> <td class="name"><code>parent</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> "/www" </td> <td class="description last"><p>The parent folder which contains the file</p></td> </tr> <tr> <td class="name"><code>data</code></td> <td class="type"> <span class="param-type">string</span> | <span class="param-type">Blob</span> | <span class="param-type">File</span> | <span class="param-type">ArrayBuffer</span> | <span class="param-type">json</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The initial file content, which will be uploaded by<br>invoking <code>#upload</code> later on.</p></td> </tr> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>A optional type hint used to correctly interpret the provided data</p></td> </tr> <tr> <td class="name"><code>mimeType</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>The mimType of the file. Defaults to the mimeType of the provided data if<br>it is a file object, blob or data-url</p></td> </tr> <tr> <td class="name"><code>eTag</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>The optional current ETag of the file</p></td> </tr> <tr> <td class="name"><code>lastModified</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>The optional last modified date</p></td> </tr> <tr> <td class="name"><code>acl</code></td> <td class="type"> <span class="param-type"><a href="Acl.html">Acl</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>The file acl which will be set, if the file is uploaded afterwards</p></td> </tr> <tr> <td class="name"><code>headers</code></td> <td class="type"> <span class="param-type">Object.<string, string></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>The custom headers which will be send with the file after<br>uploading it</p></td> </tr> </tbody> </table> </td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_binding_FileFactory.js.html">lib/binding/FileFactory.js</a>, <a href="lib_binding_FileFactory.js.html#line149">line 149</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>A new file instance</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="binding.File.html">binding.File</a></span> </dd> </dl> <h4 class="name" id="newInstance"><span class="type-signature"></span>newInstance<span class="signature">(args<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="binding.File.html">binding.File</a>}</span></h4> <div class="description"> <p>Creates a new file</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>args</code></td> <td class="type"> <span class="param-type">Array.<*></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>Constructor arguments used for instantiation, the constructor will not be called<br>when no arguments are passed</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_binding_FileFactory.js.html">lib/binding/FileFactory.js</a>, <a href="lib_binding_FileFactory.js.html#line40">line 40</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>A new created file</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="binding.File.html">binding.File</a></span> </dd> </dl> <h4 class="name" id="saveMetadata"><span class="type-signature"></span>saveMetadata<span class="signature">(bucket, metadata, doneCallback<span class="signature-attributes">opt</span>, failCallback<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<void>}</span></h4> <div class="description"> <p>Updates the metadata of the root file directory formally the file "bucket"</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>bucket</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last"><p>The name of the root file directory</p></td> </tr> <tr> <td class="name"><code>metadata</code></td> <td class="type"> <span class="param-type">Object.<string, util.Permission></span> </td> <td class="attributes"> </td> <td class="description last"><p>The new metadata for the bucket</p></td> </tr> <tr> <td colspan="4" class="subparams"> <h6>Properties</h6> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>load</code></td> <td class="type"> <span class="param-type"><a href="util.Permission.html">util.Permission</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The load permission which grants read access to all stored<br>files under the specified bucket</p></td> </tr> <tr> <td class="name"><code>insert</code></td> <td class="type"> <span class="param-type"><a href="util.Permission.html">util.Permission</a></span> </td> <td class="attributes"> <optiona