LocalFileSystemSync

このロケールの翻訳が存在しないため、英語バージョンのコンテンツを表示しています。 Help us translate this article!

非標準
この機能は標準ではなく、標準化の予定もありません。公開されているウェブサイトには使用しないでください。ユーザーによっては使用できないことがあります。実装ごとに大きな差があることもあり、将来は振る舞いが変わるかもしれません。

The LocalFileSystemSync interface of the File System API gives you access to a sandboxed file system. It is intended to be used with WebWorkers. The methods are implemented by worker objects.

この文書について

This document was last updated on March 2, 2012 and follows the W3C Specifications (Working Draft) drafted on April 19, 2011.

This specification is more or less abandonned, failing to get significant traction.

基本概念

You can request access to a sandboxed file system by requesting LocalFileSystemSync object from within a web worker. The global methods in the window object requestFileSystemSync() and resolveLocalFileSystemSyncURL() methods are exposed to the Worker's global scope. Calling window.requestFileSystemSync() for creates new storage for your web app.

For more concepts, see the counterpart article for the asynchronous API.

//Taking care of the browser-specific prefix
window.requestFileSystemSync  = window.requestFileSystemSync || window.webkitRequestFileSystemSync;

// The first parameter defines the type of storage: persistent or temporary
// Next, set the size of space needed (in bytes)
// initFs is the success callback
// And the last one is the error callback
// for denial of access and other errors. 

var fs = requestFileSystemSync(TEMPORARY, 1024*1024 /*1MB*/);

Because you are using a synchronous API, you don't need success and error callbacks.

メソッド概要

FileSystemSync requestFileSystemSync (in unsigned short type, in long long size) raises FileException;
EntrySync resolveLocalFileSystemSyncURL (in DOMString url) raises FileException;

定数

定数 説明
TEMPORARY 0

Transient storage that can be be removed by the browser at its discretion.

PERSISTENT 1 Storage that stays in the browser unless the user or the app expunges it.

メソッド

requestFileSystemSync()

Requests a file system where data should be stored. You access a sandboxed file system by requesting a LocalFileSystemSync object from within a web worker using this global method, window.requestFileSystemSync(). [ RESEARCH ]

FileSystemSync requestFileSystemSync(
  in unsigned short type, 
  in unsigned long long size  
);
Parameters
type
The storage type of the file system. The values can be either TEMPORARY or PERSISTENT.
size
The storage space—in bytes—that you need for your app.
Returns
FileSystemSync
An object that represents the file system.
Exceptions

This method can raise an FileException with the following code:

Exception Description
SECURITY_ERROR The application does not have permission to access the file system interface. For example, you cannot run from file://. For more details, see the article on basic concepts.

resolveLocalFileSystemSyncURL()

Allows the user to look up the Entry for a file or directory referred to by a local URL.

void resolveLocalFileSystemURL(
  in DOMString url  
);
Parameter
url
The URL of a local file in the file system.
Returns
EntrySync
An object that represents entries in the file system.
Exceptions

This method can raise a FileException with the following codes:

Exception Description
ENCODING_ERR The syntax of the URL was invalid.
NOT_FOUND_ERR The URL was structurally correct, but refers to a resource that does not exist.
SECURITY_ERR The application does not have permission to access the file system interface.

ブラウザの互換性

Update compatibility data on GitHub
デスクトップモバイル
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewAndroid 版 ChromeAndroid 版 FirefoxAndroid 版 OperaiOSのSafariSamsung Internet
LocalFileSystemSync
非標準
Chrome 完全対応 13
接頭辞付き
完全対応 13
接頭辞付き
接頭辞付き webkit のベンダー接頭辞が必要
Edge ? Firefox 未対応 なしIE 未対応 なしOpera 未対応 なしSafari 未対応 なしWebView Android 完全対応 あり
接頭辞付き
完全対応 あり
接頭辞付き
接頭辞付き webkit のベンダー接頭辞が必要
Chrome Android 完全対応 あり
接頭辞付き
完全対応 あり
接頭辞付き
接頭辞付き webkit のベンダー接頭辞が必要
Firefox Android 未対応 なしOpera Android 未対応 なしSafari iOS 未対応 なしSamsung Internet Android ?
requestFileSystemSync
非標準
Chrome 完全対応 13Edge ? Firefox 未対応 なしIE 未対応 なしOpera 未対応 なしSafari 未対応 なしWebView Android 完全対応 ありChrome Android 完全対応 ありFirefox Android 未対応 なしOpera Android 未対応 なしSafari iOS 未対応 なしSamsung Internet Android ?
resolveLocalFileSystemSyncURL
非標準
Chrome 完全対応 13Edge ? Firefox 未対応 なしIE 未対応 なしOpera 未対応 なしSafari 未対応 なしWebView Android 完全対応 ありChrome Android 完全対応 ありFirefox Android 未対応 なしOpera Android 未対応 なしSafari iOS 未対応 なしSamsung Internet Android ?

凡例

完全対応  
完全対応
未対応  
未対応
実装状況不明  
実装状況不明
非標準。ブラウザー間の互換性が低い可能性があります。
非標準。ブラウザー間の互換性が低い可能性があります。
使用するには、ベンダー接頭辞または異なる名前が必要です。
使用するには、ベンダー接頭辞または異なる名前が必要です。

あわせて参照

Specification:File API: Directories and System SpecificationWD

Reference: File System API

Introduction: Basic Concepts About the File System API