Package Torello.Browser.BrowserAPI
Class BackgroundService.BackgroundServiceEvent
- java.lang.Object
-
- Torello.Browser.BaseType<BackgroundService.BackgroundServiceEvent>
-
- Torello.Browser.BrowserAPI.BackgroundService.BackgroundServiceEvent
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Comparable<BaseType<?>>
- Enclosing class:
- BackgroundService
public static class BackgroundService.BackgroundServiceEvent extends BaseType<BackgroundService.BackgroundServiceEvent> 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 theBackgroundServicedomain, which may be found within theBrowserAPI.
📌 All browser domain type classes will have a class name that begins with an upper case letter.[No Description Provided by Google]- See Also:
- Serialized Form
Hi-Lited Source-Code:This File's Source Code:
- View Here: Torello/Browser/BrowserAPI/BackgroundService.java
- Open New Browser-Tab: Torello/Browser/BrowserAPI/BackgroundService.java
File Size: 3,310 Bytes Line Count: 76 '\n' Characters Found
Helper: Equals, HashCode, toJSON, etc
- View Here: BackgroundService$$BackgroundServiceEvent$$.java
- Open New Browser-Tab: BackgroundService$$BackgroundServiceEvent$$.java
File Size: 12,959 Bytes Line Count: 296 '\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 BackgroundService.EventMetadata[]eventMetadataA list of event-specific information.StringeventNameA description of the event.StringinstanceIdAn identifier that groups related events together.StringoriginThe origin this event belongs to.StringserviceThe Background Service this event belongs to.StringserviceWorkerRegistrationIdThe Service Worker ID that initiated the event.StringstorageKeyStorage key this event belongs to.NumbertimestampTimestamp of the event (in seconds).
-
Constructor Summary
Constructors Constructor Description BackgroundServiceEvent(ReadOnlyList<Boolean> isPresent, Number timestamp, String origin, String serviceWorkerRegistrationId, String service, String eventName, String instanceId, BackgroundService.EventMetadata[] eventMetadata, String storageKey)Constructor.
-
Method Summary
Static Builder Convert a JsonObject to a POJO Modifier and Type Method Description static BackgroundService.BackgroundServiceEventfromJSON(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<BackgroundService.BackgroundServiceEvent>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
-
timestamp
public final java.lang.Number timestamp
Timestamp of the event (in seconds).
-
origin
public final java.lang.String origin
The origin this event belongs to.
-
serviceWorkerRegistrationId
public final java.lang.String serviceWorkerRegistrationId
The Service Worker ID that initiated the event.
-
service
public final java.lang.String service
The Background Service this event belongs to.This particular field will have its values resricted to the contents of a CDP defined Enumerated String List. That list may be viewed here:
📎BackgroundService.ServiceName
Programmatically Accessing the Enum:
// Retrieve the list of enumerated strings for this field ReadOnlyList<String> enumerationStrs = BackgroundService.ServiceName.enumStrList("service"); // Print the list of strings to the terminal for (final String s : enumerationStrs) System.out.println('\"' + s + "\", ");
- See Also:
BaseType.enumStrList(String)
-
eventName
public final java.lang.String eventName
A description of the event.
-
instanceId
public final java.lang.String instanceId
An identifier that groups related events together.
-
eventMetadata
public final BackgroundService.EventMetadata[] eventMetadata
A list of event-specific information.
-
storageKey
public final java.lang.String storageKey
Storage key this event belongs to.
-
-
Constructor Detail
-
BackgroundServiceEvent
public BackgroundServiceEvent (ReadOnlyList<java.lang.Boolean> isPresent, java.lang.Number timestamp, java.lang.String origin, java.lang.String serviceWorkerRegistrationId, java.lang.String service, java.lang.String eventName, java.lang.String instanceId, BackgroundService.EventMetadata[] eventMetadata, java.lang.String storageKey)
Constructor. Please review this class' fields for documentation.
-
-
Method Detail
-
fromJSON
public static BackgroundService.BackgroundServiceEvent fromJSON (JsonObject jo)
Creates an instance of this class from aJsonObject.- Code:
- Exact Method Body:
return singleton.fromJSON(jo);
-
descriptor
public static NestedDescriptor<BackgroundService.BackgroundServiceEvent> descriptor ()
Returns this class'sNestedDescriptorsingleton-instance. class / type.- Code:
- Exact Method Body:
return singleton.descriptor();
-
-