Skip to content

service_worker

RegistrationID

Bases: str

Source code in zendriver/cdp/service_worker.py 
17
18
19
20
21
22
23
24
25
26
class RegistrationID(str):
    def to_json(self) -> str:
        return self

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

    def __repr__(self):
        return "RegistrationID({})".format(super().__repr__())

__repr__()

Source code in zendriver/cdp/service_worker.py 
25
26
def __repr__(self):
    return "RegistrationID({})".format(super().__repr__())

from_json(json) classmethod

Source code in zendriver/cdp/service_worker.py 
21
22
23
@classmethod
def from_json(cls, json: str) -> RegistrationID:
    return cls(json)

to_json()

Source code in zendriver/cdp/service_worker.py 
18
19
def to_json(self) -> str:
    return self

ServiceWorkerErrorMessage dataclass

ServiceWorker error message.

Source code in zendriver/cdp/service_worker.py 
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
@dataclass
class ServiceWorkerErrorMessage:
    """
    ServiceWorker error message.
    """

    error_message: str

    registration_id: RegistrationID

    version_id: str

    source_url: str

    line_number: int

    column_number: int

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["errorMessage"] = self.error_message
        json["registrationId"] = self.registration_id.to_json()
        json["versionId"] = self.version_id
        json["sourceURL"] = self.source_url
        json["lineNumber"] = self.line_number
        json["columnNumber"] = self.column_number
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> ServiceWorkerErrorMessage:
        return cls(
            error_message=str(json["errorMessage"]),
            registration_id=RegistrationID.from_json(json["registrationId"]),
            version_id=str(json["versionId"]),
            source_url=str(json["sourceURL"]),
            line_number=int(json["lineNumber"]),
            column_number=int(json["columnNumber"]),
        )

column_number: int instance-attribute

error_message: str instance-attribute

line_number: int instance-attribute

registration_id: RegistrationID instance-attribute

source_url: str instance-attribute

version_id: str instance-attribute

__init__(error_message, registration_id, version_id, source_url, line_number, column_number)

from_json(json) classmethod

Source code in zendriver/cdp/service_worker.py 
201
202
203
204
205
206
207
208
209
210
@classmethod
def from_json(cls, json: T_JSON_DICT) -> ServiceWorkerErrorMessage:
    return cls(
        error_message=str(json["errorMessage"]),
        registration_id=RegistrationID.from_json(json["registrationId"]),
        version_id=str(json["versionId"]),
        source_url=str(json["sourceURL"]),
        line_number=int(json["lineNumber"]),
        column_number=int(json["columnNumber"]),
    )

to_json()

Source code in zendriver/cdp/service_worker.py 
191
192
193
194
195
196
197
198
199
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["errorMessage"] = self.error_message
    json["registrationId"] = self.registration_id.to_json()
    json["versionId"] = self.version_id
    json["sourceURL"] = self.source_url
    json["lineNumber"] = self.line_number
    json["columnNumber"] = self.column_number
    return json

ServiceWorkerRegistration dataclass

ServiceWorker registration.

Source code in zendriver/cdp/service_worker.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
@dataclass
class ServiceWorkerRegistration:
    """
    ServiceWorker registration.
    """

    registration_id: RegistrationID

    scope_url: str

    is_deleted: bool

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["registrationId"] = self.registration_id.to_json()
        json["scopeURL"] = self.scope_url
        json["isDeleted"] = self.is_deleted
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> ServiceWorkerRegistration:
        return cls(
            registration_id=RegistrationID.from_json(json["registrationId"]),
            scope_url=str(json["scopeURL"]),
            is_deleted=bool(json["isDeleted"]),
        )

is_deleted: bool instance-attribute

registration_id: RegistrationID instance-attribute

scope_url: str instance-attribute

__init__(registration_id, scope_url, is_deleted)

from_json(json) classmethod

Source code in zendriver/cdp/service_worker.py 
48
49
50
51
52
53
54
@classmethod
def from_json(cls, json: T_JSON_DICT) -> ServiceWorkerRegistration:
    return cls(
        registration_id=RegistrationID.from_json(json["registrationId"]),
        scope_url=str(json["scopeURL"]),
        is_deleted=bool(json["isDeleted"]),
    )

to_json()

Source code in zendriver/cdp/service_worker.py 
41
42
43
44
45
46
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["registrationId"] = self.registration_id.to_json()
    json["scopeURL"] = self.scope_url
    json["isDeleted"] = self.is_deleted
    return json

ServiceWorkerVersion dataclass

ServiceWorker version.

Source code in zendriver/cdp/service_worker.py 
 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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
@dataclass
class ServiceWorkerVersion:
    """
    ServiceWorker version.
    """

    version_id: str

    registration_id: RegistrationID

    script_url: str

    running_status: ServiceWorkerVersionRunningStatus

    status: ServiceWorkerVersionStatus

    #: The Last-Modified header value of the main script.
    script_last_modified: typing.Optional[float] = None

    #: The time at which the response headers of the main script were received from the server.
    #: For cached script it is the last time the cache entry was validated.
    script_response_time: typing.Optional[float] = None

    controlled_clients: typing.Optional[typing.List[target.TargetID]] = None

    target_id: typing.Optional[target.TargetID] = None

    router_rules: typing.Optional[str] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["versionId"] = self.version_id
        json["registrationId"] = self.registration_id.to_json()
        json["scriptURL"] = self.script_url
        json["runningStatus"] = self.running_status.to_json()
        json["status"] = self.status.to_json()
        if self.script_last_modified is not None:
            json["scriptLastModified"] = self.script_last_modified
        if self.script_response_time is not None:
            json["scriptResponseTime"] = self.script_response_time
        if self.controlled_clients is not None:
            json["controlledClients"] = [i.to_json() for i in self.controlled_clients]
        if self.target_id is not None:
            json["targetId"] = self.target_id.to_json()
        if self.router_rules is not None:
            json["routerRules"] = self.router_rules
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> ServiceWorkerVersion:
        return cls(
            version_id=str(json["versionId"]),
            registration_id=RegistrationID.from_json(json["registrationId"]),
            script_url=str(json["scriptURL"]),
            running_status=ServiceWorkerVersionRunningStatus.from_json(
                json["runningStatus"]
            ),
            status=ServiceWorkerVersionStatus.from_json(json["status"]),
            script_last_modified=(
                float(json["scriptLastModified"])
                if json.get("scriptLastModified", None) is not None
                else None
            ),
            script_response_time=(
                float(json["scriptResponseTime"])
                if json.get("scriptResponseTime", None) is not None
                else None
            ),
            controlled_clients=(
                [target.TargetID.from_json(i) for i in json["controlledClients"]]
                if json.get("controlledClients", None) is not None
                else None
            ),
            target_id=(
                target.TargetID.from_json(json["targetId"])
                if json.get("targetId", None) is not None
                else None
            ),
            router_rules=(
                str(json["routerRules"])
                if json.get("routerRules", None) is not None
                else None
            ),
        )

controlled_clients: typing.Optional[typing.List[target.TargetID]] = None class-attribute instance-attribute

registration_id: RegistrationID instance-attribute

router_rules: typing.Optional[str] = None class-attribute instance-attribute

running_status: ServiceWorkerVersionRunningStatus instance-attribute

script_last_modified: typing.Optional[float] = None class-attribute instance-attribute

script_response_time: typing.Optional[float] = None class-attribute instance-attribute

script_url: str instance-attribute

status: ServiceWorkerVersionStatus instance-attribute

target_id: typing.Optional[target.TargetID] = None class-attribute instance-attribute

version_id: str instance-attribute

__init__(version_id, registration_id, script_url, running_status, status, script_last_modified=None, script_response_time=None, controlled_clients=None, target_id=None, router_rules=None)

from_json(json) classmethod

Source code in zendriver/cdp/service_worker.py 
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
@classmethod
def from_json(cls, json: T_JSON_DICT) -> ServiceWorkerVersion:
    return cls(
        version_id=str(json["versionId"]),
        registration_id=RegistrationID.from_json(json["registrationId"]),
        script_url=str(json["scriptURL"]),
        running_status=ServiceWorkerVersionRunningStatus.from_json(
            json["runningStatus"]
        ),
        status=ServiceWorkerVersionStatus.from_json(json["status"]),
        script_last_modified=(
            float(json["scriptLastModified"])
            if json.get("scriptLastModified", None) is not None
            else None
        ),
        script_response_time=(
            float(json["scriptResponseTime"])
            if json.get("scriptResponseTime", None) is not None
            else None
        ),
        controlled_clients=(
            [target.TargetID.from_json(i) for i in json["controlledClients"]]
            if json.get("controlledClients", None) is not None
            else None
        ),
        target_id=(
            target.TargetID.from_json(json["targetId"])
            if json.get("targetId", None) is not None
            else None
        ),
        router_rules=(
            str(json["routerRules"])
            if json.get("routerRules", None) is not None
            else None
        ),
    )

to_json()

Source code in zendriver/cdp/service_worker.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["versionId"] = self.version_id
    json["registrationId"] = self.registration_id.to_json()
    json["scriptURL"] = self.script_url
    json["runningStatus"] = self.running_status.to_json()
    json["status"] = self.status.to_json()
    if self.script_last_modified is not None:
        json["scriptLastModified"] = self.script_last_modified
    if self.script_response_time is not None:
        json["scriptResponseTime"] = self.script_response_time
    if self.controlled_clients is not None:
        json["controlledClients"] = [i.to_json() for i in self.controlled_clients]
    if self.target_id is not None:
        json["targetId"] = self.target_id.to_json()
    if self.router_rules is not None:
        json["routerRules"] = self.router_rules
    return json

ServiceWorkerVersionRunningStatus

Bases: Enum

Source code in zendriver/cdp/service_worker.py 
57
58
59
60
61
62
63
64
65
66
67
68
class ServiceWorkerVersionRunningStatus(enum.Enum):
    STOPPED = "stopped"
    STARTING = "starting"
    RUNNING = "running"
    STOPPING = "stopping"

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

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

RUNNING = 'running' class-attribute instance-attribute

STARTING = 'starting' class-attribute instance-attribute

STOPPED = 'stopped' class-attribute instance-attribute

STOPPING = 'stopping' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/service_worker.py 
66
67
68
@classmethod
def from_json(cls, json: str) -> ServiceWorkerVersionRunningStatus:
    return cls(json)

to_json()

Source code in zendriver/cdp/service_worker.py 
63
64
def to_json(self) -> str:
    return self.value

ServiceWorkerVersionStatus

Bases: Enum

Source code in zendriver/cdp/service_worker.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
class ServiceWorkerVersionStatus(enum.Enum):
    NEW = "new"
    INSTALLING = "installing"
    INSTALLED = "installed"
    ACTIVATING = "activating"
    ACTIVATED = "activated"
    REDUNDANT = "redundant"

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

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

ACTIVATED = 'activated' class-attribute instance-attribute

ACTIVATING = 'activating' class-attribute instance-attribute

INSTALLED = 'installed' class-attribute instance-attribute

INSTALLING = 'installing' class-attribute instance-attribute

NEW = 'new' class-attribute instance-attribute

REDUNDANT = 'redundant' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/service_worker.py 
82
83
84
@classmethod
def from_json(cls, json: str) -> ServiceWorkerVersionStatus:
    return cls(json)

to_json()

Source code in zendriver/cdp/service_worker.py 
79
80
def to_json(self) -> str:
    return self.value

WorkerErrorReported dataclass

Source code in zendriver/cdp/service_worker.py 
391
392
393
394
395
396
397
398
399
400
@event_class("ServiceWorker.workerErrorReported")
@dataclass
class WorkerErrorReported:
    error_message: ServiceWorkerErrorMessage

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> WorkerErrorReported:
        return cls(
            error_message=ServiceWorkerErrorMessage.from_json(json["errorMessage"])
        )

error_message: ServiceWorkerErrorMessage instance-attribute

__init__(error_message)

from_json(json) classmethod

Source code in zendriver/cdp/service_worker.py 
396
397
398
399
400
@classmethod
def from_json(cls, json: T_JSON_DICT) -> WorkerErrorReported:
    return cls(
        error_message=ServiceWorkerErrorMessage.from_json(json["errorMessage"])
    )

WorkerRegistrationUpdated dataclass

Source code in zendriver/cdp/service_worker.py 
403
404
405
406
407
408
409
410
411
412
413
414
@event_class("ServiceWorker.workerRegistrationUpdated")
@dataclass
class WorkerRegistrationUpdated:
    registrations: typing.List[ServiceWorkerRegistration]

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> WorkerRegistrationUpdated:
        return cls(
            registrations=[
                ServiceWorkerRegistration.from_json(i) for i in json["registrations"]
            ]
        )

registrations: typing.List[ServiceWorkerRegistration] instance-attribute

__init__(registrations)

from_json(json) classmethod

Source code in zendriver/cdp/service_worker.py 
408
409
410
411
412
413
414
@classmethod
def from_json(cls, json: T_JSON_DICT) -> WorkerRegistrationUpdated:
    return cls(
        registrations=[
            ServiceWorkerRegistration.from_json(i) for i in json["registrations"]
        ]
    )

WorkerVersionUpdated dataclass

Source code in zendriver/cdp/service_worker.py 
417
418
419
420
421
422
423
424
425
426
@event_class("ServiceWorker.workerVersionUpdated")
@dataclass
class WorkerVersionUpdated:
    versions: typing.List[ServiceWorkerVersion]

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> WorkerVersionUpdated:
        return cls(
            versions=[ServiceWorkerVersion.from_json(i) for i in json["versions"]]
        )

versions: typing.List[ServiceWorkerVersion] instance-attribute

__init__(versions)

from_json(json) classmethod

Source code in zendriver/cdp/service_worker.py 
422
423
424
425
426
@classmethod
def from_json(cls, json: T_JSON_DICT) -> WorkerVersionUpdated:
    return cls(
        versions=[ServiceWorkerVersion.from_json(i) for i in json["versions"]]
    )

deliver_push_message(origin, registration_id, data)

Parameters:

Name Type Description Default
origin str
required
registration_id RegistrationID
required
data str
required
Source code in zendriver/cdp/service_worker.py 
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
def deliver_push_message(
    origin: str, registration_id: RegistrationID, data: str
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    :param origin:
    :param registration_id:
    :param data:
    """
    params: T_JSON_DICT = dict()
    params["origin"] = origin
    params["registrationId"] = registration_id.to_json()
    params["data"] = data
    cmd_dict: T_JSON_DICT = {
        "method": "ServiceWorker.deliverPushMessage",
        "params": params,
    }
    json = yield cmd_dict

disable()

Source code in zendriver/cdp/service_worker.py 
232
233
234
235
236
237
def disable() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:

    cmd_dict: T_JSON_DICT = {
        "method": "ServiceWorker.disable",
    }
    json = yield cmd_dict

dispatch_periodic_sync_event(origin, registration_id, tag)

Parameters:

Name Type Description Default
origin str
required
registration_id RegistrationID
required
tag str
required
Source code in zendriver/cdp/service_worker.py 
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
def dispatch_periodic_sync_event(
    origin: str, registration_id: RegistrationID, tag: str
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    :param origin:
    :param registration_id:
    :param tag:
    """
    params: T_JSON_DICT = dict()
    params["origin"] = origin
    params["registrationId"] = registration_id.to_json()
    params["tag"] = tag
    cmd_dict: T_JSON_DICT = {
        "method": "ServiceWorker.dispatchPeriodicSyncEvent",
        "params": params,
    }
    json = yield cmd_dict

dispatch_sync_event(origin, registration_id, tag, last_chance)

Parameters:

Name Type Description Default
origin str
required
registration_id RegistrationID
required
tag str
required
last_chance bool
required
Source code in zendriver/cdp/service_worker.py 
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
def dispatch_sync_event(
    origin: str, registration_id: RegistrationID, tag: str, last_chance: bool
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    :param origin:
    :param registration_id:
    :param tag:
    :param last_chance:
    """
    params: T_JSON_DICT = dict()
    params["origin"] = origin
    params["registrationId"] = registration_id.to_json()
    params["tag"] = tag
    params["lastChance"] = last_chance
    cmd_dict: T_JSON_DICT = {
        "method": "ServiceWorker.dispatchSyncEvent",
        "params": params,
    }
    json = yield cmd_dict

enable()

Source code in zendriver/cdp/service_worker.py 
280
281
282
283
284
285
def enable() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:

    cmd_dict: T_JSON_DICT = {
        "method": "ServiceWorker.enable",
    }
    json = yield cmd_dict

inspect_worker(version_id)

Parameters:

Name Type Description Default
version_id str
required
Source code in zendriver/cdp/service_worker.py 
288
289
290
291
292
293
294
295
296
297
298
def inspect_worker(version_id: str) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    :param version_id:
    """
    params: T_JSON_DICT = dict()
    params["versionId"] = version_id
    cmd_dict: T_JSON_DICT = {
        "method": "ServiceWorker.inspectWorker",
        "params": params,
    }
    json = yield cmd_dict

set_force_update_on_page_load(force_update_on_page_load)

Parameters:

Name Type Description Default
force_update_on_page_load bool
required
Source code in zendriver/cdp/service_worker.py 
301
302
303
304
305
306
307
308
309
310
311
312
313
def set_force_update_on_page_load(
    force_update_on_page_load: bool,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    :param force_update_on_page_load:
    """
    params: T_JSON_DICT = dict()
    params["forceUpdateOnPageLoad"] = force_update_on_page_load
    cmd_dict: T_JSON_DICT = {
        "method": "ServiceWorker.setForceUpdateOnPageLoad",
        "params": params,
    }
    json = yield cmd_dict

skip_waiting(scope_url)

Parameters:

Name Type Description Default
scope_url str
required
Source code in zendriver/cdp/service_worker.py 
316
317
318
319
320
321
322
323
324
325
326
def skip_waiting(scope_url: str) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    :param scope_url:
    """
    params: T_JSON_DICT = dict()
    params["scopeURL"] = scope_url
    cmd_dict: T_JSON_DICT = {
        "method": "ServiceWorker.skipWaiting",
        "params": params,
    }
    json = yield cmd_dict

start_worker(scope_url)

Parameters:

Name Type Description Default
scope_url str
required
Source code in zendriver/cdp/service_worker.py 
329
330
331
332
333
334
335
336
337
338
339
def start_worker(scope_url: str) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    :param scope_url:
    """
    params: T_JSON_DICT = dict()
    params["scopeURL"] = scope_url
    cmd_dict: T_JSON_DICT = {
        "method": "ServiceWorker.startWorker",
        "params": params,
    }
    json = yield cmd_dict

stop_all_workers()

Source code in zendriver/cdp/service_worker.py 
342
343
344
345
346
347
def stop_all_workers() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:

    cmd_dict: T_JSON_DICT = {
        "method": "ServiceWorker.stopAllWorkers",
    }
    json = yield cmd_dict

stop_worker(version_id)

Parameters:

Name Type Description Default
version_id str
required
Source code in zendriver/cdp/service_worker.py 
350
351
352
353
354
355
356
357
358
359
360
def stop_worker(version_id: str) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    :param version_id:
    """
    params: T_JSON_DICT = dict()
    params["versionId"] = version_id
    cmd_dict: T_JSON_DICT = {
        "method": "ServiceWorker.stopWorker",
        "params": params,
    }
    json = yield cmd_dict

unregister(scope_url)

Parameters:

Name Type Description Default
scope_url str
required
Source code in zendriver/cdp/service_worker.py 
363
364
365
366
367
368
369
370
371
372
373
def unregister(scope_url: str) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    :param scope_url:
    """
    params: T_JSON_DICT = dict()
    params["scopeURL"] = scope_url
    cmd_dict: T_JSON_DICT = {
        "method": "ServiceWorker.unregister",
        "params": params,
    }
    json = yield cmd_dict

update_registration(scope_url)

Parameters:

Name Type Description Default
scope_url str
required
Source code in zendriver/cdp/service_worker.py 
376
377
378
379
380
381
382
383
384
385
386
387
388
def update_registration(
    scope_url: str,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    :param scope_url:
    """
    params: T_JSON_DICT = dict()
    params["scopeURL"] = scope_url
    cmd_dict: T_JSON_DICT = {
        "method": "ServiceWorker.updateRegistration",
        "params": params,
    }
    json = yield cmd_dict