aboutsummaryrefslogtreecommitdiff
path: root/files/ja/mozilla/add-ons/webextensions/api/downloads/index.html
blob: 98dcaef054e3cda6349d424dac686f558a8821bb (plain)
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
---
title: downloads
slug: Mozilla/Add-ons/WebExtensions/API/downloads
tags:
  - API
  - Add-ons
  - Extensions
  - Interface
  - Non-standard
  - Reference
  - WebExtensions
  - downloads
translation_of: Mozilla/Add-ons/WebExtensions/API/downloads
---
<div>{{AddonSidebar}}</div>

<p>拡張機能にブラウザーのダウンロードマネージャーとのやりとりを可能にします。このAPI モジュールを、ファイルマネージャーでのファイルのダウンロード、キャンセル、停止、ダウンロードの再開、ダウンロード済みのファイルの表示に使用できます。</p>

<p>このAPIを使うには <a href="https://developer.mozilla.org/ja/docs/Mozilla/Add-ons/WebExtensions/manifest.json">manifest.json</a> ファイルで指定する "downloads" <a href="/JA/Add-ons/WebExtensions/manifest.json/permissions#API_permissions">API パーミッション</a>が必要です。</p>

<h2 id="Types" name="Types"></h2>

<dl>
 <dt>{{WebExtAPIRef("downloads.FilenameConflictAction")}}</dt>
 <dd>ダウンロードされたファイル名が既存ファイルと衝突する場合の動作オプション定義</dd>
 <dt>{{WebExtAPIRef("downloads.InterruptReason")}}</dt>
 <dd>ダウンロードが中断された理由の集合を定義</dd>
 <dt>{{WebExtAPIRef("downloads.DangerType")}}</dt>
 <dd>ダウンロード可能なファイルに関連した想定される危険性への警告の集合を定義</dd>
 <dt>{{WebExtAPIRef("downloads.State")}}</dt>
 <dd>現在のダウンロードが取りうるさまざまな状態を定義</dd>
 <dt>{{WebExtAPIRef("downloads.DownloadItem")}}</dt>
 <dd>ダウンロード済みのファイルを表現する</dd>
 <dt>{{WebExtAPIRef("downloads.StringDelta")}}</dt>
 <dd>2つの文字列の差異を表現する</dd>
 <dt>{{WebExtAPIRef("downloads.DoubleDelta")}}</dt>
 <dd>2つの倍精度実数の差異を表現する</dd>
 <dt>{{WebExtAPIRef("downloads.BooleanDelta")}}</dt>
 <dd>2つの真偽値の差異を表現する</dd>
 <dt>{{WebExtAPIRef("downloads.DownloadTime")}}</dt>
 <dd>ダウンロード完了にかかった時間を表現する</dd>
 <dt>{{WebExtAPIRef("downloads.DownloadQuery")}}</dt>
 <dd>ダウンロードマネージャーで特定のダウンロードを検索するのに使われるパラメーターを定義</dd>
</dl>

<h2 id="Functions" name="Functions">関数</h2>

<dl>
 <dt>{{WebExtAPIRef("downloads.download()")}}</dt>
 <dd>URL とオプション設定を与えて、ファイルをダウンロードします</dd>
 <dt>{{WebExtAPIRef("downloads.search()")}}</dt>
 <dd>ブラウザーのダウンロードマネージャーで使える {{WebExtAPIRef("downloads.DownloadItem", "DownloadItems")}} に問い合わせて、指定した検索条件にマッチするものを返します</dd>
 <dt>{{WebExtAPIRef("downloads.pause()")}}</dt>
 <dd>ダウンロードを停止します</dd>
 <dt>{{WebExtAPIRef("downloads.resume()")}}</dt>
 <dd>停止したダウンロードを再開します</dd>
 <dt>{{WebExtAPIRef("downloads.cancel()")}}</dt>
 <dd>ダウンロードをキャンセルします</dd>
 <dt>{{WebExtAPIRef("downloads.getFileIcon()")}}</dt>
 <dd>指定したダウンロードのアイコンを取得します</dd>
 <dt>{{WebExtAPIRef("downloads.open()")}}</dt>
 <dd>関連付けられたアプリケーションでダウンロード済みのファイルを開きます</dd>
 <dt>{{WebExtAPIRef("downloads.show()")}}</dt>
 <dd>プラットフォームのファイルマネージャーアプリケーションを開いて、ダウンロードフォルダー内のファイルを表示します</dd>
 <dt>{{WebExtAPIRef("downloads.showDefaultFolder()")}}</dt>
 <dd>プラットフォームのファイルマネージャーアプリケーションを開いて、デフォルトのダウンロードフォルダーを表示します</dd>
 <dt>{{WebExtAPIRef("downloads.erase()")}}</dt>
 <dd>ダウンロード済みのファイルをディスクから消去することなく、ブラウザーのダウンロード履歴からマッチした {{WebExtAPIRef("downloads.DownloadItem", "DownloadItems")}} を消去します</dd>
 <dt>{{WebExtAPIRef("downloads.removeFile()")}}</dt>
 <dd>ブラウザーのダウンロード履歴ではなく、ダウンロード済みのファイルをディスクから消去します</dd>
 <dt>{{WebExtAPIRef("downloads.acceptDanger()")}}</dt>
 <dd>危険なダウンロードを受け入れるかキャンセルするかを、ユーザーに確認します</dd>
 <dt>{{WebExtAPIRef("downloads.drag()")}}</dt>
 <dd>ダウンロード済みのファイルを他のアプリケーションにドラッグし始めます</dd>
 <dt>{{WebExtAPIRef("downloads.setShelfEnabled()")}}</dt>
 <dd>現在のブラウザープロファイルに関連するすぺてのウィンドウの下のグレーの棚を有効化/無効化します。この棚は少なくとも1つの拡張機能が無効化すると無効になります。</dd>
</dl>

<h2 id="Events" name="Events">イベント</h2>

<dl>
 <dt>{{WebExtAPIRef("downloads.onCreated")}}</dt>
 <dd>ダウンロード開始時に {{WebExtAPIRef("downloads.DownloadItem", "DownloadItem")}} オブジェクトと共に発火します</dd>
 <dt>{{WebExtAPIRef("downloads.onErased")}}</dt>
 <dd>ダウンロードが履歴から消去された時に <code>downloadId</code> と共に発火します</dd>
 <dt>{{WebExtAPIRef("downloads.onChanged")}}</dt>
 <dd><code>bytesReceived</code> を除くいかなる {{WebExtAPIRef("downloads.DownloadItem", "DownloadItem")}} のプロパティが変わった時、このイベントは <code>downloadId</code> や変更したプロパティを含むオブジェクトと共に発火します</dd>
</dl>

<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザ実装状況</h2>

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

<p>{{WebExtExamples("h2")}}</p>

<div class="note"><strong>謝辞</strong>

<p>この API は Chromium の <a href="https://developer.chrome.com/extensions/downloads"><code>chrome.downloads</code></a> API に基づいています。</p>

<p>Microsoft Edge での実装状況は Microsoft Corporation から提供されたものであり、ここでは Creative Commons Attribution 3.0 United States License に従っています。</p>

<p> </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>