Download chrome extension api

Indicates whether the download is progressing, interrupted, or complete. Number of bytes in the whole file post-decompression, or -1 if unknown. The callback parameter should be a function that looks like this:. If the request was successful the download is in a paused state. The request will fail if the download is not active. Resume a paused download. If the request was successful the download is in progress and unpaused. When callback is run, the download is cancelled, completed, interrupted or doesn't exist anymore.

The suggest parameter download chrome extension api be a function that looks like this:. The DownloadItem 's new target Download chrome extension api. The action to take if filename already exists. DangerType Enum "file""url" download chrome extension api, "content""uncommon""host""unwanted""safe"or "accepted" file The download's filename is suspicious. DownloadItem properties integer id An identifier that is persistent across browser sessions.

The id of the DownloadItem that changed. During the filename determination process, extensions will be given the opportunity to override the target DownloadItem. Each extension may not register more than one listener for this event. Each listener must call suggest exactly once, either synchronously or asynchronously. If the listener calls suggest asynchronously, then it must return true.

May change if the extension changes its name or if the user changes their locale. If the URL uses the HTTP[S] protocol, then the request will include all cookies currently set for its hostname.

Limits results to DownloadItem that started after the given ms since the epoch. Limits results download chrome extension api DownloadItem that ended before the given ms since the epoch. Limits results to DownloadItem that ended after the given ms since the epoch. Limits results to DownloadItem whose totalBytes is greater than the given integer. Limits results to DownloadItem whose totalBytes is less than the given integer.

When all the data is fetched into a temporary file and either the download is not dangerous or the danger has been accepted, then the temporary file is renamed to the target filename, the state changes to 'complete', and onChanged fires. The identifier for the DownloadItem. Initiate dragging the downloaded file to another application. Call in a javascript ondragstart handler. Enable or disable the gray shelf at the bottom of every window associated with the current browser profile.

Absolute paths, empty paths, and paths containing back-references ". Use download chrome extension api file-chooser to allow the user to select a filename regardless of whether filename is set or already exists. Extra HTTP headers to send with the request if the URL uses the HTTP[s] protocol. Each header is represented as a dictionary containing the keys name and either value or binaryValuerestricted to those allowed by XMLHttpRequest.

DangerType optional danger Indication of whether this download is thought to be safe or known to be suspicious. State optional state Indicates whether the download is progressing, download chrome extension api, or complete. InterruptReason optional error Why a download was interrupted. Parameters integer downloadId Download chrome extension api id of the download to pause.

Download chrome extension api order to avoid confusion regarding which extension will win, users should not install extensions that may conflict. If the download is initiated by download and the target filename is known before the MIME type and tentative filename have been determined, pass filename to download instead.

Set query to the empty object to get all DownloadItem. To get a specific DownloadItemset only the id field. To page through a large number of items, set orderBy: This array of search terms limits results to DownloadItem whose filename or url or finalUrl contain all of the search terms that do not begin with a dash '-' and none of the search terms that do begin with a dash. Limits results to DownloadItem that started before the given ms since the epoch.

If the download started successfully, callback will be called with the new DownloadItem 's downloadId. The error strings are not guaranteed to remain backwards compatible between releases. Extensions must not parse it. A file path relative to the Downloads directory to contain the downloaded file, possibly containing subdirectories.

False if this download is recorded in the history, true if it is not recorded. Indication of whether this download is thought to be safe or known to be suspicious. The time when the download began in ISO format. May be passed directly to the Date constructor: The time when the download ended in ISO format. Estimated time when the download will complete in ISO format. True if the download has stopped reading data from the host, but kept the connection open. True if the download is in progress and paused, or else if it is interrupted and can be resumed starting from where it download chrome extension api interrupted.

If you specify the callback parameter, it should be a function that looks like this: Parameters integer downloadId The id of the download to resume. Parameters integer downloadId The id of the download to cancel. Parameters integer downloadId The identifier download chrome extension api the download.

BooleanDelta optional exists The change in existsif any. Google Terms of Service Privacy Policy Report a content bug. An identifier that is persistent across browser sessions. The file's MIME type. What to download and download chrome extension api. The URL to download. The HTTP method to use if the URL uses the HTTP[S] protocol.

StringDelta optional mime The change in mimeif any. StringDelta optional startTime The change in startTimeif any. StringDelta optional endTime The change in endTimeif any. StringDelta optional state The change in stateif any. BooleanDelta optional canResume The change in canResumeif any.

The identifier for the extension that initiated this download if this download was initiated by an extension. Does not change once it is set. The localized name of the extension that initiated this download if this download was initiated by an extension.

If both filename and saveAs are specified, then the Save As dialog will be displayed, pre-populated with the specified filename.

Call search in order to trigger the check for file existence. When the existence check completes, if the file has been deleted, download chrome extension api an onChanged event will fire. Note that search does not wait for the existence check to finish before returning, so results from search may not accurately reflect the file system. Also, search may be called as often as necessary, but will not check for file existence any more frequently than once every 10 seconds.

StringDelta optional finalUrl Since Chrome The change in download chrome extension apiif any. StringDelta optional filename The change in filenameif any. StringDelta optional danger The change in danger download chrome extension api, if any.

Called with the id of the new DownloadItem. If you specify the callback parameter, it should be a function that looks like this:.

The suggest parameter should be a function that looks like this:

DangerType danger Indication of whether this download is thought to be safe or known to be suspicious. InterruptReason optional error Why the download was interrupted. StringDelta properties string optional previous string optional current. DoubleDelta Since Chrome BooleanDelta properties boolean optional previous boolean optional current. Parameters object options What to download and how. FilenameConflictAction optional conflictAction The action to take if filename already exists.

Remove the downloaded file if it exists and the DownloadItem is complete; download chrome extension api return an error through runtime. Prompt the user to accept a dangerous download. Does not automatically accept dangerous downloads. If the download is accepted, then an onChanged event will fire, otherwise nothing will happen.

The icon that is returned will therefore depend on a number of factors including state of the download, platform, registered file types and visual theme. If a file icon cannot be determined, runtime.

Retrieve an icon for the specified download. For new downloads, file icons are available after the onCreated event has been received. The image returned by this function while a download is in progress may be different from the image returned after the download is complete. Icon retrieval is done by querying the underlying operating system or toolkit depending on the platform.

The id of the download to resume. Called when the resume request is completed. The id of the download to cancel. Called when the cancel request is completed. The identifier for the download. A URL to an image that represents the download.

Set elements of this array to DownloadItem properties in order to sort search results. To specify descending order, prefix with a hyphen: The id of the DownloadItem to query. The absolute URL that this download initiated from, before any redirects.

Properties of each object string name Name of the HTTP header. Parameters object query array of string optional query This array of search terms limits results to DownloadItem whose filename or url or finalUrl contain all of the search terms that do not begin with a dash download chrome extension api and none of the search terms that do begin with a dash.

You must declare the "downloads" permission in the extension manifest to use this API. You can find simple examples of using the chrome. For other examples and for help in viewing the source code, see Samples. The absolute URL that this download is being made from, after all redirects.

An onChanged event will fire when the item is opened for the first time. Erase matching DownloadItem from history without deleting the downloaded file. An onErased event will fire for each DownloadItem that matches querythen callback will be called.

The callback parameter should be a function that looks like this: Parameters integer downloadId The identifier for the downloaded file. Show the downloaded file in its folder in a file manager. Show the default Downloads folder in a file manager. Parameters integer downloadId function optional callback If you specify the callback parameter, it should be a function that looks like this: Parameters integer downloadId The identifier for the DownloadItem. Parameters function callback The callback download chrome extension api should be a function that looks like this: StringDelta optional url The change in urlif any.

Download chrome extension api optional paused The change in pausedif any. StringDelta optional error The change in errorif any. DoubleDelta optional totalBytes The change in totalBytesif any. DoubleDelta optional fileSize The change in fileSizeif any.

The download chrome extension api of the returned icon. The default and largest size for the icon is 32x32 pixels. The only supported sizes are 16 and It is an error to specify any other size. Open the downloaded file now if the DownloadItem is complete; otherwise returns an error through runtime.

Limits results to DownloadItem whose filename matches the given regular expression. Limits results to DownloadItem whose url matches the given regular expression. Limits results to DownloadItem whose finalUrl matches the given download chrome extension api expression. The maximum download chrome extension api of matching DownloadItem returned. Set to 0 in order to return all matching DownloadItem. See search for how to page through results.

If the listener neither calls suggest synchronously nor returns truethen suggest will be called automatically. The DownloadItem will not complete until all listeners have called download chrome extension api. Listeners may call suggest without any arguments in order to allow the download to use downloadItem. If more than one extension overrides the filename, then the last extension download chrome extension api whose listener passes a suggestion object to suggest wins.

The identifier for the downloaded file. Called when the danger prompt dialog closes. The change in urlif any. The change in filename download chrome extension api, if any. The change in dangerif any. The change in mimeif any. The change in startTimeif any. The change in endTimeif any. The change in download chrome extension apiif any. The change in canResumeif any. The change in pausedif any. The change in errorif any. The change in totalBytesif any. The change in fileSizeif any. The change in existsif any.

Properties of each object string. Name of the HTTP header. Value of the HTTP header. Why a download was interrupted. Whether the downloaded file exists. The id of the download to pause. Called when the pause request is completed.

Why the download was interrupted. Number of bytes received so far from the host, without considering file compression. Number of bytes in the whole file, without considering file compression, or -1 if unknown. Whether the downloaded file still exists. This information may be out of date because Chrome does not download chrome extension api watch for file removal.

The shelf will be disabled as long as at least one extension has disabled it. Enabling the shelf while at least one other extension has disabled it will return an error through runtime. This event fires with the DownloadItem object when a download begins. Fires with the downloadId when a download is erased from history. The id of the DownloadItem that was erased. When any of a DownloadItem 's properties except bytesReceived and estimatedEndTime changes, this event fires with the downloadId and an object containing the properties that changed.