Package Torello.Browser.BrowserAPI
Class Fetch.requestPaused
- java.lang.Object
-
- Torello.Browser.BaseType<DOMAIN_NESTED>
-
- Torello.Browser.BrowserEvent<Fetch.requestPaused>
-
- Torello.Browser.BrowserAPI.Fetch.requestPaused
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Comparable<BaseType<?>>
- Enclosing class:
- Fetch
public static class Fetch.requestPaused extends BrowserEvent<Fetch.requestPaused> 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 theFetchdomain, located in theBrowserAPI. A browser 'domain' is quite similar to a Java Package. It incorporates a suite of features, types and functions under one umbrella.Issued when the domain is enabled and the request URL matches the specified filter. The request is paused until the client responds with one of continueRequest, failRequest or fulfillRequest. The stage of the request can be determined by presence of responseErrorReason and responseStatusCode -- the request is at the response stage if either of these fields is present and in the request stage otherwise. Redirect responses and subsequent requests are reported similarly to regular responses and requests. Redirect responses may be distinguished by the value ofresponseStatusCode(which is one of 301, 302, 303, 307, 308) along with presence of thelocationheader. Requests resulting from a redirect will haveredirectedRequestIdfield set.- See Also:
- Serialized Form
Hi-Lited Source-Code:This File's Source Code:
- View Here: Torello/Browser/BrowserAPI/Fetch.java
- Open New Browser-Tab: Torello/Browser/BrowserAPI/Fetch.java
File Size: 5,241 Bytes Line Count: 117 '\n' Characters Found
Helper: Equals, HashCode, toJSON, etc
- View Here: Fetch$$requestPaused$$.java
- Open New Browser-Tab: Fetch$$requestPaused$$.java
File Size: 14,057 Bytes Line Count: 327 '\n' Characters Found
-
-
Field Summary
Serializable ID Modifier and Type Field Description protected static longserialVersionUIDType Fields / Properties (from Google & Browser Specs) Modifier and Type Field Description StringframeIdThe id of the frame that initiated the request.StringnetworkIdIf the intercepted request had a corresponding Network.requestWillBeSent event fired for it, then this networkId will be the same as the requestId present in the requestWillBeSent event.StringredirectedRequestIdIf the request is due to a redirect response from the server, the id of the request that has caused the redirect.Network.RequestrequestThe details of the request.StringrequestIdEach request the page makes will have a unique id.StringresourceTypeHow the requested resource will be used.StringresponseErrorReasonResponse error if intercepted at response stage.Fetch.HeaderEntry[]responseHeadersResponse headers if intercepted at the response stage.IntegerresponseStatusCodeResponse code if intercepted at response stage.StringresponseStatusTextResponse status text if intercepted at response stage.
-
Constructor Summary
Constructors Constructor Description requestPaused(ReadOnlyList<Boolean> isPresent, String requestId, Network.Request request, String frameId, String resourceType, String responseErrorReason, Integer responseStatusCode, String responseStatusText, Fetch.HeaderEntry[] responseHeaders, String networkId, String redirectedRequestId)Constructor.
-
Method Summary
Static Builder Convert a JsonObject to a POJO Modifier and Type Method Description static Fetch.requestPausedfromJSON(JsonObject jo)Creates an instance of this class from aJsonObject.Retrieve the Type-Descriptor Singleton-Instance for this Nested Class. Modifier and Type Method Description static NestedDescriptor<Fetch.requestPaused>descriptor()Returns this class'sNestedDescriptorsingleton-instance.-
Methods inherited from class Torello.Browser.BaseType
allEnumStrROLs, compareTo, enumStrList, enumStrValidate, enumStrValidateThrow, equals, hashCode, isPresent, optionalsValidate, optionalsValidateThrow, toJSON, toString
-
-
-
-
Field Detail
-
serialVersionUID
protected static final long serialVersionUID
This fulfils the SerialVersion UID requirement for all classes that implement Java'sinterface java.io.Serializable. Using theSerializableImplementation 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
Each request the page makes will have a unique id.
-
request
public final Network.Request request
The details of the request.
-
frameId
public final java.lang.String frameId
The id of the frame that initiated the request.
-
resourceType
public final java.lang.String resourceType
How the requested resource will be used.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("resourceType"); // Print the list of strings to the terminal for (final String s : enumerationStrs) System.out.println('\"' + s + "\", ");
- See Also:
BaseType.enumStrList(String)
-
responseErrorReason
public final java.lang.String responseErrorReason
Response error if intercepted at response stage.
OPTIONALThis particular field will have its values resricted to the contents of a CDP defined Enumerated String List. That list may be viewed here:
📎Network.ErrorReason
Programmatically Accessing the Enum:
// Retrieve the list of enumerated strings for this field ReadOnlyList<String> enumerationStrs = Network.ErrorReason.enumStrList("responseErrorReason"); // Print the list of strings to the terminal for (final String s : enumerationStrs) System.out.println('\"' + s + "\", ");
- See Also:
BaseType.enumStrList(String)
-
responseStatusCode
public final java.lang.Integer responseStatusCode
Response code if intercepted at response stage.
OPTIONAL
-
responseStatusText
public final java.lang.String responseStatusText
Response status text if intercepted at response stage.
OPTIONAL
-
responseHeaders
public final Fetch.HeaderEntry[] responseHeaders
Response headers if intercepted at the response stage.
OPTIONAL
-
networkId
public final java.lang.String networkId
If the intercepted request had a corresponding Network.requestWillBeSent event fired for it, then this networkId will be the same as the requestId present in the requestWillBeSent event.
OPTIONAL
-
redirectedRequestId
public final java.lang.String redirectedRequestId
If the request is due to a redirect response from the server, the id of the request that has caused the redirect.
OPTIONALEXPERIMENTAL
-
-
Constructor Detail
-
requestPaused
public requestPaused(ReadOnlyList<java.lang.Boolean> isPresent, java.lang.String requestId, Network.Request request, java.lang.String frameId, java.lang.String resourceType, java.lang.String responseErrorReason, java.lang.Integer responseStatusCode, java.lang.String responseStatusText, Fetch.HeaderEntry[] responseHeaders, java.lang.String networkId, java.lang.String redirectedRequestId)
Constructor. Please review this class' fields for documentation.
-
-
Method Detail
-
fromJSON
public static Fetch.requestPaused fromJSON(JsonObject jo)
Creates an instance of this class from aJsonObject.- Code:
- Exact Method Body:
return singleton.fromJSON(jo);
-
descriptor
public static NestedDescriptor<Fetch.requestPaused> descriptor()
Returns this class'sNestedDescriptorsingleton-instance. class / type.- Code:
- Exact Method Body:
return singleton.descriptor();
-
-