Package Torello.Browser.BrowserAPI

Class Network.requestWillBeSent

java.lang.Object

Torello.Browser.BaseType<DOMAIN_NESTED>

Torello.Browser.BrowserEvent<Network.requestWillBeSent>

Torello.Browser.BrowserAPI.Network.requestWillBeSent

All Implemented Interfaces:

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

Enclosing class:

Network

public static class Network.requestWillBeSent
extends BrowserEvent<Network.requestWillBeSent>
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 Network 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 send HTTP request.

See Also:

Serialized Form

Hi-Lited Source-Code:

This File's Source Code:

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

File Size: 4,215 Bytes Line Count: 108 '\n' Characters Found
Helper: Equals, HashCode, toJSON, etc

• View Here: Network$$requestWillBeSent$$.java
• Open New Browser-Tab: Network$$requestWillBeSent$$.java

File Size: 14,477 Bytes Line Count: 349 '\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	documentURL	URL of the document this request is loaded for.
String	frameId	Frame identifier.
Boolean	hasUserGesture	Whether the request is initiated by a user gesture.
Network.Initiator	initiator	Request initiator.
String	loaderId	Loader identifier.
boolean	redirectHasExtraInfo	In the case that redirectResponse is populated, this flag indicates whether requestWillBeSentExtraInfo and responseReceivedExtraInfo events will be or were emitted for the request which was just redirected.
Network.Response	redirectResponse	Redirect response data.
Network.Request	request	Request data.
String	requestId	Request identifier.
Number	timestamp	Timestamp.
String	type	Type of this resource.
Number	wallTime	Timestamp.

Fields inherited from class Torello.Browser.BaseType

domain, helperSingleton, isPresent, name, numFields

Constructor Summary

Constructors

Constructor	Description
requestWillBeSent(ReadOnlyList<Boolean> isPresent, String requestId, String loaderId, String documentURL, Network.Request request, Number timestamp, Number wallTime, Network.Initiator initiator, boolean redirectHasExtraInfo, Network.Response redirectResponse, String type, String frameId, Boolean hasUserGesture)	Constructor.

Method Summary

Static Builder Convert a JsonObject to a POJO
Modifier and Type	Method	Description
static Network.requestWillBeSent	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<Network.requestWillBeSent>	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

requestId

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String requestId

Request identifier.

loaderId

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String loaderId

Loader identifier. Empty string if the request is fetched from worker.

documentURL

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String documentURL

URL of the document this request is loaded for.

request

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final Network.Request request

Request data.

timestamp

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Number timestamp

Timestamp.

wallTime

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Number wallTime

Timestamp.

initiator

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final Network.Initiator initiator

Request initiator.

redirectHasExtraInfo

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final boolean redirectHasExtraInfo

In the case that redirectResponse is populated, this flag indicates whether requestWillBeSentExtraInfo and responseReceivedExtraInfo events will be or were emitted for the request which was just redirected.
EXPERIMENTAL

redirectResponse

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final Network.Response redirectResponse

Redirect response data.
OPTIONAL

type

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String type

Type of this resource.
OPTIONAL

This particular field will have its values resricted to the contents of a CDP defined Enumerated String List. That list may be viewed here:

📎 Network.ResourceType

Programmatically Accessing the Enum:

// Retrieve the list of enumerated strings for this field
ReadOnlyList<String> enumerationStrs = Network.ResourceType.enumStrList("type");

// Print the list of strings to the terminal
for (final String s : enumerationStrs) System.out.println('\"' + s + "\", ");

See Also:

BaseType.enumStrList(String)

frameId

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String frameId

Frame identifier.
OPTIONAL

hasUserGesture

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Boolean hasUserGesture

Whether the request is initiated by a user gesture. Defaults to false.
OPTIONAL

Constructor Detail

requestWillBeSent

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public requestWillBeSent(ReadOnlyList<java.lang.Boolean> isPresent,
                         java.lang.String requestId,
                         java.lang.String loaderId,
                         java.lang.String documentURL,
                         Network.Request request,
                         java.lang.Number timestamp,
                         java.lang.Number wallTime,
                         Network.Initiator initiator,
                         boolean redirectHasExtraInfo,
                         Network.Response redirectResponse,
                         java.lang.String type,
                         java.lang.String frameId,
                         java.lang.Boolean hasUserGesture)

Constructor. Please review this class' fields for documentation.

Method Detail

fromJSON

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Network.requestWillBeSent fromJSON(JsonObject jo)

Creates an instance of this class from a JsonObject.

Code:

Exact Method Body:

 return singleton.fromJSON(jo);

descriptor

🡅 ⇈ ⮫ 🗕 🗗 🗖

public static NestedDescriptor<Network.requestWillBeSent> descriptor()

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

Code:

Exact Method Body:

 return singleton.descriptor();