chrome-devtools-kotlin/org.hildan.chrome.devtools.domains.backgroundservice

Package-level declarations

Types

Defines events for background web platform features.

@Serializable

data class BackgroundServiceEvent(val timestamp: TimeSinceEpoch, val origin: String, val serviceWorkerRegistrationId: RegistrationID, val service: ServiceName, val eventName: String, val instanceId: String, val eventMetadata: List<EventMetadata>, val storageKey: String)

(undocumented in the protocol definition)

ClearEventsRequest

@Serializable

data class ClearEventsRequest(val service: ServiceName)

Request object containing input parameters for the BackgroundServiceDomain.clearEvents command.

ClearEventsResponse

@Serializable

object ClearEventsResponse

A dummy response object for the BackgroundServiceDomain.clearEvents command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

EventMetadata

@Serializable

data class EventMetadata(val key: String, val value: String)

A key-value pair for additional event information to pass along.

ServiceName

@Serializable

enum ServiceName : Enum<ServiceName>

The Background Service that will be associated with the commands/events. Every Background Service operates independently, but they share the same API.

SetRecordingRequest

@Serializable

data class SetRecordingRequest(val shouldRecord: Boolean, val service: ServiceName)

Request object containing input parameters for the BackgroundServiceDomain.setRecording command.

SetRecordingResponse

@Serializable

object SetRecordingResponse

A dummy response object for the BackgroundServiceDomain.setRecording command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

StartObservingRequest

@Serializable

data class StartObservingRequest(val service: ServiceName)

Request object containing input parameters for the BackgroundServiceDomain.startObserving command.

StartObservingResponse

@Serializable

object StartObservingResponse

A dummy response object for the BackgroundServiceDomain.startObserving command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

StopObservingRequest

@Serializable

data class StopObservingRequest(val service: ServiceName)

Request object containing input parameters for the BackgroundServiceDomain.stopObserving command.

StopObservingResponse

@Serializable

object StopObservingResponse

A dummy response object for the BackgroundServiceDomain.stopObserving command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.