Package Torello.Browser.BrowserAPI
Class Network.CookieParam
- java.lang.Object
-
- Torello.Browser.BaseType<Network.CookieParam>
-
- Torello.Browser.BrowserAPI.Network.CookieParam
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Comparable<BaseType<?>>
- Enclosing class:
- Network
public static class Network.CookieParam extends BaseType<Network.CookieParam> implements java.io.Serializable
This Nested Java Class is declared as a "Type", which is similar to a Java Class. The CDP API Specifications list this type among the types, events & commands located in theNetworkdomain, which may be found within theBrowserAPI.
📌 All browser domain type classes will have a class name that begins with an upper case letter.Cookie parameter object- 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: 5,348 Bytes Line Count: 142 '\n' Characters Found
Helper: Equals, HashCode, toJSON, etc
- View Here: Network$$CookieParam$$.java
- Open New Browser-Tab: Network$$CookieParam$$.java
File Size: 15,210 Bytes Line Count: 366 '\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 StringdomainCookie domain.NumberexpiresCookie expiration date, session cookie if not setBooleanhttpOnlyTrue if cookie is http-only.StringnameCookie name.Network.CookiePartitionKeypartitionKeyCookie partition key.StringpathCookie path.StringpriorityCookie Priority.BooleansamePartyTrue if cookie is SameParty.StringsameSiteCookie SameSite type.BooleansecureTrue if cookie is secure.IntegersourcePortCookie source port.StringsourceSchemeCookie source scheme type.StringurlThe request-URI to associate with the setting of the cookie.StringvalueCookie value.-
Fields inherited from class Torello.Browser.BaseType
helperSingleton, isPresent, numFields
-
-
Constructor Summary
Constructors Constructor Description CookieParam(ReadOnlyList<Boolean> isPresent, String name, String value, String url, String domain, String path, Boolean secure, Boolean httpOnly, String sameSite, Number expires, String priority, Boolean sameParty, String sourceScheme, Integer sourcePort, Network.CookiePartitionKey partitionKey)Constructor.
-
Method Summary
Static Builder Convert a JsonObject to a POJO Modifier and Type Method Description static Network.CookieParamfromJSON(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<Network.CookieParam>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
-
name
public final java.lang.String name
Cookie name.
-
value
public final java.lang.String value
Cookie value.
-
url
public final java.lang.String url
The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie.
OPTIONAL
-
domain
public final java.lang.String domain
Cookie domain.
OPTIONAL
-
path
public final java.lang.String path
Cookie path.
OPTIONAL
-
secure
public final java.lang.Boolean secure
True if cookie is secure.
OPTIONAL
-
httpOnly
public final java.lang.Boolean httpOnly
True if cookie is http-only.
OPTIONAL
-
sameSite
public final java.lang.String sameSite
Cookie SameSite type.
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.CookieSameSite
Programmatically Accessing the Enum:
// Retrieve the list of enumerated strings for this field ReadOnlyList<String> enumerationStrs = Network.CookieSameSite.enumStrList("sameSite"); // Print the list of strings to the terminal for (final String s : enumerationStrs) System.out.println('\"' + s + "\", ");
- See Also:
BaseType.enumStrList(String)
-
expires
public final java.lang.Number expires
Cookie expiration date, session cookie if not set
OPTIONAL
-
priority
public final java.lang.String priority
Cookie Priority.
OPTIONALEXPERIMENTALThis particular field will have its values resricted to the contents of a CDP defined Enumerated String List. That list may be viewed here:
📎Network.CookiePriority
Programmatically Accessing the Enum:
// Retrieve the list of enumerated strings for this field ReadOnlyList<String> enumerationStrs = Network.CookiePriority.enumStrList("priority"); // Print the list of strings to the terminal for (final String s : enumerationStrs) System.out.println('\"' + s + "\", ");
- See Also:
BaseType.enumStrList(String)
-
sameParty
public final java.lang.Boolean sameParty
True if cookie is SameParty.
OPTIONALEXPERIMENTAL
-
sourceScheme
public final java.lang.String sourceScheme
Cookie source scheme type.
OPTIONALEXPERIMENTALThis particular field will have its values resricted to the contents of a CDP defined Enumerated String List. That list may be viewed here:
📎Network.CookieSourceScheme
Programmatically Accessing the Enum:
// Retrieve the list of enumerated strings for this field ReadOnlyList<String> enumerationStrs = Network.CookieSourceScheme.enumStrList("sourceScheme"); // Print the list of strings to the terminal for (final String s : enumerationStrs) System.out.println('\"' + s + "\", ");
- See Also:
BaseType.enumStrList(String)
-
sourcePort
public final java.lang.Integer sourcePort
Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port. An unspecified port value allows protocol clients to emulate legacy cookie scope for the port. This is a temporary ability and it will be removed in the future.
OPTIONALEXPERIMENTAL
-
partitionKey
public final Network.CookiePartitionKey partitionKey
Cookie partition key. If not set, the cookie will be set as not partitioned.
OPTIONALEXPERIMENTAL
-
-
Constructor Detail
-
CookieParam
public CookieParam(ReadOnlyList<java.lang.Boolean> isPresent, java.lang.String name, java.lang.String value, java.lang.String url, java.lang.String domain, java.lang.String path, java.lang.Boolean secure, java.lang.Boolean httpOnly, java.lang.String sameSite, java.lang.Number expires, java.lang.String priority, java.lang.Boolean sameParty, java.lang.String sourceScheme, java.lang.Integer sourcePort, Network.CookiePartitionKey partitionKey)
Constructor. Please review this class' fields for documentation.
-
-
Method Detail
-
fromJSON
public static Network.CookieParam fromJSON(JsonObject jo)
Creates an instance of this class from aJsonObject.- Code:
- Exact Method Body:
return singleton.fromJSON(jo);
-
descriptor
public static NestedDescriptor<Network.CookieParam> descriptor()
Returns this class'sNestedDescriptorsingleton-instance. class / type.- Code:
- Exact Method Body:
return singleton.descriptor();
-
-