aboutsummaryrefslogtreecommitdiff
path: root/files/ru/mozilla/add-ons/webextensions/api/downloads/index.html
blob: 735dab43d5d048a5832b03176a83b54b23d3f0dc (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
---
title: downloads
slug: Mozilla/Add-ons/WebExtensions/API/downloads
translation_of: Mozilla/Add-ons/WebExtensions/API/downloads
---
<div>{{AddonSidebar}}</div>

<p><span class="tlid-translation translation" lang="ru"><span title="">Позволяет расширениям взаимодействовать с менеджером загрузки браузера.</span> <span title="">Этот модуль API можно использовать для загрузки, отмены, приостановки, возобновления загрузки файлов и отображения загруженных файлов в файловом менеджере.</span></span></p>

<p>Для использования этого API вам необходимо указать "downloads" <a href="/en-US/Add-ons/WebExtensions/manifest.json/permissions#API_permissions">API permission</a> в вашем <a href="https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json">manifest.json</a> файле.</p>

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

<dl>
 <dt>{{WebExtAPIRef("downloads.FilenameConflictAction")}}</dt>
 <dd><span class="tlid-translation translation" lang="ru"><span title="">Определяет действия в случае, если имя загружаемого файла конфликтует с именем существующего файла</span></span>.</dd>
 <dt>{{WebExtAPIRef("downloads.InterruptReason")}}</dt>
 <dd>Defines a set of possible reasons why a download was interrupted.</dd>
 <dt>{{WebExtAPIRef("downloads.DangerType")}}</dt>
 <dd>Defines a set of common warnings of possible dangers associated with downloadable files.</dd>
 <dt>{{WebExtAPIRef("downloads.State")}}</dt>
 <dd>Defines different states that a current download can be in.</dd>
 <dt>{{WebExtAPIRef("downloads.DownloadItem")}}</dt>
 <dd>Represents a downloaded file.</dd>
 <dt>{{WebExtAPIRef("downloads.StringDelta")}}</dt>
 <dd>Represents the difference between two strings.</dd>
 <dt>{{WebExtAPIRef("downloads.DoubleDelta")}}</dt>
 <dd>Represents the difference between two doubles.</dd>
 <dt>{{WebExtAPIRef("downloads.BooleanDelta")}}</dt>
 <dd>Represents the difference between two booleans.</dd>
 <dt>{{WebExtAPIRef("downloads.DownloadTime")}}</dt>
 <dd>Represents the time a download took to complete.</dd>
 <dt>{{WebExtAPIRef("downloads.DownloadQuery")}}</dt>
 <dd>Defines a set of parameters that can be used to search the downloads manager for a specific set of downloads.</dd>
</dl>

<h2 id="Functions">Functions</h2>

<dl>
 <dt>{{WebExtAPIRef("downloads.download()")}}</dt>
 <dd>Downloads a file, given its URL and other optional preferences.</dd>
 <dt>{{WebExtAPIRef("downloads.search()")}}</dt>
 <dd>Queries the {{WebExtAPIRef("downloads.DownloadItem", "DownloadItems")}} available in the browser's downloads manager, and returns those that match the specified search criteria.</dd>
 <dt>{{WebExtAPIRef("downloads.pause()")}}</dt>
 <dd>Pauses a download.</dd>
 <dt>{{WebExtAPIRef("downloads.resume()")}}</dt>
 <dd>Resumes a paused download.</dd>
 <dt>{{WebExtAPIRef("downloads.cancel()")}}</dt>
 <dd>Cancels a download.</dd>
 <dt>{{WebExtAPIRef("downloads.getFileIcon()")}}</dt>
 <dd>Retrieves an icon for the specified download.</dd>
 <dt>{{WebExtAPIRef("downloads.open()")}}</dt>
 <dd>Opens the downloaded file with its associated application.</dd>
 <dt>{{WebExtAPIRef("downloads.show()")}}</dt>
 <dd>Opens the platform's file manager application to show the downloaded file in its containing folder.</dd>
 <dt>{{WebExtAPIRef("downloads.showDefaultFolder()")}}</dt>
 <dd>Opens the platform's file manager application to show the default downloads folder.</dd>
 <dt>{{WebExtAPIRef("downloads.erase()")}}</dt>
 <dd>Erases matching {{WebExtAPIRef("downloads.DownloadItem", "DownloadItems")}} from the browser's download history, without deleting the downloaded files from disk.</dd>
 <dt>{{WebExtAPIRef("downloads.removeFile()")}}</dt>
 <dd>Removes a downloaded file from disk, but not from the browser's download history.</dd>
 <dt>{{WebExtAPIRef("downloads.acceptDanger()")}}</dt>
 <dd>Prompts the user to accept or cancel a dangerous download.</dd>
 <dt>{{WebExtAPIRef("downloads.drag()")}}</dt>
 <dd>Initiates dragging the downloaded file to another application.</dd>
 <dt>{{WebExtAPIRef("downloads.setShelfEnabled()")}}</dt>
 <dd>Enables or disables the gray shelf at the bottom of every window associated with the current browser profile. The shelf will be disabled as long as at least one extension has disabled it.</dd>
</dl>

<h2 id="Events">Events</h2>

<dl>
 <dt>{{WebExtAPIRef("downloads.onCreated")}}</dt>
 <dd>Fires with the {{WebExtAPIRef("downloads.DownloadItem", "DownloadItem")}} object when a download begins.</dd>
 <dt>{{WebExtAPIRef("downloads.onErased")}}</dt>
 <dd>Fires with the <code>downloadId</code> when a download is erased from history.</dd>
 <dt>{{WebExtAPIRef("downloads.onChanged")}}</dt>
 <dd>When any of a {{WebExtAPIRef("downloads.DownloadItem", "DownloadItem")}}'s properties except <code>bytesReceived</code> changes, this event fires with the <code>downloadId</code> and an object containing the properties that changed.</dd>
</dl>

<h2 id="Browser_compatibility">Browser compatibility</h2>

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

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

<div class="note"><strong>Acknowledgements</strong>

<p>This API is based on Chromium's <a href="https://developer.chrome.com/extensions/downloads"><code>chrome.downloads</code></a> API.</p>

<p>Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.</p>
</div>

<div class="hidden">
<pre class="notranslate">// 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>