FileSystemEntry.getMetadata()

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

Non-standard
This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

The FileSystemEntry interface's method getMetadata() obtains a Metadata object with information about the file system entry, such as its modification date and time and its size.

Syntax

JavaScript
FileSystemEntry.getMetadata(successCallback[, errorCallback]);

Parameters

successCallback
A function which is called when the copy operation is succesfully completed. Receives a single input parameter: a Metadata object with information about the file.
errorCallback Optional
An optional callback which is executed if an error occurs while looking up the metadata. There's a single parameter: a FileError describing what went wrong.

Return value

undefined.

Errors

FileError.NOT_FOUND_ERR
The FileSystemEntry refers to an item which doesn't exist.
FileError.SECURITY_ERR
Security restrictions prohibit obtaining the requested metadata.

Example

This example checks the size of a log file in a temporary folder and, if it exceeds a megabyte, moves it into a different directory.

JavaScript
workingDirectory.getFile("tmp/log.txt", {}, function(fileEntry) {
  fileEntry.getMetadata(function(metadata) {
    if (metadata.size > 1048576) {
      workingDirectory.getDirectory("log", {}, function(dirEntry) {
        fileEntry.moveTo(dirEntry);
      }, handleError);
    }
  });
}, handleError);

Specifications

Specification Status Comment
File and Directory Entries API
The definition of 'getMetadata()' in that specification.		 Editor's Draft Initial specification.

This API has no official W3C or WHATWG specification.

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 13 webkit No support No support No support No support
Feature Android Chrome for Android Firefox Mobile (Gecko) IE Phone Opera Mobile Safari Mobile
Basic support No support 0.16webkit No support No support No support No support

See also

License

© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/filesystementry/getmetadata

API File and Directory Entries API File System API Files FileSystemEntry getMetadata Method Non-Standard Non-standard Reference