Package Torello.Browser.BrowserAPI

Class Fetch.authRequired

java.lang.Object

Torello.Browser.BaseType<DOMAIN_NESTED>

Torello.Browser.BrowserEvent<Fetch.authRequired>

Torello.Browser.BrowserAPI.Fetch.authRequired

All Implemented Interfaces:

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

Enclosing class:

Fetch

public static class Fetch.authRequired
extends BrowserEvent<Fetch.authRequired>
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 Fetch 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.

Issued when the domain is enabled with handleAuthRequests set to true. The request is paused until client responds with continueWithAuth.

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: 2,755 Bytes Line Count: 68 '\n' Characters Found
Helper: Equals, HashCode, toJSON, etc

• View Here: Fetch$$authRequired$$.java
• Open New Browser-Tab: Fetch$$authRequired$$.java

File Size: 9,946 Bytes Line Count: 250 '\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
Fetch.AuthChallenge	authChallenge	Details of the Authorization Challenge encountered.
String	frameId	The id of the frame that initiated the request.
Network.Request	request	The details of the request.
String	requestId	Each request the page makes will have a unique id.
String	resourceType	How the requested resource will be used.

Fields inherited from class Torello.Browser.BaseType

domain, helperSingleton, isPresent, name, numFields

Constructor Summary

Constructors

Constructor	Description
authRequired(ReadOnlyList<Boolean> isPresent, String requestId, Network.Request request, String frameId, String resourceType, Fetch.AuthChallenge authChallenge)	Constructor.

Method Summary

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

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)

authChallenge

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final Fetch.AuthChallenge authChallenge

Details of the Authorization Challenge encountered. If this is set, client should respond with continueRequest that contains AuthChallengeResponse.

Constructor Detail

authRequired

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public authRequired(ReadOnlyList<java.lang.Boolean> isPresent,
                    java.lang.String requestId,
                    Network.Request request,
                    java.lang.String frameId,
                    java.lang.String resourceType,
                    Fetch.AuthChallenge authChallenge)

Constructor. Please review this class' fields for documentation.

Method Detail

fromJSON

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Fetch.authRequired fromJSON(JsonObject jo)

Creates an instance of this class from a JsonObject.

Code:

Exact Method Body:

 return singleton.fromJSON(jo);

descriptor

🡅 ⇈ ⮫ 🗕 🗗 🗖

public static NestedDescriptor<Fetch.authRequired> descriptor()

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

Code:

Exact Method Body:

 return singleton.descriptor();