Skip to content

background_service

BackgroundServiceEvent dataclass

Source code in zendriver/cdp/background_service.py 
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
@dataclass
class BackgroundServiceEvent:
    #: Timestamp of the event (in seconds).
    timestamp: network.TimeSinceEpoch

    #: The origin this event belongs to.
    origin: str

    #: The Service Worker ID that initiated the event.
    service_worker_registration_id: service_worker.RegistrationID

    #: The Background Service this event belongs to.
    service: ServiceName

    #: A description of the event.
    event_name: str

    #: An identifier that groups related events together.
    instance_id: str

    #: A list of event-specific information.
    event_metadata: typing.List[EventMetadata]

    #: Storage key this event belongs to.
    storage_key: str

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["timestamp"] = self.timestamp.to_json()
        json["origin"] = self.origin
        json["serviceWorkerRegistrationId"] = (
            self.service_worker_registration_id.to_json()
        )
        json["service"] = self.service.to_json()
        json["eventName"] = self.event_name
        json["instanceId"] = self.instance_id
        json["eventMetadata"] = [i.to_json() for i in self.event_metadata]
        json["storageKey"] = self.storage_key
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> BackgroundServiceEvent:
        return cls(
            timestamp=network.TimeSinceEpoch.from_json(json["timestamp"]),
            origin=str(json["origin"]),
            service_worker_registration_id=service_worker.RegistrationID.from_json(
                json["serviceWorkerRegistrationId"]
            ),
            service=ServiceName.from_json(json["service"]),
            event_name=str(json["eventName"]),
            instance_id=str(json["instanceId"]),
            event_metadata=[EventMetadata.from_json(i) for i in json["eventMetadata"]],
            storage_key=str(json["storageKey"]),
        )

event_metadata: typing.List[EventMetadata] instance-attribute

event_name: str instance-attribute

instance_id: str instance-attribute

origin: str instance-attribute

service: ServiceName instance-attribute

service_worker_registration_id: service_worker.RegistrationID instance-attribute

storage_key: str instance-attribute

timestamp: network.TimeSinceEpoch instance-attribute

__init__(timestamp, origin, service_worker_registration_id, service, event_name, instance_id, event_metadata, storage_key)

from_json(json) classmethod

Source code in zendriver/cdp/background_service.py 
104
105
106
107
108
109
110
111
112
113
114
115
116
117
@classmethod
def from_json(cls, json: T_JSON_DICT) -> BackgroundServiceEvent:
    return cls(
        timestamp=network.TimeSinceEpoch.from_json(json["timestamp"]),
        origin=str(json["origin"]),
        service_worker_registration_id=service_worker.RegistrationID.from_json(
            json["serviceWorkerRegistrationId"]
        ),
        service=ServiceName.from_json(json["service"]),
        event_name=str(json["eventName"]),
        instance_id=str(json["instanceId"]),
        event_metadata=[EventMetadata.from_json(i) for i in json["eventMetadata"]],
        storage_key=str(json["storageKey"]),
    )

to_json()

Source code in zendriver/cdp/background_service.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["timestamp"] = self.timestamp.to_json()
    json["origin"] = self.origin
    json["serviceWorkerRegistrationId"] = (
        self.service_worker_registration_id.to_json()
    )
    json["service"] = self.service.to_json()
    json["eventName"] = self.event_name
    json["instanceId"] = self.instance_id
    json["eventMetadata"] = [i.to_json() for i in self.event_metadata]
    json["storageKey"] = self.storage_key
    return json

BackgroundServiceEventReceived dataclass

Called with all existing backgroundServiceEvents when enabled, and all new events afterwards if enabled and recording.

Source code in zendriver/cdp/background_service.py 
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
@event_class("BackgroundService.backgroundServiceEventReceived")
@dataclass
class BackgroundServiceEventReceived:
    """
    Called with all existing backgroundServiceEvents when enabled, and all new
    events afterwards if enabled and recording.
    """

    background_service_event: BackgroundServiceEvent

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> BackgroundServiceEventReceived:
        return cls(
            background_service_event=BackgroundServiceEvent.from_json(
                json["backgroundServiceEvent"]
            )
        )

background_service_event: BackgroundServiceEvent instance-attribute

__init__(background_service_event)

from_json(json) classmethod

Source code in zendriver/cdp/background_service.py 
218
219
220
221
222
223
224
@classmethod
def from_json(cls, json: T_JSON_DICT) -> BackgroundServiceEventReceived:
    return cls(
        background_service_event=BackgroundServiceEvent.from_json(
            json["backgroundServiceEvent"]
        )
    )

EventMetadata dataclass

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

Source code in zendriver/cdp/background_service.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
@dataclass
class EventMetadata:
    """
    A key-value pair for additional event information to pass along.
    """

    key: str

    value: str

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["key"] = self.key
        json["value"] = self.value
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> EventMetadata:
        return cls(
            key=str(json["key"]),
            value=str(json["value"]),
        )

key: str instance-attribute

value: str instance-attribute

__init__(key, value)

from_json(json) classmethod

Source code in zendriver/cdp/background_service.py 
56
57
58
59
60
61
@classmethod
def from_json(cls, json: T_JSON_DICT) -> EventMetadata:
    return cls(
        key=str(json["key"]),
        value=str(json["value"]),
    )

to_json()

Source code in zendriver/cdp/background_service.py 
50
51
52
53
54
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["key"] = self.key
    json["value"] = self.value
    return json

RecordingStateChanged dataclass

Called when the recording state for the service has been updated.

Source code in zendriver/cdp/background_service.py 
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
@event_class("BackgroundService.recordingStateChanged")
@dataclass
class RecordingStateChanged:
    """
    Called when the recording state for the service has been updated.
    """

    is_recording: bool
    service: ServiceName

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> RecordingStateChanged:
        return cls(
            is_recording=bool(json["isRecording"]),
            service=ServiceName.from_json(json["service"]),
        )

is_recording: bool instance-attribute

service: ServiceName instance-attribute

__init__(is_recording, service)

from_json(json) classmethod

Source code in zendriver/cdp/background_service.py 
200
201
202
203
204
205
@classmethod
def from_json(cls, json: T_JSON_DICT) -> RecordingStateChanged:
    return cls(
        is_recording=bool(json["isRecording"]),
        service=ServiceName.from_json(json["service"]),
    )

ServiceName

Bases: Enum

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

Source code in zendriver/cdp/background_service.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class ServiceName(enum.Enum):
    """
    The Background Service that will be associated with the commands/events.
    Every Background Service operates independently, but they share the same
    API.
    """

    BACKGROUND_FETCH = "backgroundFetch"
    BACKGROUND_SYNC = "backgroundSync"
    PUSH_MESSAGING = "pushMessaging"
    NOTIFICATIONS = "notifications"
    PAYMENT_HANDLER = "paymentHandler"
    PERIODIC_BACKGROUND_SYNC = "periodicBackgroundSync"

    def to_json(self) -> str:
        return self.value

    @classmethod
    def from_json(cls, json: str) -> ServiceName:
        return cls(json)

BACKGROUND_FETCH = 'backgroundFetch' class-attribute instance-attribute

BACKGROUND_SYNC = 'backgroundSync' class-attribute instance-attribute

NOTIFICATIONS = 'notifications' class-attribute instance-attribute

PAYMENT_HANDLER = 'paymentHandler' class-attribute instance-attribute

PERIODIC_BACKGROUND_SYNC = 'periodicBackgroundSync' class-attribute instance-attribute

PUSH_MESSAGING = 'pushMessaging' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/background_service.py 
35
36
37
@classmethod
def from_json(cls, json: str) -> ServiceName:
    return cls(json)

to_json()

Source code in zendriver/cdp/background_service.py 
32
33
def to_json(self) -> str:
    return self.value

clear_events(service)

Clears all stored data for the service.

Parameters:

Name Type Description Default
service ServiceName
required
Source code in zendriver/cdp/background_service.py 
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
def clear_events(
    service: ServiceName,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Clears all stored data for the service.

    :param service:
    """
    params: T_JSON_DICT = dict()
    params["service"] = service.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "BackgroundService.clearEvents",
        "params": params,
    }
    json = yield cmd_dict

set_recording(should_record, service)

Set the recording state for the service.

Parameters:

Name Type Description Default
should_record bool
required
service ServiceName
required
Source code in zendriver/cdp/background_service.py 
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
def set_recording(
    should_record: bool, service: ServiceName
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Set the recording state for the service.

    :param should_record:
    :param service:
    """
    params: T_JSON_DICT = dict()
    params["shouldRecord"] = should_record
    params["service"] = service.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "BackgroundService.setRecording",
        "params": params,
    }
    json = yield cmd_dict

start_observing(service)

Enables event updates for the service.

Parameters:

Name Type Description Default
service ServiceName
required
Source code in zendriver/cdp/background_service.py 
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
def start_observing(
    service: ServiceName,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Enables event updates for the service.

    :param service:
    """
    params: T_JSON_DICT = dict()
    params["service"] = service.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "BackgroundService.startObserving",
        "params": params,
    }
    json = yield cmd_dict

stop_observing(service)

Disables event updates for the service.

Parameters:

Name Type Description Default
service ServiceName
required
Source code in zendriver/cdp/background_service.py 
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
def stop_observing(
    service: ServiceName,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Disables event updates for the service.

    :param service:
    """
    params: T_JSON_DICT = dict()
    params["service"] = service.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "BackgroundService.stopObserving",
        "params": params,
    }
    json = yield cmd_dict