puppeteer/new-docs/puppeteer.protocol.backgroundservice.md
2020-07-13 14:01:35 +01:00

34 lines
1.8 KiB
Markdown

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [BackgroundService](./puppeteer.protocol.backgroundservice.md)
## Protocol.BackgroundService namespace
Defines events for background web platform features.
<b>Signature:</b>
```typescript
export namespace BackgroundService
```
## Interfaces
| Interface | Description |
| --- | --- |
| [BackgroundServiceEvent](./puppeteer.protocol.backgroundservice.backgroundserviceevent.md) | |
| [BackgroundServiceEventReceivedEvent](./puppeteer.protocol.backgroundservice.backgroundserviceeventreceivedevent.md) | Called with all existing backgroundServiceEvents when enabled, and all new events afterwards if enabled and recording. |
| [ClearEventsRequest](./puppeteer.protocol.backgroundservice.cleareventsrequest.md) | |
| [EventMetadata](./puppeteer.protocol.backgroundservice.eventmetadata.md) | A key-value pair for additional event information to pass along. |
| [RecordingStateChangedEvent](./puppeteer.protocol.backgroundservice.recordingstatechangedevent.md) | Called when the recording state for the service has been updated. |
| [SetRecordingRequest](./puppeteer.protocol.backgroundservice.setrecordingrequest.md) | |
| [StartObservingRequest](./puppeteer.protocol.backgroundservice.startobservingrequest.md) | |
| [StopObservingRequest](./puppeteer.protocol.backgroundservice.stopobservingrequest.md) | |
## Type Aliases
| Type Alias | Description |
| --- | --- |
| [ServiceName](./puppeteer.protocol.backgroundservice.servicename.md) | The Background Service that will be associated with the commands/events. Every Background Service operates independently, but they share the same API. |