Package Torello.Browser.BrowserAPI
Class Page.Frame
- java.lang.Object
-
- Torello.Browser.BaseType<Page.Frame>
-
- Torello.Browser.BrowserAPI.Page.Frame
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Comparable<BaseType<?>>
- Enclosing class:
- Page
public static class Page.Frame extends BaseType<Page.Frame> 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 thePagedomain, which may be found within theBrowserAPI.
📌 All browser domain type classes will have a class name that begins with an upper case letter.Information about the Frame on the page.- 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: 6,091 Bytes Line Count: 142 '\n' Characters Found
Helper: Equals, HashCode, toJSON, etc
- View Here: Page$$Frame$$.java
- Open New Browser-Tab: Page$$Frame$$.java
File Size: 17,162 Bytes Line Count: 394 '\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 Page.AdFrameStatusadFrameStatusIndicates whether this frame was tagged as an ad and why.StringcrossOriginIsolatedContextTypeIndicates whether this is a cross origin isolated context.StringdomainAndRegistryFrame document's registered domain, taking the public suffixes list into account.String[]gatedAPIFeaturesIndicated which gated APIs / features are available.StringidFrame unique identifier.StringloaderIdIdentifier of the loader associated with this frame.StringmimeTypeFrame document's mimeType as determined by the browser.StringnameFrame's name as specified in the tag.StringparentIdParent frame identifier.StringsecureContextTypeIndicates whether the main document is a secure context and explains why that is the case.StringsecurityOriginFrame document's security origin.Page.SecurityOriginDetailssecurityOriginDetailsAdditional details about the frame document's security origin.StringunreachableUrlIf the frame failed to load, this contains the URL that could not be loaded.StringurlFrame document's URL without fragment.StringurlFragmentFrame document's URL fragment including the '#'.-
Fields inherited from class Torello.Browser.BaseType
domain, helperSingleton, isPresent, numFields
-
-
Constructor Summary
Constructors Constructor Description Frame(ReadOnlyList<Boolean> isPresent, String id, String parentId, String loaderId, String name, String url, String urlFragment, String domainAndRegistry, String securityOrigin, Page.SecurityOriginDetails securityOriginDetails, String mimeType, String unreachableUrl, Page.AdFrameStatus adFrameStatus, String secureContextType, String crossOriginIsolatedContextType, String[] gatedAPIFeatures)Constructor.
-
Method Summary
Static Builder Convert a JsonObject to a POJO Modifier and Type Method Description static Page.FramefromJSON(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<Page.Frame>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
-
id
public final java.lang.String id
Frame unique identifier.
-
parentId
public final java.lang.String parentId
Parent frame identifier.
OPTIONAL
-
loaderId
public final java.lang.String loaderId
Identifier of the loader associated with this frame.
-
name
public final java.lang.String name
Frame's name as specified in the tag.
OPTIONAL
-
url
public final java.lang.String url
Frame document's URL without fragment.
-
urlFragment
public final java.lang.String urlFragment
Frame document's URL fragment including the '#'.
OPTIONALEXPERIMENTAL
-
domainAndRegistry
public final java.lang.String domainAndRegistry
Frame document's registered domain, taking the public suffixes list into account. Extracted from the Frame's url. Example URLs: http://www.google.com/file.html -> "google.com" http://a.b.co.uk/file.html -> "b.co.uk"
EXPERIMENTAL
-
securityOrigin
public final java.lang.String securityOrigin
Frame document's security origin.
-
securityOriginDetails
public final Page.SecurityOriginDetails securityOriginDetails
Additional details about the frame document's security origin.
OPTIONALEXPERIMENTAL
-
mimeType
public final java.lang.String mimeType
Frame document's mimeType as determined by the browser.
-
unreachableUrl
public final java.lang.String unreachableUrl
If the frame failed to load, this contains the URL that could not be loaded. Note that unlike url above, this URL may contain a fragment.
OPTIONALEXPERIMENTAL
-
adFrameStatus
public final Page.AdFrameStatus adFrameStatus
Indicates whether this frame was tagged as an ad and why.
OPTIONALEXPERIMENTAL
-
secureContextType
public final java.lang.String secureContextType
Indicates whether the main document is a secure context and explains why that is the case.
EXPERIMENTALThis particular field will have its values resricted to the contents of a CDP defined Enumerated String List. That list may be viewed here:
📎Page.SecureContextType
Programmatically Accessing the Enum:
// Retrieve the list of enumerated strings for this field ReadOnlyList<String> enumerationStrs = Page.SecureContextType.enumStrList("secureContextType"); // Print the list of strings to the terminal for (final String s : enumerationStrs) System.out.println('\"' + s + "\", ");
- See Also:
BaseType.enumStrList(String)
-
crossOriginIsolatedContextType
public final java.lang.String crossOriginIsolatedContextType
Indicates whether this is a cross origin isolated context.
EXPERIMENTALThis particular field will have its values resricted to the contents of a CDP defined Enumerated String List. That list may be viewed here:
📎Page.CrossOriginIsolatedContextType
Programmatically Accessing the Enum:
// Retrieve the list of enumerated strings for this field ReadOnlyList<String> enumerationStrs = Page.CrossOriginIsolatedContextType.enumStrList("crossOriginIsolatedContextType"); // Print the list of strings to the terminal for (final String s : enumerationStrs) System.out.println('\"' + s + "\", ");
- See Also:
BaseType.enumStrList(String)
-
gatedAPIFeatures
public final java.lang.String[] gatedAPIFeatures
Indicated which gated APIs / features are available.
EXPERIMENTALThis particular field will have its values resricted to the contents of a CDP defined Enumerated String List. That list may be viewed here:
📎Page.GatedAPIFeatures
Programmatically Accessing the Enum:
// Retrieve the list of enumerated strings for this field ReadOnlyList<String> enumerationStrs = Page.GatedAPIFeatures.enumStrList("gatedAPIFeatures"); // Print the list of strings to the terminal for (final String s : enumerationStrs) System.out.println('\"' + s + "\", ");
- See Also:
BaseType.enumStrList(String)
-
-
Constructor Detail
-
Frame
public Frame(ReadOnlyList<java.lang.Boolean> isPresent, java.lang.String id, java.lang.String parentId, java.lang.String loaderId, java.lang.String name, java.lang.String url, java.lang.String urlFragment, java.lang.String domainAndRegistry, java.lang.String securityOrigin, Page.SecurityOriginDetails securityOriginDetails, java.lang.String mimeType, java.lang.String unreachableUrl, Page.AdFrameStatus adFrameStatus, java.lang.String secureContextType, java.lang.String crossOriginIsolatedContextType, java.lang.String[] gatedAPIFeatures)
Constructor. Please review this class' fields for documentation.
-
-
Method Detail
-
fromJSON
public static Page.Frame fromJSON(JsonObject jo)
Creates an instance of this class from aJsonObject.- Code:
- Exact Method Body:
return singleton.fromJSON(jo);
-
descriptor
public static NestedDescriptor<Page.Frame> descriptor()
Returns this class'sNestedDescriptorsingleton-instance. class / type.- Code:
- Exact Method Body:
return singleton.descriptor();
-
-