Skip to content

dom_storage

DomStorageItemAdded dataclass

Source code in zendriver/cdp/dom_storage.py 
169
170
171
172
173
174
175
176
177
178
179
180
181
182
@event_class("DOMStorage.domStorageItemAdded")
@dataclass
class DomStorageItemAdded:
    storage_id: StorageId
    key: str
    new_value: str

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> DomStorageItemAdded:
        return cls(
            storage_id=StorageId.from_json(json["storageId"]),
            key=str(json["key"]),
            new_value=str(json["newValue"]),
        )

key: str instance-attribute

new_value: str instance-attribute

storage_id: StorageId instance-attribute

__init__(storage_id, key, new_value)

from_json(json) classmethod

Source code in zendriver/cdp/dom_storage.py 
176
177
178
179
180
181
182
@classmethod
def from_json(cls, json: T_JSON_DICT) -> DomStorageItemAdded:
    return cls(
        storage_id=StorageId.from_json(json["storageId"]),
        key=str(json["key"]),
        new_value=str(json["newValue"]),
    )

DomStorageItemRemoved dataclass

Source code in zendriver/cdp/dom_storage.py 
185
186
187
188
189
190
191
192
193
194
195
@event_class("DOMStorage.domStorageItemRemoved")
@dataclass
class DomStorageItemRemoved:
    storage_id: StorageId
    key: str

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> DomStorageItemRemoved:
        return cls(
            storage_id=StorageId.from_json(json["storageId"]), key=str(json["key"])
        )

key: str instance-attribute

storage_id: StorageId instance-attribute

__init__(storage_id, key)

from_json(json) classmethod

Source code in zendriver/cdp/dom_storage.py 
191
192
193
194
195
@classmethod
def from_json(cls, json: T_JSON_DICT) -> DomStorageItemRemoved:
    return cls(
        storage_id=StorageId.from_json(json["storageId"]), key=str(json["key"])
    )

DomStorageItemUpdated dataclass

Source code in zendriver/cdp/dom_storage.py 
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
@event_class("DOMStorage.domStorageItemUpdated")
@dataclass
class DomStorageItemUpdated:
    storage_id: StorageId
    key: str
    old_value: str
    new_value: str

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> DomStorageItemUpdated:
        return cls(
            storage_id=StorageId.from_json(json["storageId"]),
            key=str(json["key"]),
            old_value=str(json["oldValue"]),
            new_value=str(json["newValue"]),
        )

key: str instance-attribute

new_value: str instance-attribute

old_value: str instance-attribute

storage_id: StorageId instance-attribute

__init__(storage_id, key, old_value, new_value)

from_json(json) classmethod

Source code in zendriver/cdp/dom_storage.py 
206
207
208
209
210
211
212
213
@classmethod
def from_json(cls, json: T_JSON_DICT) -> DomStorageItemUpdated:
    return cls(
        storage_id=StorageId.from_json(json["storageId"]),
        key=str(json["key"]),
        old_value=str(json["oldValue"]),
        new_value=str(json["newValue"]),
    )

DomStorageItemsCleared dataclass

Source code in zendriver/cdp/dom_storage.py 
216
217
218
219
220
221
222
223
@event_class("DOMStorage.domStorageItemsCleared")
@dataclass
class DomStorageItemsCleared:
    storage_id: StorageId

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> DomStorageItemsCleared:
        return cls(storage_id=StorageId.from_json(json["storageId"]))

storage_id: StorageId instance-attribute

__init__(storage_id)

from_json(json) classmethod

Source code in zendriver/cdp/dom_storage.py 
221
222
223
@classmethod
def from_json(cls, json: T_JSON_DICT) -> DomStorageItemsCleared:
    return cls(storage_id=StorageId.from_json(json["storageId"]))

Item

Bases: list

DOM Storage item.

Source code in zendriver/cdp/dom_storage.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
class Item(list):
    """
    DOM Storage item.
    """

    def to_json(self) -> typing.List[str]:
        return self

    @classmethod
    def from_json(cls, json: typing.List[str]) -> Item:
        return cls(json)

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

__repr__()

Source code in zendriver/cdp/dom_storage.py 
79
80
def __repr__(self):
    return "Item({})".format(super().__repr__())

from_json(json) classmethod

Source code in zendriver/cdp/dom_storage.py 
75
76
77
@classmethod
def from_json(cls, json: typing.List[str]) -> Item:
    return cls(json)

to_json()

Source code in zendriver/cdp/dom_storage.py 
72
73
def to_json(self) -> typing.List[str]:
    return self

SerializedStorageKey

Bases: str

Source code in zendriver/cdp/dom_storage.py 
14
15
16
17
18
19
20
21
22
23
class SerializedStorageKey(str):
    def to_json(self) -> str:
        return self

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

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

__repr__()

Source code in zendriver/cdp/dom_storage.py 
22
23
def __repr__(self):
    return "SerializedStorageKey({})".format(super().__repr__())

from_json(json) classmethod

Source code in zendriver/cdp/dom_storage.py 
18
19
20
@classmethod
def from_json(cls, json: str) -> SerializedStorageKey:
    return cls(json)

to_json()

Source code in zendriver/cdp/dom_storage.py 
15
16
def to_json(self) -> str:
    return self

StorageId dataclass

DOM Storage identifier.

Source code in zendriver/cdp/dom_storage.py 
26
27
28
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
55
56
57
58
59
60
61
62
63
64
@dataclass
class StorageId:
    """
    DOM Storage identifier.
    """

    #: Whether the storage is local storage (not session storage).
    is_local_storage: bool

    #: Security origin for the storage.
    security_origin: typing.Optional[str] = None

    #: Represents a key by which DOM Storage keys its CachedStorageAreas
    storage_key: typing.Optional[SerializedStorageKey] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["isLocalStorage"] = self.is_local_storage
        if self.security_origin is not None:
            json["securityOrigin"] = self.security_origin
        if self.storage_key is not None:
            json["storageKey"] = self.storage_key.to_json()
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> StorageId:
        return cls(
            is_local_storage=bool(json["isLocalStorage"]),
            security_origin=(
                str(json["securityOrigin"])
                if json.get("securityOrigin", None) is not None
                else None
            ),
            storage_key=(
                SerializedStorageKey.from_json(json["storageKey"])
                if json.get("storageKey", None) is not None
                else None
            ),
        )

is_local_storage: bool instance-attribute

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

storage_key: typing.Optional[SerializedStorageKey] = None class-attribute instance-attribute

__init__(is_local_storage, security_origin=None, storage_key=None)

from_json(json) classmethod

Source code in zendriver/cdp/dom_storage.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
@classmethod
def from_json(cls, json: T_JSON_DICT) -> StorageId:
    return cls(
        is_local_storage=bool(json["isLocalStorage"]),
        security_origin=(
            str(json["securityOrigin"])
            if json.get("securityOrigin", None) is not None
            else None
        ),
        storage_key=(
            SerializedStorageKey.from_json(json["storageKey"])
            if json.get("storageKey", None) is not None
            else None
        ),
    )

to_json()

Source code in zendriver/cdp/dom_storage.py 
41
42
43
44
45
46
47
48
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["isLocalStorage"] = self.is_local_storage
    if self.security_origin is not None:
        json["securityOrigin"] = self.security_origin
    if self.storage_key is not None:
        json["storageKey"] = self.storage_key.to_json()
    return json

clear(storage_id)

Parameters:

Name Type Description Default
storage_id StorageId
required
Source code in zendriver/cdp/dom_storage.py 
83
84
85
86
87
88
89
90
91
92
93
def clear(storage_id: StorageId) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    :param storage_id:
    """
    params: T_JSON_DICT = dict()
    params["storageId"] = storage_id.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "DOMStorage.clear",
        "params": params,
    }
    json = yield cmd_dict

disable()

Disables storage tracking, prevents storage events from being sent to the client.

Source code in zendriver/cdp/dom_storage.py 
 96
 97
 98
 99
100
101
102
103
def disable() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Disables storage tracking, prevents storage events from being sent to the client.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "DOMStorage.disable",
    }
    json = yield cmd_dict

enable()

Enables storage tracking, storage events will now be delivered to the client.

Source code in zendriver/cdp/dom_storage.py 
106
107
108
109
110
111
112
113
def enable() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Enables storage tracking, storage events will now be delivered to the client.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "DOMStorage.enable",
    }
    json = yield cmd_dict

get_dom_storage_items(storage_id)

Parameters:

Name Type Description Default
storage_id StorageId
required

Returns:

Type Description
Generator[T_JSON_DICT, T_JSON_DICT, List[Item]]
Source code in zendriver/cdp/dom_storage.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
def get_dom_storage_items(
    storage_id: StorageId,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, typing.List[Item]]:
    """
    :param storage_id:
    :returns:
    """
    params: T_JSON_DICT = dict()
    params["storageId"] = storage_id.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "DOMStorage.getDOMStorageItems",
        "params": params,
    }
    json = yield cmd_dict
    return [Item.from_json(i) for i in json["entries"]]

remove_dom_storage_item(storage_id, key)

Parameters:

Name Type Description Default
storage_id StorageId
required
key str
required
Source code in zendriver/cdp/dom_storage.py 
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
def remove_dom_storage_item(
    storage_id: StorageId, key: str
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    :param storage_id:
    :param key:
    """
    params: T_JSON_DICT = dict()
    params["storageId"] = storage_id.to_json()
    params["key"] = key
    cmd_dict: T_JSON_DICT = {
        "method": "DOMStorage.removeDOMStorageItem",
        "params": params,
    }
    json = yield cmd_dict

set_dom_storage_item(storage_id, key, value)

Parameters:

Name Type Description Default
storage_id StorageId
required
key str
required
value str
required
Source code in zendriver/cdp/dom_storage.py 
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
def set_dom_storage_item(
    storage_id: StorageId, key: str, value: str
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    :param storage_id:
    :param key:
    :param value:
    """
    params: T_JSON_DICT = dict()
    params["storageId"] = storage_id.to_json()
    params["key"] = key
    params["value"] = value
    cmd_dict: T_JSON_DICT = {
        "method": "DOMStorage.setDOMStorageItem",
        "params": params,
    }
    json = yield cmd_dict