W3cubDocs

/Web APIs

FileSystemEntry: getMetadata() method

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

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

getMetadata(successCallback)
getMetadata(successCallback, errorCallback)

Parameters

successCallback: A function which is called when the copy operation is successfully 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

None (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.

Examples

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",
  {},
  (fileEntry) => {
    fileEntry.getMetadata((metadata) => {
      if (metadata.size > 1048576) {
        workingDirectory.getDirectory(
          "log",
          {},
          (dirEntry) => {
            fileEntry.moveTo(dirEntry);
          },
          handleError,
        );
      }
    });
  },
  handleError,
);

Browser compatibility