Package Torello.Browser.BrowserAPI

Class Page.downloadWillBegin

java.lang.Object

Torello.Browser.BaseType<DOMAIN_NESTED>

Torello.Browser.BrowserEvent<Page.downloadWillBegin>

Torello.Browser.BrowserAPI.Page.downloadWillBegin

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BaseType<?>>

Enclosing class:

Page

public static class Page.downloadWillBegin
extends BrowserEvent<Page.downloadWillBegin>
implements java.io.Serializable

This Nested Java Class is declared as an Event-Type by the CDP API Specifications. This class largely functions as a data container or "data record", and encapsulates the datum values that Google Chrome is incorporating into the event that it is firing.

📌 All browser domain event classes will have a class name that begins with a lower case letter.

👉 Note that this particular event can be fired by the Page domain, located in the BrowserAPI. A browser 'domain' is quite similar to a Java Package. It incorporates a suite of features, types and functions under one umbrella.

Fired when page is about to start a download. Deprecated. Use Browser.downloadWillBegin instead.
EXPERIMENTALDEPRECATED

See Also:

Serialized Form

Hi-Lited Source-Code:

This File's Source Code:

• View Here: Torello/Browser/BrowserAPI/Page.java
• Open New Browser-Tab: Torello/Browser/BrowserAPI/Page.java

File Size: 2,347 Bytes Line Count: 57 '\n' Characters Found
Helper: Equals, HashCode, toJSON, etc

• View Here: Page$$downloadWillBegin$$.java
• Open New Browser-Tab: Page$$downloadWillBegin$$.java

File Size: 8,902 Bytes Line Count: 215 '\n' Characters Found

Field Summary

Serializable ID
Modifier and Type	Field	Description
protected static long	serialVersionUID
Type Fields / Properties (from Google & Browser Specs)
Modifier and Type	Field	Description
String	frameId	Id of the frame that caused download to begin.
String	guid	Global unique identifier of the download.
String	suggestedFilename	Suggested file name of the resource (the actual name of the file saved on disk may differ).
String	url	URL of the resource being downloaded.

Fields inherited from class Torello.Browser.BaseType

domain, helperSingleton, isPresent, name, numFields

Constructor Summary

Constructors

Constructor	Description
downloadWillBegin(ReadOnlyList<Boolean> isPresent, String frameId, String guid, String url, String suggestedFilename)	Constructor.

Method Summary

Static Builder Convert a JsonObject to a POJO
Modifier and Type	Method	Description
static Page.downloadWillBegin	fromJSON(JsonObject jo)	Creates an instance of this class from a JsonObject.
Retrieve the Type-Descriptor Singleton-Instance for this Nested Class.
Modifier and Type	Method	Description
static NestedDescriptor<Page.downloadWillBegin>	descriptor()	Returns this class's NestedDescriptor singleton-instance.

Methods inherited from class Torello.Browser.BaseType

allEnumStrROLs, compareTo, enumStrList, enumStrValidate, enumStrValidateThrow, equals, hashCode, isPresent, optionalsValidate, optionalsValidateThrow, toJSON, toString

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

🡇 ⇈ ⮫ 🗕 🗗 🗖

protected static final long serialVersionUID

This fulfils the SerialVersion UID requirement for all classes that implement Java's interface java.io.Serializable. Using the Serializable Implementation offered by java is very easy, and can make saving program state when debugging a lot easier. It can also be used in place of more complicated systems like "hibernate" to store data as well.

See Also:

Constant Field Values

frameId

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String frameId

Id of the frame that caused download to begin.

guid

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String guid

Global unique identifier of the download.

url

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String url

URL of the resource being downloaded.

suggestedFilename

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String suggestedFilename

Suggested file name of the resource (the actual name of the file saved on disk may differ).

Constructor Detail

downloadWillBegin

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public downloadWillBegin(ReadOnlyList<java.lang.Boolean> isPresent,
                         java.lang.String frameId,
                         java.lang.String guid,
                         java.lang.String url,
                         java.lang.String suggestedFilename)

Constructor. Please review this class' fields for documentation.

Method Detail

fromJSON

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Page.downloadWillBegin fromJSON(JsonObject jo)

Creates an instance of this class from a JsonObject.

Code:

Exact Method Body:

 return singleton.fromJSON(jo);

descriptor

🡅 ⇈ ⮫ 🗕 🗗 🗖

public static NestedDescriptor<Page.downloadWillBegin> descriptor()

Returns this class's NestedDescriptor singleton-instance. class / type.

Code:

Exact Method Body:

 return singleton.descriptor();