FileSystemEntry.getMetadata()

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

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

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.

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.
Draft Initial specification.

This API has no official W3C or WHATWG specification.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidiOS SafariSamsung Internet
Basic support
ExperimentalNon-standard
Chrome Full support 13Edge ? Firefox No support NoIE No support NoOpera No support NoSafari No support NoWebView Android Full support YesChrome Android Full support YesEdge Mobile ? Firefox Android No support NoOpera Android No support NoSafari iOS No support NoSamsung Internet Android ?

Legend

Full support  
Full support
No support  
No support
Compatibility unknown  
Compatibility unknown
Experimental. Expect behavior to change in the future.
Experimental. Expect behavior to change in the future.
Non-standard. Expect poor cross-browser support.
Non-standard. Expect poor cross-browser support.

See also

Document Tags and Contributors

Contributors to this page: fscholz, Sheppy
Last updated by: fscholz,