1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
---
title: storage.local
slug: Mozilla/Add-ons/WebExtensions/API/storage/local
translation_of: Mozilla/Add-ons/WebExtensions/API/storage/local
---
<div>{{AddonSidebar()}}</div>
<p><code>local</code> ストレージ領域を指します。<code>local</code>ストレージ内のアイテムはその拡張機能がインストールされたマシン内で利用できます。</p>
<p>ブラウザーは拡張機能がローカルストレージエリアに保存できるデータ量を制限します。</p>
<ul>
<li>Chromeでは、このAPIを使用して、<a href="/en-US/Add-ons/WebExtensions/manifest.json/permissions#Unlimited_storage">"unlimitedStorage"</a>パーミッションを許可しない場合は5MBまで保存できます。</li>
<li>Firefox ではバージョン56以降で"unlimitedStorage"パーミッションを利用できます。保存できるデータ量は現在では制限していませんが、将来的には制限するため、もし大きなデータ量を保存するのであれば"unlimitedStorage"パーミッションを今から使用するとよいでしょう。</li>
</ul>
<p>拡張機能をアンインストールすると、関連するローカルストレージは削除されます。</p>
<p>またFirefoxでは、"about:config"で"keepUuidOnUninstall"と"keepStorageOnUninstall"の設定を<code>true</code>にすることで、アンインストール時にデータが削除されることを防ぐことができます。 この機能は拡張機能開発のテストのために提供されています。拡張機能自身ではこれらの設定を変更できません。</p>
<p>このAPIは {{domxref("Window.localStorage")}}に似ていますが、拡張機能のコード内で<code>Window.localStorage</code>を使用することは推奨されません。これはユーザがプライバシーのために履歴とデータを削除するなど、FirefoxはlocalStorage APIを用いて拡張機能が保存したデータを削除することがあるためです。</p>
<h2 id="関数">関数</h2>
<p><code>local</code>オブジェクトは{{WebExtAPIRef("storage.StorageArea")}} 型で定義された関数を実装しています。</p>
<dl>
<dt>{{WebExtAPIRef("storage.StorageArea.get()")}}</dt>
<dd>ストレージ領域から 1つ以上のアイテムを取得します。</dd>
<dt>{{WebExtAPIRef("storage.StorageArea.getBytesInUse()")}}</dt>
<dd>1つ以上のストレージ領域内に格納されたアイテムが占めるストレージ空間をバイト単位で取得します。</dd>
<dt>{{WebExtAPIRef("storage.StorageArea.set()")}}</dt>
<dd>1つ以上のアイテムをストレージ領域に格納します。既にアイテムが存在していれば値は上書きされます。 値を格納したとき{{WebExtAPIRef("storage.onChanged")}}イベントが発火します。</dd>
<dt>{{WebExtAPIRef("storage.StorageArea.remove()")}}</dt>
<dd>ストレージ領域内の1つ以上のアイテムを削除します。</dd>
<dt>{{WebExtAPIRef("storage.StorageArea.clear()")}}</dt>
<dd>ストレージ領域内の全てのアイテムを削除します。</dd>
</dl>
<h2 id="ブラウザ互換状況">ブラウザ互換状況</h2>
<p>{{Compat("webextensions.api.storage.local")}}</p>
<p>{{WebExtExamples}}</p>
<div class="note"><strong>Acknowledgements</strong>
<p>このAPIはChromiumの <a href="https://developer.chrome.com/extensions/storage#property-local"><code>chrome.storage</code></a> APIに基づいています。また、このドキュメントは <a href="https://chromium.googlesource.com/chromium/src/+/master/extensions/common/api/storage.json"><code>storage.json</code></a>における Chromium のコードに基づいています。</p>
<p>Microsoft Edge での実装状況は Microsoft Corporation から提供されたものであり、ここでは Creative Commons Attribution 3.0 United States License に従っています。</p>
</div>
<div class="hidden">
<pre>// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</pre>
</div>
|
