path: root/files/ja/web/api/localfilesystemsync/index.html

---
title: LocalFileSystemSync
slug: Web/API/LocalFileSystemSync
tags:
  - API
  - File API
  - File System API
  - オフライン
  - ファイルシステム
  - リファレンス
translation_of: Web/API/LocalFileSystemSync
---
<div>{{APIRef("File System API")}}{{non-standard_header()}}</div>

<p>The <code>LocalFileSystemSync</code> interface of the <a href="/en/DOM/File_API/File_System_API" title="en/DOM/File_API/File_System_APIB">File System API</a> gives you access to a sandboxed file system. It is intended to be used with <a href="/en/DOM/Worker" title="en/DOM/Worker"> WebWorkers</a>. The methods are implemented by <a href="/en/DOM/Worker" title="En/DOM/Worker">worker</a> objects.</p>

<h2 id="この文書について">この文書について</h2>

<p>このドキュメントは 2012年3月2日に最後に更新され、2011年4月19日に作成された <a href="http://www.w3.org/TR/file-system-api/">W3C の仕様 (作業中のドラフト)</a> に準拠しています。</p>

<p>この仕様は現在放棄されており、大きな牽引力を得ることはできません。</p>

<h2 id="基本概念">基本概念</h2>

<p>Web Worker 内から <code>LocalFileSystemSync</code> オブジェクトを要求することで、サンドボックス化されたファイルシステムへのアクセスを要求することができます。<code>window</code> オブジェクトの <code>requestFileSystemSync()</code> メソッドと <code>resolveLocalFileSystemSyncURL()</code> メソッドのグローバル メソッドは、Worker のグローバル スコープに公開されます。<code>window.requestFileSystemSync()</code> を呼び出すと、Web アプリのための新しいストレージが作成されます。</p>

<p>より多くの概念については、<a href="/ja/docs/Web/API/LocalFileSystem#Basic_concepts">非同期APIの対応する記事</a>を参照してください。</p>

<h3 id="例">例</h3>

<pre class="brush: js notranslate">// ブラウザ固有のプレフィックスの扱い
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*/);</pre>

<p>同期APIを使用しているので、成功とエラーのコールバックは必要ありません。</p>

<h2 id="メソッド概要">メソッド概要</h2>

<table class="standard-table">
 <tbody>
  <tr>
   <td><code>FileSystemSync <a href="#requestFileSystemSync" title="#requestFileSystemSync">requestFileSystemSync</a> (in unsigned short <em>type</em>, in long long <em>size</em>) raises <a href="/en/DOM/File_API/File_System_API/FileException" title="en/DOM/File_API/File_System_API/FileException">FileException</a>; </code></td>
  </tr>
  <tr>
   <td><code>EntrySync <a href="#resolveLocalFileSystemSyncURL" title="resolveLocalFileSystemSyncURL">resolveLocalFileSystemSyncURL</a> (in DOMString <em>url</em>) raises <a href="/en/DOM/File_API/File_System_API/FileException" title="en/DOM/File_API/File_System_API/FileException">FileException</a>;</code></td>
  </tr>
 </tbody>
</table>

<h2 id="定数">定数</h2>

<table class="standard-table">
 <thead>
  <tr>
   <th scope="col">定数</th>
   <th scope="col">値</th>
   <th scope="col">説明</th>
  </tr>
 </thead>
 <tbody>
  <tr>
   <td><a name="const_temporary"><code>TEMPORARY</code></a></td>
   <td><code>0</code></td>
   <td>
    <p>ブラウザの裁量で削除できる過渡的なストレージ。</p>
   </td>
  </tr>
  <tr>
   <td><a name="const_persistent"><code>PERSISTENT</code></a></td>
   <td><code>1</code></td>
   <td>ユーザーやアプリが削除しない限り、ブラウザに残るストレージ。</td>
  </tr>
 </tbody>
</table>

<h2 id="メソッド">メソッド</h2>

<h3 id="requestFileSystem" name="requestFileSystem">requestFileSystemSync()</h3>

<p>データが保存されるべきファイルシステムを要求します。このグローバル メソッド <code>window.requestFileSystemSync()</code> を使用して、Web ワーカー内から <code>LocalFileSystemSync</code> オブジェクトを要求することで、サンドボックス化されたファイルシステムにアクセスします。[ RESEARCH ]</p>

<pre class="notranslate"><code>FileSystemSync</code> requestFileSystemSync(
  in unsigned short type,
  in unsigned long long size
);</pre>

<h5 id="パラメータ">パラメータ</h5>

<dl>
 <dt>type</dt>
 <dd>ファイルシステムのストレージタイプ。値は、<code><a href="/ja/docs/Web/API/LocalFileSystemSync#const_temporary">TEMPORARY</a></code> または <code><a href="/ja/docs/Web/API/LocalFileSystemSync#const_persistent">PERSISTENT</a></code> のいずれかです。</dd>
 <dt>size</dt>
 <dd>アプリに必要なストレージ容量 (バイト単位)。</dd>
</dl>

<h5 id="戻り値">戻り値</h5>

<dl>
 <dt><code><a href="/en/DOM/File_API/File_System_API/FileSystemSync" title="en/DOM/File_API/File_System_API/FileSystemSync">FileSystemSync</a></code></dt>
 <dd>ファイルシステムを表すオブジェクト。</dd>
</dl>

<h5 id="例外">例外</h5>

<p>このメソッドは、以下のコードで <a href="/ja/docs/Web/API/FileException">FileException</a> が発生する可能性があります。</p>

<table class="standard-table">
 <thead>
  <tr>
   <th scope="col">例外</th>
   <th scope="col">説明</th>
  </tr>
  <tr>
   <td><code>SECURITY_ERROR</code></td>
   <td>このアプリケーションは、ファイルシステムインターフェイスにアクセスする権限を持っていません。例えば、<code>file://</code> からは実行できません。詳細については、<a href="/ja/docs/Web/API/File_and_Directory_Entries_API/Introduction#You_cannot_run_your_app_from_file:.2F.2F">基本的な考え方の記事</a>を参照してください。</td>
  </tr>
 </thead>
</table>

<h3 id="resolveLocalFileSystemSyncURL" name="resolveLocalFileSystemSyncURL()">resolveLocalFileSystemSyncURL()</h3>

<p>ローカル URL で参照されたファイルやディレクトリの <code>Entry</code> を検索します。</p>

<pre class="notranslate">void resolveLocalFileSystemURL(
  in DOMString url
);</pre>

<h5 id="パラメータ_2">パラメータ</h5>

<dl>
 <dt>url</dt>
 <dd>ファイルシステム内のローカルファイルの URL。</dd>
</dl>

<h5 id="戻り値_2">戻り値</h5>

<dl>
 <dt><code><a href="/en/DOM/File_API/File_System_API/EntrySync" title="en/DOM/File_API/File_System_API/EntrySync">EntrySync</a></code></dt>
 <dd>ファイルシステム内のエントリを表すオブジェクト。</dd>
</dl>

<h5 id="例外_2">例外</h5>

<p>このメソッドは、以下のコードで <a href="/ja/docs/Web/API/FileException">FileException</a> が発生する可能性があります。</p>

<table class="standard-table">
 <thead>
  <tr>
   <th scope="col">例外</th>
   <th scope="col">説明</th>
  </tr>
  <tr>
   <td><code>ENCODING_ERR</code></td>
   <td>URL の構文が無効でした。</td>
  </tr>
  <tr>
   <td><code>NOT_FOUND_ERR</code></td>
   <td>URL は構造的には正しいのですが、存在しないリソースを参照しています。</td>
  </tr>
 </thead>
 <tbody>
  <tr>
   <td><code>SECURITY_ERR</code></td>
   <td>このアプリケーションは、ファイルシステムインターフェイスにアクセスする権限を持っていません。</td>
  </tr>
 </tbody>
</table>

<h2 id="Browser_Compatibility" name="Browser_Compatibility">ブラウザの互換性</h2>

<div class="hidden">このページの互換性テーブルは構造化データから生成されます。データに貢献したい場合は <a href="https://github.com/mdn/browser-compat-data">https://github.com/mdn/browser-compat-data</a> をチェックして、プルリクエストを送ってください。</div>

<p>{{Compat("api.LocalFileSystemSync")}}</p>

<h2 id="あわせて参照">あわせて参照</h2>

<p>Specification:{{ spec("http://dev.w3.org/2009/dap/file-system/pub/FileSystem/", "File API: Directories and System Specification", "WD") }}</p>

<p>Reference: <a href="/en/DOM/File_API/File_System_API" title="en/DOM/File_API/File_System_API">File System API</a></p>

<p>Introduction: <a href="/en/DOM/File_APIs/Filesystem/Basic_Concepts_About_the_Filesystem_API" title="en/DOM/File_APIs/Filesystem/Basic_Concepts_About_the_Filesystem_API">Basic Concepts About the File System API</a></p>