org.mozilla.geckoview

Class WebExtension.Download

Object

org.mozilla.geckoview.WebExtension.Download

Enclosing class:

WebExtension

public static class WebExtension.Download
extends Object

Represents a download for downloads API Instantiate using WebExtensionController.createDownload(int)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WebExtension.Download.DownloadInterruptReason Represents a possible reason why a download was interrupted.
static interface	WebExtension.Download.DownloadState Represents a download in progress where the app is currently receiving data from the server.
static interface	WebExtension.Download.Info Interface for communicating the state of downloads to Web Extensions.

Field Summary

Fields

Modifier and Type	Field and Description
int	id Represents a unique identifier for the downloaded item that is persistent across browser sessions
static int	INTERRUPT_REASON_CRASH
static int	INTERRUPT_REASON_FILE_ACCESS_DENIED
static int	INTERRUPT_REASON_FILE_BLOCKED
static int	INTERRUPT_REASON_FILE_FAILED
static int	INTERRUPT_REASON_FILE_NAME_TOO_LONG
static int	INTERRUPT_REASON_FILE_NO_SPACE
static int	INTERRUPT_REASON_FILE_SECURITY_CHECK_FAILED
static int	INTERRUPT_REASON_FILE_TOO_LARGE
static int	INTERRUPT_REASON_FILE_TOO_SHORT
static int	INTERRUPT_REASON_FILE_TRANSIENT_ERROR
static int	INTERRUPT_REASON_FILE_VIRUS_INFECTED
static int	INTERRUPT_REASON_NETWORK_DISCONNECTED
static int	INTERRUPT_REASON_NETWORK_FAILED
static int	INTERRUPT_REASON_NETWORK_INVALID_REQUEST
static int	INTERRUPT_REASON_NETWORK_SERVER_DOWN
static int	INTERRUPT_REASON_NETWORK_TIMEOUT
static int	INTERRUPT_REASON_NO_INTERRUPT
static int	INTERRUPT_REASON_SERVER_BAD_CONTENT
static int	INTERRUPT_REASON_SERVER_CERT_PROBLEM
static int	INTERRUPT_REASON_SERVER_FAILED
static int	INTERRUPT_REASON_SERVER_FORBIDDEN
static int	INTERRUPT_REASON_SERVER_NO_RANGE
static int	INTERRUPT_REASON_SERVER_UNAUTHORIZED
static int	INTERRUPT_REASON_USER_CANCELED
static int	INTERRUPT_REASON_USER_SHUTDOWN
static int	STATE_COMPLETE The download completed successfully.
static int	STATE_IN_PROGRESS Download is in progress.
static int	STATE_INTERRUPTED An error broke the connection with the server.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Download(int id) For testing.

Method Summary

Modifier and Type	Method and Description
GeckoResult<Void>	update(WebExtension.Download.Info data) Updates the download state.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id

public final int id

Represents a unique identifier for the downloaded item that is persistent across browser sessions

STATE_IN_PROGRESS

public static final int STATE_IN_PROGRESS

Download is in progress. Default state

See Also:

Constant Field Values

STATE_INTERRUPTED

public static final int STATE_INTERRUPTED

An error broke the connection with the server.

See Also:

Constant Field Values

STATE_COMPLETE

public static final int STATE_COMPLETE

The download completed successfully.

See Also:

Constant Field Values

INTERRUPT_REASON_NO_INTERRUPT

public static final int INTERRUPT_REASON_NO_INTERRUPT

See Also:

Constant Field Values

INTERRUPT_REASON_FILE_FAILED

public static final int INTERRUPT_REASON_FILE_FAILED

See Also:

Constant Field Values

INTERRUPT_REASON_FILE_ACCESS_DENIED

public static final int INTERRUPT_REASON_FILE_ACCESS_DENIED

See Also:

Constant Field Values

INTERRUPT_REASON_FILE_NO_SPACE

public static final int INTERRUPT_REASON_FILE_NO_SPACE

See Also:

Constant Field Values

INTERRUPT_REASON_FILE_NAME_TOO_LONG

public static final int INTERRUPT_REASON_FILE_NAME_TOO_LONG

See Also:

Constant Field Values

INTERRUPT_REASON_FILE_TOO_LARGE

public static final int INTERRUPT_REASON_FILE_TOO_LARGE

See Also:

Constant Field Values

INTERRUPT_REASON_FILE_VIRUS_INFECTED

public static final int INTERRUPT_REASON_FILE_VIRUS_INFECTED

See Also:

Constant Field Values

INTERRUPT_REASON_FILE_TRANSIENT_ERROR

public static final int INTERRUPT_REASON_FILE_TRANSIENT_ERROR

See Also:

Constant Field Values

INTERRUPT_REASON_FILE_BLOCKED

public static final int INTERRUPT_REASON_FILE_BLOCKED

See Also:

Constant Field Values

INTERRUPT_REASON_FILE_SECURITY_CHECK_FAILED

public static final int INTERRUPT_REASON_FILE_SECURITY_CHECK_FAILED

See Also:

Constant Field Values

INTERRUPT_REASON_FILE_TOO_SHORT

public static final int INTERRUPT_REASON_FILE_TOO_SHORT

See Also:

Constant Field Values

INTERRUPT_REASON_NETWORK_FAILED

public static final int INTERRUPT_REASON_NETWORK_FAILED

See Also:

Constant Field Values

INTERRUPT_REASON_NETWORK_TIMEOUT

public static final int INTERRUPT_REASON_NETWORK_TIMEOUT

See Also:

Constant Field Values

INTERRUPT_REASON_NETWORK_DISCONNECTED

public static final int INTERRUPT_REASON_NETWORK_DISCONNECTED

See Also:

Constant Field Values

INTERRUPT_REASON_NETWORK_SERVER_DOWN

public static final int INTERRUPT_REASON_NETWORK_SERVER_DOWN

See Also:

Constant Field Values

INTERRUPT_REASON_NETWORK_INVALID_REQUEST

public static final int INTERRUPT_REASON_NETWORK_INVALID_REQUEST

See Also:

Constant Field Values

INTERRUPT_REASON_SERVER_FAILED

public static final int INTERRUPT_REASON_SERVER_FAILED

See Also:

Constant Field Values

INTERRUPT_REASON_SERVER_NO_RANGE

public static final int INTERRUPT_REASON_SERVER_NO_RANGE

See Also:

Constant Field Values

INTERRUPT_REASON_SERVER_BAD_CONTENT

public static final int INTERRUPT_REASON_SERVER_BAD_CONTENT

See Also:

Constant Field Values

INTERRUPT_REASON_SERVER_UNAUTHORIZED

public static final int INTERRUPT_REASON_SERVER_UNAUTHORIZED

See Also:

Constant Field Values

INTERRUPT_REASON_SERVER_CERT_PROBLEM

public static final int INTERRUPT_REASON_SERVER_CERT_PROBLEM

See Also:

Constant Field Values

INTERRUPT_REASON_SERVER_FORBIDDEN

public static final int INTERRUPT_REASON_SERVER_FORBIDDEN

See Also:

Constant Field Values

INTERRUPT_REASON_USER_CANCELED

public static final int INTERRUPT_REASON_USER_CANCELED

See Also:

Constant Field Values

INTERRUPT_REASON_USER_SHUTDOWN

public static final int INTERRUPT_REASON_USER_SHUTDOWN

See Also:

Constant Field Values

INTERRUPT_REASON_CRASH

public static final int INTERRUPT_REASON_CRASH

See Also:

Constant Field Values

Constructor Detail

Download

protected Download(int id)

For testing.

Parameters:

id - - integer id for the download item

Method Detail

update

@Nullable
 @UiThread
public GeckoResult<Void> update(@NonNull
                                                     WebExtension.Download.Info data)

Updates the download state. This will trigger a call to downloads.onChanged event to the corresponding `DownloadItem` on the extension side.

Parameters:

data - - current metadata associated with the download. WebExtension.Download.Info implementation instance

Returns:

GeckoResult with nothing or error inside