package backgroundservice

Import Path
	github.com/chromedp/cdproto/backgroundservice (on go.dev)

Dependency Relation
	imports 8 packages, and imported by one package

Involved Source Files

	  d backgroundservice.go
		Package backgroundservice provides the Chrome DevTools Protocol
		commands, types, and events for the BackgroundService domain.
		
		Defines events for background web platform features.
		
		Generated by the cdproto-gen command.

	    easyjson.go
	    events.go
	    types.go
Package-Level Type Names (total 9)

	/* sort by: alphabet | popularity */
	 type ClearEventsParams (struct)
		ClearEventsParams clears all stored data for the service.

		Fields (only one)
			Service ServiceName
		Methods (total 5)
			(*ClearEventsParams) Do(ctx context.Context) (err error)
				Do executes BackgroundService.clearEvents against the provided context.

			( ClearEventsParams) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( ClearEventsParams) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*ClearEventsParams) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*ClearEventsParams) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 16)
			*ClearEventsParams : github.com/chromedp/chromedp.Action
			*ClearEventsParams : github.com/chromedp/chromedp.CallAction
			*ClearEventsParams : github.com/chromedp/chromedp.EmulateAction
			*ClearEventsParams : github.com/chromedp/chromedp.EvaluateAction
			*ClearEventsParams : github.com/chromedp/chromedp.KeyAction
			*ClearEventsParams : github.com/chromedp/chromedp.MouseAction
			*ClearEventsParams : github.com/chromedp/chromedp.NavigateAction
			*ClearEventsParams : github.com/chromedp/chromedp.PollAction
			*ClearEventsParams : github.com/chromedp/chromedp.QueryAction
			 ClearEventsParams : github.com/goccy/go-json.Marshaler
			*ClearEventsParams : github.com/goccy/go-json.Unmarshaler
			 ClearEventsParams : github.com/mailru/easyjson.Marshaler
			*ClearEventsParams : github.com/mailru/easyjson.MarshalerUnmarshaler
			*ClearEventsParams : github.com/mailru/easyjson.Unmarshaler
			 ClearEventsParams : encoding/json.Marshaler
			*ClearEventsParams : encoding/json.Unmarshaler
		As Outputs Of (at least one exported)
			func ClearEvents(service ServiceName) *ClearEventsParams

	 type Event (struct)
		Event [no description].
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/BackgroundService#type-BackgroundServiceEvent

		Fields (total 8)
			EventMetadata []*EventMetadata
				// A list of event-specific information.

			EventName string
				// A description of the event.

			InstanceID string
				// An identifier that groups related events together.

			Origin string
				// The origin this event belongs to.

			Service ServiceName
				// The Background Service this event belongs to.

			ServiceWorkerRegistrationID serviceworker.RegistrationID
				// The Service Worker ID that initiated the event.

			StorageKey string
				// Storage key this event belongs to.

			Timestamp *cdp.TimeSinceEpoch
				// Timestamp of the event (in seconds).

		Methods (total 4)
			( Event) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( Event) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*Event) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*Event) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 7)
			 Event : github.com/goccy/go-json.Marshaler
			*Event : github.com/goccy/go-json.Unmarshaler
			 Event : github.com/mailru/easyjson.Marshaler
			*Event : github.com/mailru/easyjson.MarshalerUnmarshaler
			*Event : github.com/mailru/easyjson.Unmarshaler
			 Event : encoding/json.Marshaler
			*Event : encoding/json.Unmarshaler

	 type EventBackgroundServiceEventReceived (struct)
		EventBackgroundServiceEventReceived called with all existing
		backgroundServiceEvents when enabled, and all new events afterwards if
		enabled and recording.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/BackgroundService#event-backgroundServiceEventReceived

		Fields (only one)
			BackgroundServiceEvent *Event
		Methods (total 4)
			( EventBackgroundServiceEventReceived) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( EventBackgroundServiceEventReceived) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*EventBackgroundServiceEventReceived) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*EventBackgroundServiceEventReceived) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 7)
			 EventBackgroundServiceEventReceived : github.com/goccy/go-json.Marshaler
			*EventBackgroundServiceEventReceived : github.com/goccy/go-json.Unmarshaler
			 EventBackgroundServiceEventReceived : github.com/mailru/easyjson.Marshaler
			*EventBackgroundServiceEventReceived : github.com/mailru/easyjson.MarshalerUnmarshaler
			*EventBackgroundServiceEventReceived : github.com/mailru/easyjson.Unmarshaler
			 EventBackgroundServiceEventReceived : encoding/json.Marshaler
			*EventBackgroundServiceEventReceived : encoding/json.Unmarshaler

	 type EventMetadata (struct)
		EventMetadata a key-value pair for additional event information to pass
		along.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/BackgroundService#type-EventMetadata

		Fields (total 2)
			Key string
			Value string
		Methods (total 4)
			( EventMetadata) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( EventMetadata) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*EventMetadata) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*EventMetadata) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 7)
			 EventMetadata : github.com/goccy/go-json.Marshaler
			*EventMetadata : github.com/goccy/go-json.Unmarshaler
			 EventMetadata : github.com/mailru/easyjson.Marshaler
			*EventMetadata : github.com/mailru/easyjson.MarshalerUnmarshaler
			*EventMetadata : github.com/mailru/easyjson.Unmarshaler
			 EventMetadata : encoding/json.Marshaler
			*EventMetadata : encoding/json.Unmarshaler

	 type EventRecordingStateChanged (struct)
		EventRecordingStateChanged called when the recording state for the service
		has been updated.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/BackgroundService#event-recordingStateChanged

		Fields (total 2)
			IsRecording bool
			Service ServiceName
		Methods (total 4)
			( EventRecordingStateChanged) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( EventRecordingStateChanged) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*EventRecordingStateChanged) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*EventRecordingStateChanged) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 7)
			 EventRecordingStateChanged : github.com/goccy/go-json.Marshaler
			*EventRecordingStateChanged : github.com/goccy/go-json.Unmarshaler
			 EventRecordingStateChanged : github.com/mailru/easyjson.Marshaler
			*EventRecordingStateChanged : github.com/mailru/easyjson.MarshalerUnmarshaler
			*EventRecordingStateChanged : github.com/mailru/easyjson.Unmarshaler
			 EventRecordingStateChanged : encoding/json.Marshaler
			*EventRecordingStateChanged : encoding/json.Unmarshaler

	 type ServiceName string (basic type)
		ServiceName the Background Service that will be associated with the
		commands/events. Every Background Service operates independently, but they
		share the same API.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/BackgroundService#type-ServiceName

		Methods (total 5)
			( ServiceName) MarshalEasyJSON(out *jwriter.Writer)
				MarshalEasyJSON satisfies easyjson.Marshaler.

			( ServiceName) MarshalJSON() ([]byte, error)
				MarshalJSON satisfies json.Marshaler.

			( ServiceName) String() string
				String returns the ServiceName as string value.

			(*ServiceName) UnmarshalEasyJSON(in *jlexer.Lexer)
				UnmarshalEasyJSON satisfies easyjson.Unmarshaler.

			(*ServiceName) UnmarshalJSON(buf []byte) error
				UnmarshalJSON satisfies json.Unmarshaler.

		Implements (at least 9)
			 ServiceName : github.com/goccy/go-json.Marshaler
			*ServiceName : github.com/goccy/go-json.Unmarshaler
			 ServiceName : github.com/mailru/easyjson.Marshaler
			*ServiceName : github.com/mailru/easyjson.MarshalerUnmarshaler
			*ServiceName : github.com/mailru/easyjson.Unmarshaler
			 ServiceName : encoding/json.Marshaler
			*ServiceName : encoding/json.Unmarshaler
			 ServiceName : expvar.Var
			 ServiceName : fmt.Stringer
		As Inputs Of (at least 4)
			func ClearEvents(service ServiceName) *ClearEventsParams
			func SetRecording(shouldRecord bool, service ServiceName) *SetRecordingParams
			func StartObserving(service ServiceName) *StartObservingParams
			func StopObserving(service ServiceName) *StopObservingParams
		As Types Of (total 6)
			const ServiceNameBackgroundFetch
			const ServiceNameBackgroundSync
			const ServiceNameNotifications
			const ServiceNamePaymentHandler
			const ServiceNamePeriodicBackgroundSync
			const ServiceNamePushMessaging

	 type SetRecordingParams (struct)
		SetRecordingParams set the recording state for the service.

		Fields (total 2)
			Service ServiceName
			ShouldRecord bool
		Methods (total 5)
			(*SetRecordingParams) Do(ctx context.Context) (err error)
				Do executes BackgroundService.setRecording against the provided context.

			( SetRecordingParams) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( SetRecordingParams) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*SetRecordingParams) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*SetRecordingParams) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 16)
			*SetRecordingParams : github.com/chromedp/chromedp.Action
			*SetRecordingParams : github.com/chromedp/chromedp.CallAction
			*SetRecordingParams : github.com/chromedp/chromedp.EmulateAction
			*SetRecordingParams : github.com/chromedp/chromedp.EvaluateAction
			*SetRecordingParams : github.com/chromedp/chromedp.KeyAction
			*SetRecordingParams : github.com/chromedp/chromedp.MouseAction
			*SetRecordingParams : github.com/chromedp/chromedp.NavigateAction
			*SetRecordingParams : github.com/chromedp/chromedp.PollAction
			*SetRecordingParams : github.com/chromedp/chromedp.QueryAction
			 SetRecordingParams : github.com/goccy/go-json.Marshaler
			*SetRecordingParams : github.com/goccy/go-json.Unmarshaler
			 SetRecordingParams : github.com/mailru/easyjson.Marshaler
			*SetRecordingParams : github.com/mailru/easyjson.MarshalerUnmarshaler
			*SetRecordingParams : github.com/mailru/easyjson.Unmarshaler
			 SetRecordingParams : encoding/json.Marshaler
			*SetRecordingParams : encoding/json.Unmarshaler
		As Outputs Of (at least one exported)
			func SetRecording(shouldRecord bool, service ServiceName) *SetRecordingParams

	 type StartObservingParams (struct)
		StartObservingParams enables event updates for the service.

		Fields (only one)
			Service ServiceName
		Methods (total 5)
			(*StartObservingParams) Do(ctx context.Context) (err error)
				Do executes BackgroundService.startObserving against the provided context.

			( StartObservingParams) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( StartObservingParams) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*StartObservingParams) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*StartObservingParams) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 16)
			*StartObservingParams : github.com/chromedp/chromedp.Action
			*StartObservingParams : github.com/chromedp/chromedp.CallAction
			*StartObservingParams : github.com/chromedp/chromedp.EmulateAction
			*StartObservingParams : github.com/chromedp/chromedp.EvaluateAction
			*StartObservingParams : github.com/chromedp/chromedp.KeyAction
			*StartObservingParams : github.com/chromedp/chromedp.MouseAction
			*StartObservingParams : github.com/chromedp/chromedp.NavigateAction
			*StartObservingParams : github.com/chromedp/chromedp.PollAction
			*StartObservingParams : github.com/chromedp/chromedp.QueryAction
			 StartObservingParams : github.com/goccy/go-json.Marshaler
			*StartObservingParams : github.com/goccy/go-json.Unmarshaler
			 StartObservingParams : github.com/mailru/easyjson.Marshaler
			*StartObservingParams : github.com/mailru/easyjson.MarshalerUnmarshaler
			*StartObservingParams : github.com/mailru/easyjson.Unmarshaler
			 StartObservingParams : encoding/json.Marshaler
			*StartObservingParams : encoding/json.Unmarshaler
		As Outputs Of (at least one exported)
			func StartObserving(service ServiceName) *StartObservingParams

	 type StopObservingParams (struct)
		StopObservingParams disables event updates for the service.

		Fields (only one)
			Service ServiceName
		Methods (total 5)
			(*StopObservingParams) Do(ctx context.Context) (err error)
				Do executes BackgroundService.stopObserving against the provided context.

			( StopObservingParams) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( StopObservingParams) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*StopObservingParams) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*StopObservingParams) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 16)
			*StopObservingParams : github.com/chromedp/chromedp.Action
			*StopObservingParams : github.com/chromedp/chromedp.CallAction
			*StopObservingParams : github.com/chromedp/chromedp.EmulateAction
			*StopObservingParams : github.com/chromedp/chromedp.EvaluateAction
			*StopObservingParams : github.com/chromedp/chromedp.KeyAction
			*StopObservingParams : github.com/chromedp/chromedp.MouseAction
			*StopObservingParams : github.com/chromedp/chromedp.NavigateAction
			*StopObservingParams : github.com/chromedp/chromedp.PollAction
			*StopObservingParams : github.com/chromedp/chromedp.QueryAction
			 StopObservingParams : github.com/goccy/go-json.Marshaler
			*StopObservingParams : github.com/goccy/go-json.Unmarshaler
			 StopObservingParams : github.com/mailru/easyjson.Marshaler
			*StopObservingParams : github.com/mailru/easyjson.MarshalerUnmarshaler
			*StopObservingParams : github.com/mailru/easyjson.Unmarshaler
			 StopObservingParams : encoding/json.Marshaler
			*StopObservingParams : encoding/json.Unmarshaler
		As Outputs Of (at least one exported)
			func StopObserving(service ServiceName) *StopObservingParams


Package-Level Functions (total 4)

	 func ClearEvents(service ServiceName) *ClearEventsParams
		ClearEvents clears all stored data for the service.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/BackgroundService#method-clearEvents
		
		parameters:
		
			service

	 func SetRecording(shouldRecord bool, service ServiceName) *SetRecordingParams
		SetRecording set the recording state for the service.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/BackgroundService#method-setRecording
		
		parameters:
		
			shouldRecord
			service

	 func StartObserving(service ServiceName) *StartObservingParams
		StartObserving enables event updates for the service.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/BackgroundService#method-startObserving
		
		parameters:
		
			service

	 func StopObserving(service ServiceName) *StopObservingParams
		StopObserving disables event updates for the service.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/BackgroundService#method-stopObserving
		
		parameters:
		
			service


Package-Level Constants (total 10)

	const CommandClearEvents = "BackgroundService.clearEvents"
		Command names.

	const CommandSetRecording = "BackgroundService.setRecording"
		Command names.

	const CommandStartObserving = "BackgroundService.startObserving"
		Command names.

	const CommandStopObserving = "BackgroundService.stopObserving"
		Command names.

	const ServiceNameBackgroundFetch ServiceName = "backgroundFetch"
		ServiceName values.

	const ServiceNameBackgroundSync ServiceName = "backgroundSync"
		ServiceName values.

	const ServiceNameNotifications ServiceName = "notifications"
		ServiceName values.

	const ServiceNamePaymentHandler ServiceName = "paymentHandler"
		ServiceName values.

	const ServiceNamePeriodicBackgroundSync ServiceName = "periodicBackgroundSync"
		ServiceName values.

	const ServiceNamePushMessaging ServiceName = "pushMessaging"
		ServiceName values.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.