Package org.webkitgtk

Class Download

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.webkitgtk.Download

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public final class Download
extends GObject

Object used to communicate with the application when downloading.

WebKitDownload carries information about a download request and response, including a WebKitURIRequest and a WebKitURIResponse objects. The application may use this object to control the download process, or to simply figure out what is to be downloaded, and handle the download process itself.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Download.Builder<B extends Download.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	Download.CreatedDestinationCallback	Functional interface declaration of the CreatedDestinationCallback callback.
static interface	Download.DecideDestinationCallback	Functional interface declaration of the DecideDestinationCallback callback.
static class	Download.DownloadClass
static interface	Download.FailedCallback	Functional interface declaration of the FailedCallback callback.
static interface	Download.FinishedCallback	Functional interface declaration of the FinishedCallback callback.
static interface	Download.ReceivedDataCallback	Functional interface declaration of the ReceivedDataCallback callback.

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
Download()	Creates a new Download.
Download(MemorySegment address)	Create a Download proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected Download	asParent()	Returns this instance as if it were its parent type.
static Download.Builder<? extends Download.Builder>	builder()	A Download.Builder object constructs a Download with the specified properties.
void	cancel()	Cancels the download.
void	emitCreatedDestination(String destination)	Emits the "created-destination" signal.
boolean	emitDecideDestination(String suggestedFilename)	Emits the "decide-destination" signal.
void	emitFailed(@Nullable GError error)	Emits the "failed" signal.
void	emitFinished()	Emits the "finished" signal.
void	emitReceivedData(long dataLength)	Emits the "received-data" signal.
boolean	getAllowOverwrite()	Returns the current value of the WebKitDownload:allow-overwrite property.
@Nullable String	getDestination()	Obtains the destination to which the downloaded file will be written.
double	getElapsedTime()	Gets the elapsed time in seconds, including any fractional part.
double	getEstimatedProgress()	Gets the value of the WebKitDownload:estimated-progress property.
long	getReceivedDataLength()	Gets the length of the data already downloaded for download.
URIRequest	getRequest()	Retrieves the WebKitURIRequest object that backs the download process.
URIResponse	getResponse()	Retrieves the WebKitURIResponse object that backs the download process.
static @Nullable Type	getType()	Get the GType of the Download class
WebView	getWebView()	Get the WebKitWebView that initiated the download.
SignalConnection<Download.CreatedDestinationCallback>	onCreatedDestination(Download.CreatedDestinationCallback handler)	This signal is emitted after WebKitDownload::decide-destination and before WebKitDownload::received-data to notify that destination file has been created successfully at destination.
SignalConnection<Download.DecideDestinationCallback>	onDecideDestination(Download.DecideDestinationCallback handler)	This signal is emitted after response is received to decide a destination for the download using webkit_download_set_destination().
SignalConnection<Download.FailedCallback>	onFailed(Download.FailedCallback handler)	This signal is emitted when an error occurs during the download operation.
SignalConnection<Download.FinishedCallback>	onFinished(Download.FinishedCallback handler)	This signal is emitted when download finishes successfully or due to an error.
SignalConnection<Download.ReceivedDataCallback>	onReceivedData(Download.ReceivedDataCallback handler)	This signal is emitted after response is received, every time new data has been written to the destination.
void	setAllowOverwrite(boolean allowed)	Sets the WebKitDownload:allow-overwrite property.
void	setDestination(String destination)	Sets the destination to which the downloaded file will be written.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

Download

public Download(MemorySegment address)

Create a Download proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Download

public Download()

Creates a new Download.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Download class

Returns:

the GType

asParent

protected Download asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

cancel

public void cancel()

Cancels the download.

When the ongoing download operation is effectively cancelled the signal WebKitDownload::failed is emitted with DownloadError.CANCELLED_BY_USER error.

getAllowOverwrite

public boolean getAllowOverwrite()

Returns the current value of the WebKitDownload:allow-overwrite property.

Returns the current value of the WebKitDownload:allow-overwrite property, which determines whether the download will overwrite an existing file on disk, or if it will fail if the destination already exists.

Returns:

the current value of the WebKitDownload:allow-overwrite property

Since:

2.6

getDestination

public @Nullable String getDestination()

Obtains the destination to which the downloaded file will be written.

You can connect to WebKitDownload::created-destination to make sure this method returns a valid destination.

Returns:

the destination or null

getElapsedTime

public double getElapsedTime()

Gets the elapsed time in seconds, including any fractional part.

If the download finished, had an error or was cancelled this is the time between its start and the event.

Returns:

seconds since the download was started

getEstimatedProgress

public double getEstimatedProgress()

Gets the value of the WebKitDownload:estimated-progress property. Gets the value of the WebKitDownload:estimated-progress property. You can monitor the estimated progress of the download operation by connecting to the notify::estimated-progress signal of download.

Returns:

an estimate of the of the percent complete for a download as a range from 0.0 to 1.0.

getReceivedDataLength

public long getReceivedDataLength()

Gets the length of the data already downloaded for download.

Gets the length of the data already downloaded for this Download in bytes.

Returns:

the amount of bytes already downloaded.

getRequest

public URIRequest getRequest()

Retrieves the WebKitURIRequest object that backs the download process.

Returns:

the WebKitURIRequest of this Download

getResponse

public URIResponse getResponse()

Retrieves the WebKitURIResponse object that backs the download process.

Retrieves the WebKitURIResponse object that backs the download process. This method returns null if called before the response is received from the server. You can connect to notify::response signal to be notified when the response is received.

Returns:

the WebKitURIResponse, or null if the response hasn't been received yet.

getWebView

public WebView getWebView()

Get the WebKitWebView that initiated the download.

Returns:

the WebKitWebView that initiated download, or null if this Download was not initiated by a WebKitWebView.

setAllowOverwrite

public void setAllowOverwrite(boolean allowed)

Sets the WebKitDownload:allow-overwrite property.

Sets the WebKitDownload:allow-overwrite property, which determines whether the download may overwrite an existing file on disk, or if it will fail if the destination already exists.

Parameters:

allowed - the new value for the WebKitDownload:allow-overwrite property

Since:

2.6

setDestination

public void setDestination(String destination)

Sets the destination to which the downloaded file will be written.

This method should be called before the download transfer starts or it will not have any effect on the ongoing download operation. To set the destination using the filename suggested by the server connect to WebKitDownload::decide-destination signal and call webkit_download_set_destination(). If you want to set a fixed destination that doesn't depend on the suggested filename you can connect to notify::response signal and call webkit_download_set_destination().

If WebKitDownload::decide-destination signal is not handled and destination is not set when the download transfer starts, the file will be saved with the filename suggested by the server in UserDirectory.DIRECTORY_DOWNLOAD directory.

Parameters:

destination - the destination

onCreatedDestination

public SignalConnection<Download.CreatedDestinationCallback> onCreatedDestination(Download.CreatedDestinationCallback handler)

This signal is emitted after WebKitDownload::decide-destination and before WebKitDownload::received-data to notify that destination file has been created successfully at destination.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Download.CreatedDestinationCallback.run(java.lang.String)

emitCreatedDestination

public void emitCreatedDestination(String destination)

Emits the "created-destination" signal. See onCreatedDestination(org.webkitgtk.Download.CreatedDestinationCallback).

onDecideDestination

public SignalConnection<Download.DecideDestinationCallback> onDecideDestination(Download.DecideDestinationCallback handler)

This signal is emitted after response is received to decide a destination for the download using webkit_download_set_destination(). If this signal is not handled, the file will be downloaded to UserDirectory.DIRECTORY_DOWNLOAD directory using suggestedFilename.

Since 2.40, you may handle this signal asynchronously by returning true without calling webkit_download_set_destination(). This indicates intent to eventually call webkit_download_set_destination(). In this case, the download will not proceed until the destination is set or cancelled with webkit_download_cancel().

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Download.DecideDestinationCallback.run(java.lang.String)

emitDecideDestination

public boolean emitDecideDestination(String suggestedFilename)

Emits the "decide-destination" signal. See onDecideDestination(org.webkitgtk.Download.DecideDestinationCallback).

onFailed

public SignalConnection<Download.FailedCallback> onFailed(Download.FailedCallback handler)

This signal is emitted when an error occurs during the download operation. The given error, of the domain WEBKIT_DOWNLOAD_ERROR, contains further details of the failure. If the download is cancelled with webkit_download_cancel(), this signal is emitted with error DownloadError.CANCELLED_BY_USER. The download operation finishes after an error and WebKitDownload::finished signal is emitted after this one.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Download.FailedCallback.run(org.gnome.glib.GError)

emitFailed

public void emitFailed(@Nullable GError error)

Emits the "failed" signal. See onFailed(org.webkitgtk.Download.FailedCallback).

onFinished

public SignalConnection<Download.FinishedCallback> onFinished(Download.FinishedCallback handler)

This signal is emitted when download finishes successfully or due to an error. In case of errors WebKitDownload::failed signal is emitted before this one.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Download.FinishedCallback.run()

emitFinished

public void emitFinished()

Emits the "finished" signal. See onFinished(org.webkitgtk.Download.FinishedCallback).

onReceivedData

public SignalConnection<Download.ReceivedDataCallback> onReceivedData(Download.ReceivedDataCallback handler)

This signal is emitted after response is received, every time new data has been written to the destination. It's useful to know the progress of the download operation.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Download.ReceivedDataCallback.run(long)

emitReceivedData

public void emitReceivedData(long dataLength)

Emits the "received-data" signal. See onReceivedData(org.webkitgtk.Download.ReceivedDataCallback).

builder

public static Download.Builder<? extends Download.Builder> builder()

A Download.Builder object constructs a Download with the specified properties. Use the various set...() methods to set properties, and finish construction with Download.Builder.build().

Returns:

the builder object