storage

CacheStorageContentUpdated dataclass

A cache's contents have been modified.

Source code in zendriver/cdp/storage.py

@event_class("Storage.cacheStorageContentUpdated")
@dataclass
class CacheStorageContentUpdated:
    """
    A cache's contents have been modified.
    """

    #: Origin to update.
    origin: str
    #: Storage key to update.
    storage_key: str
    #: Storage bucket to update.
    bucket_id: str
    #: Name of cache in origin.
    cache_name: str

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> CacheStorageContentUpdated:
        return cls(
            origin=str(json["origin"]),
            storage_key=str(json["storageKey"]),
            bucket_id=str(json["bucketId"]),
            cache_name=str(json["cacheName"]),
        )

bucket_id: str instance-attribute

cache_name: str instance-attribute

origin: str instance-attribute

storage_key: str instance-attribute

__init__(origin, storage_key, bucket_id, cache_name)

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> CacheStorageContentUpdated:
    return cls(
        origin=str(json["origin"]),
        storage_key=str(json["storageKey"]),
        bucket_id=str(json["bucketId"]),
        cache_name=str(json["cacheName"]),
    )

CacheStorageListUpdated dataclass

A cache has been added/deleted.

Source code in zendriver/cdp/storage.py

@event_class("Storage.cacheStorageListUpdated")
@dataclass
class CacheStorageListUpdated:
    """
    A cache has been added/deleted.
    """

    #: Origin to update.
    origin: str
    #: Storage key to update.
    storage_key: str
    #: Storage bucket to update.
    bucket_id: str

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> CacheStorageListUpdated:
        return cls(
            origin=str(json["origin"]),
            storage_key=str(json["storageKey"]),
            bucket_id=str(json["bucketId"]),
        )

bucket_id: str instance-attribute

origin: str instance-attribute

storage_key: str instance-attribute

__init__(origin, storage_key, bucket_id)

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> CacheStorageListUpdated:
    return cls(
        origin=str(json["origin"]),
        storage_key=str(json["storageKey"]),
        bucket_id=str(json["bucketId"]),
    )

IndexedDBContentUpdated dataclass

The origin's IndexedDB object store has been modified.

Source code in zendriver/cdp/storage.py

@event_class("Storage.indexedDBContentUpdated")
@dataclass
class IndexedDBContentUpdated:
    """
    The origin's IndexedDB object store has been modified.
    """

    #: Origin to update.
    origin: str
    #: Storage key to update.
    storage_key: str
    #: Storage bucket to update.
    bucket_id: str
    #: Database to update.
    database_name: str
    #: ObjectStore to update.
    object_store_name: str

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> IndexedDBContentUpdated:
        return cls(
            origin=str(json["origin"]),
            storage_key=str(json["storageKey"]),
            bucket_id=str(json["bucketId"]),
            database_name=str(json["databaseName"]),
            object_store_name=str(json["objectStoreName"]),
        )

bucket_id: str instance-attribute

database_name: str instance-attribute

object_store_name: str instance-attribute

origin: str instance-attribute

storage_key: str instance-attribute

__init__(origin, storage_key, bucket_id, database_name, object_store_name)

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> IndexedDBContentUpdated:
    return cls(
        origin=str(json["origin"]),
        storage_key=str(json["storageKey"]),
        bucket_id=str(json["bucketId"]),
        database_name=str(json["databaseName"]),
        object_store_name=str(json["objectStoreName"]),
    )

IndexedDBListUpdated dataclass

The origin's IndexedDB database list has been modified.

Source code in zendriver/cdp/storage.py

@event_class("Storage.indexedDBListUpdated")
@dataclass
class IndexedDBListUpdated:
    """
    The origin's IndexedDB database list has been modified.
    """

    #: Origin to update.
    origin: str
    #: Storage key to update.
    storage_key: str
    #: Storage bucket to update.
    bucket_id: str

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> IndexedDBListUpdated:
        return cls(
            origin=str(json["origin"]),
            storage_key=str(json["storageKey"]),
            bucket_id=str(json["bucketId"]),
        )

bucket_id: str instance-attribute

origin: str instance-attribute

storage_key: str instance-attribute

__init__(origin, storage_key, bucket_id)

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> IndexedDBListUpdated:
    return cls(
        origin=str(json["origin"]),
        storage_key=str(json["storageKey"]),
        bucket_id=str(json["bucketId"]),
    )

InterestGroupAccessType

Bases: Enum

Enum of interest group access types.

Source code in zendriver/cdp/storage.py

class InterestGroupAccessType(enum.Enum):
    """
    Enum of interest group access types.
    """

    JOIN = "join"
    LEAVE = "leave"
    UPDATE = "update"
    LOADED = "loaded"
    BID = "bid"
    WIN = "win"
    ADDITIONAL_BID = "additionalBid"
    ADDITIONAL_BID_WIN = "additionalBidWin"
    TOP_LEVEL_BID = "topLevelBid"
    TOP_LEVEL_ADDITIONAL_BID = "topLevelAdditionalBid"
    CLEAR = "clear"

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

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

ADDITIONAL_BID = 'additionalBid' class-attribute instance-attribute

ADDITIONAL_BID_WIN = 'additionalBidWin' class-attribute instance-attribute

BID = 'bid' class-attribute instance-attribute

CLEAR = 'clear' class-attribute instance-attribute

JOIN = 'join' class-attribute instance-attribute

LEAVE = 'leave' class-attribute instance-attribute

LOADED = 'loaded' class-attribute instance-attribute

TOP_LEVEL_ADDITIONAL_BID = 'topLevelAdditionalBid' class-attribute instance-attribute

TOP_LEVEL_BID = 'topLevelBid' class-attribute instance-attribute

UPDATE = 'update' class-attribute instance-attribute

WIN = 'win' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

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

to_json()

Source code in zendriver/cdp/storage.py

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

InterestGroupAccessed dataclass

One of the interest groups was accessed. Note that these events are global to all targets sharing an interest group store.

Source code in zendriver/cdp/storage.py

@event_class("Storage.interestGroupAccessed")
@dataclass
class InterestGroupAccessed:
    """
    One of the interest groups was accessed. Note that these events are global
    to all targets sharing an interest group store.
    """

    access_time: network.TimeSinceEpoch
    type_: InterestGroupAccessType
    owner_origin: str
    name: str
    #: For topLevelBid/topLevelAdditionalBid, and when appropriate,
    #: win and additionalBidWin
    component_seller_origin: typing.Optional[str]
    #: For bid or somethingBid event, if done locally and not on a server.
    bid: typing.Optional[float]
    bid_currency: typing.Optional[str]
    #: For non-global events --- links to interestGroupAuctionEvent
    unique_auction_id: typing.Optional[InterestGroupAuctionId]

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> InterestGroupAccessed:
        return cls(
            access_time=network.TimeSinceEpoch.from_json(json["accessTime"]),
            type_=InterestGroupAccessType.from_json(json["type"]),
            owner_origin=str(json["ownerOrigin"]),
            name=str(json["name"]),
            component_seller_origin=str(json["componentSellerOrigin"])
            if json.get("componentSellerOrigin", None) is not None
            else None,
            bid=float(json["bid"]) if json.get("bid", None) is not None else None,
            bid_currency=str(json["bidCurrency"])
            if json.get("bidCurrency", None) is not None
            else None,
            unique_auction_id=InterestGroupAuctionId.from_json(json["uniqueAuctionId"])
            if json.get("uniqueAuctionId", None) is not None
            else None,
        )

access_time: network.TimeSinceEpoch instance-attribute

bid: typing.Optional[float] instance-attribute

bid_currency: typing.Optional[str] instance-attribute

component_seller_origin: typing.Optional[str] instance-attribute

name: str instance-attribute

owner_origin: str instance-attribute

type_: InterestGroupAccessType instance-attribute

unique_auction_id: typing.Optional[InterestGroupAuctionId] instance-attribute

__init__(access_time, type_, owner_origin, name, component_seller_origin, bid, bid_currency, unique_auction_id)

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> InterestGroupAccessed:
    return cls(
        access_time=network.TimeSinceEpoch.from_json(json["accessTime"]),
        type_=InterestGroupAccessType.from_json(json["type"]),
        owner_origin=str(json["ownerOrigin"]),
        name=str(json["name"]),
        component_seller_origin=str(json["componentSellerOrigin"])
        if json.get("componentSellerOrigin", None) is not None
        else None,
        bid=float(json["bid"]) if json.get("bid", None) is not None else None,
        bid_currency=str(json["bidCurrency"])
        if json.get("bidCurrency", None) is not None
        else None,
        unique_auction_id=InterestGroupAuctionId.from_json(json["uniqueAuctionId"])
        if json.get("uniqueAuctionId", None) is not None
        else None,
    )

InterestGroupAuctionEventOccurred dataclass

An auction involving interest groups is taking place. These events are target-specific.

Source code in zendriver/cdp/storage.py

@event_class("Storage.interestGroupAuctionEventOccurred")
@dataclass
class InterestGroupAuctionEventOccurred:
    """
    An auction involving interest groups is taking place. These events are
    target-specific.
    """

    event_time: network.TimeSinceEpoch
    type_: InterestGroupAuctionEventType
    unique_auction_id: InterestGroupAuctionId
    #: Set for child auctions.
    parent_auction_id: typing.Optional[InterestGroupAuctionId]
    #: Set for started and configResolved
    auction_config: typing.Optional[dict]

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> InterestGroupAuctionEventOccurred:
        return cls(
            event_time=network.TimeSinceEpoch.from_json(json["eventTime"]),
            type_=InterestGroupAuctionEventType.from_json(json["type"]),
            unique_auction_id=InterestGroupAuctionId.from_json(json["uniqueAuctionId"]),
            parent_auction_id=InterestGroupAuctionId.from_json(json["parentAuctionId"])
            if json.get("parentAuctionId", None) is not None
            else None,
            auction_config=dict(json["auctionConfig"])
            if json.get("auctionConfig", None) is not None
            else None,
        )

auction_config: typing.Optional[dict] instance-attribute

event_time: network.TimeSinceEpoch instance-attribute

parent_auction_id: typing.Optional[InterestGroupAuctionId] instance-attribute

type_: InterestGroupAuctionEventType instance-attribute

unique_auction_id: InterestGroupAuctionId instance-attribute

__init__(event_time, type_, unique_auction_id, parent_auction_id, auction_config)

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> InterestGroupAuctionEventOccurred:
    return cls(
        event_time=network.TimeSinceEpoch.from_json(json["eventTime"]),
        type_=InterestGroupAuctionEventType.from_json(json["type"]),
        unique_auction_id=InterestGroupAuctionId.from_json(json["uniqueAuctionId"]),
        parent_auction_id=InterestGroupAuctionId.from_json(json["parentAuctionId"])
        if json.get("parentAuctionId", None) is not None
        else None,
        auction_config=dict(json["auctionConfig"])
        if json.get("auctionConfig", None) is not None
        else None,
    )

InterestGroupAuctionEventType

Bases: Enum

Enum of auction events.

Source code in zendriver/cdp/storage.py

class InterestGroupAuctionEventType(enum.Enum):
    """
    Enum of auction events.
    """

    STARTED = "started"
    CONFIG_RESOLVED = "configResolved"

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

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

CONFIG_RESOLVED = 'configResolved' class-attribute instance-attribute

STARTED = 'started' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

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

to_json()

Source code in zendriver/cdp/storage.py

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

InterestGroupAuctionFetchType

Bases: Enum

Enum of network fetches auctions can do.

Source code in zendriver/cdp/storage.py

class InterestGroupAuctionFetchType(enum.Enum):
    """
    Enum of network fetches auctions can do.
    """

    BIDDER_JS = "bidderJs"
    BIDDER_WASM = "bidderWasm"
    SELLER_JS = "sellerJs"
    BIDDER_TRUSTED_SIGNALS = "bidderTrustedSignals"
    SELLER_TRUSTED_SIGNALS = "sellerTrustedSignals"

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

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

BIDDER_JS = 'bidderJs' class-attribute instance-attribute

BIDDER_TRUSTED_SIGNALS = 'bidderTrustedSignals' class-attribute instance-attribute

BIDDER_WASM = 'bidderWasm' class-attribute instance-attribute

SELLER_JS = 'sellerJs' class-attribute instance-attribute

SELLER_TRUSTED_SIGNALS = 'sellerTrustedSignals' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

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

to_json()

Source code in zendriver/cdp/storage.py

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

InterestGroupAuctionId

Bases: str

Protected audience interest group auction identifier.

Source code in zendriver/cdp/storage.py

class InterestGroupAuctionId(str):
    """
    Protected audience interest group auction identifier.
    """

    def to_json(self) -> str:
        return self

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

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

__repr__()

Source code in zendriver/cdp/storage.py

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

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

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

to_json()

Source code in zendriver/cdp/storage.py

def to_json(self) -> str:
    return self

InterestGroupAuctionNetworkRequestCreated dataclass

Specifies which auctions a particular network fetch may be related to, and in what role. Note that it is not ordered with respect to Network.requestWillBeSent (but will happen before loadingFinished loadingFailed).

Source code in zendriver/cdp/storage.py

@event_class("Storage.interestGroupAuctionNetworkRequestCreated")
@dataclass
class InterestGroupAuctionNetworkRequestCreated:
    """
    Specifies which auctions a particular network fetch may be related to, and
    in what role. Note that it is not ordered with respect to
    Network.requestWillBeSent (but will happen before loadingFinished
    loadingFailed).
    """

    type_: InterestGroupAuctionFetchType
    request_id: network.RequestId
    #: This is the set of the auctions using the worklet that issued this
    #: request.  In the case of trusted signals, it's possible that only some of
    #: them actually care about the keys being queried.
    auctions: typing.List[InterestGroupAuctionId]

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> InterestGroupAuctionNetworkRequestCreated:
        return cls(
            type_=InterestGroupAuctionFetchType.from_json(json["type"]),
            request_id=network.RequestId.from_json(json["requestId"]),
            auctions=[InterestGroupAuctionId.from_json(i) for i in json["auctions"]],
        )

auctions: typing.List[InterestGroupAuctionId] instance-attribute

request_id: network.RequestId instance-attribute

type_: InterestGroupAuctionFetchType instance-attribute

__init__(type_, request_id, auctions)

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> InterestGroupAuctionNetworkRequestCreated:
    return cls(
        type_=InterestGroupAuctionFetchType.from_json(json["type"]),
        request_id=network.RequestId.from_json(json["requestId"]),
        auctions=[InterestGroupAuctionId.from_json(i) for i in json["auctions"]],
    )

RelatedWebsiteSet dataclass

A single Related Website Set object.

Source code in zendriver/cdp/storage.py

@dataclass
class RelatedWebsiteSet:
    """
    A single Related Website Set object.
    """

    #: The primary site of this set, along with the ccTLDs if there is any.
    primary_sites: typing.List[str]

    #: The associated sites of this set, along with the ccTLDs if there is any.
    associated_sites: typing.List[str]

    #: The service sites of this set, along with the ccTLDs if there is any.
    service_sites: typing.List[str]

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["primarySites"] = [i for i in self.primary_sites]
        json["associatedSites"] = [i for i in self.associated_sites]
        json["serviceSites"] = [i for i in self.service_sites]
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> RelatedWebsiteSet:
        return cls(
            primary_sites=[str(i) for i in json["primarySites"]],
            associated_sites=[str(i) for i in json["associatedSites"]],
            service_sites=[str(i) for i in json["serviceSites"]],
        )

associated_sites: typing.List[str] instance-attribute

primary_sites: typing.List[str] instance-attribute

service_sites: typing.List[str] instance-attribute

__init__(primary_sites, associated_sites, service_sites)

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> RelatedWebsiteSet:
    return cls(
        primary_sites=[str(i) for i in json["primarySites"]],
        associated_sites=[str(i) for i in json["associatedSites"]],
        service_sites=[str(i) for i in json["serviceSites"]],
    )

to_json()

Source code in zendriver/cdp/storage.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["primarySites"] = [i for i in self.primary_sites]
    json["associatedSites"] = [i for i in self.associated_sites]
    json["serviceSites"] = [i for i in self.service_sites]
    return json

SerializedStorageKey

Bases: str

Source code in zendriver/cdp/storage.py

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/storage.py

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

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

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

to_json()

Source code in zendriver/cdp/storage.py

def to_json(self) -> str:
    return self

SharedStorageAccessMethod

Bases: Enum

Enum of shared storage access methods.

Source code in zendriver/cdp/storage.py

class SharedStorageAccessMethod(enum.Enum):
    """
    Enum of shared storage access methods.
    """

    ADD_MODULE = "addModule"
    CREATE_WORKLET = "createWorklet"
    SELECT_URL = "selectURL"
    RUN = "run"
    BATCH_UPDATE = "batchUpdate"
    SET_ = "set"
    APPEND = "append"
    DELETE = "delete"
    CLEAR = "clear"
    GET = "get"
    KEYS = "keys"
    VALUES = "values"
    ENTRIES = "entries"
    LENGTH = "length"
    REMAINING_BUDGET = "remainingBudget"

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

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

ADD_MODULE = 'addModule' class-attribute instance-attribute

APPEND = 'append' class-attribute instance-attribute

BATCH_UPDATE = 'batchUpdate' class-attribute instance-attribute

CLEAR = 'clear' class-attribute instance-attribute

CREATE_WORKLET = 'createWorklet' class-attribute instance-attribute

DELETE = 'delete' class-attribute instance-attribute

ENTRIES = 'entries' class-attribute instance-attribute

GET = 'get' class-attribute instance-attribute

KEYS = 'keys' class-attribute instance-attribute

LENGTH = 'length' class-attribute instance-attribute

REMAINING_BUDGET = 'remainingBudget' class-attribute instance-attribute

RUN = 'run' class-attribute instance-attribute

SELECT_URL = 'selectURL' class-attribute instance-attribute

SET_ = 'set' class-attribute instance-attribute

VALUES = 'values' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

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

to_json()

Source code in zendriver/cdp/storage.py

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

SharedStorageAccessParams dataclass

Bundles the parameters for shared storage access events whose presence/absence can vary according to SharedStorageAccessType.

Source code in zendriver/cdp/storage.py

@dataclass
class SharedStorageAccessParams:
    """
    Bundles the parameters for shared storage access events whose
    presence/absence can vary according to SharedStorageAccessType.
    """

    #: Spec of the module script URL.
    #: Present only for SharedStorageAccessMethods: addModule and
    #: createWorklet.
    script_source_url: typing.Optional[str] = None

    #: String denoting "context-origin", "script-origin", or a custom
    #: origin to be used as the worklet's data origin.
    #: Present only for SharedStorageAccessMethod: createWorklet.
    data_origin: typing.Optional[str] = None

    #: Name of the registered operation to be run.
    #: Present only for SharedStorageAccessMethods: run and selectURL.
    operation_name: typing.Optional[str] = None

    #: ID of the operation call.
    #: Present only for SharedStorageAccessMethods: run and selectURL.
    operation_id: typing.Optional[str] = None

    #: Whether or not to keep the worket alive for future run or selectURL
    #: calls.
    #: Present only for SharedStorageAccessMethods: run and selectURL.
    keep_alive: typing.Optional[bool] = None

    #: Configures the private aggregation options.
    #: Present only for SharedStorageAccessMethods: run and selectURL.
    private_aggregation_config: typing.Optional[
        SharedStoragePrivateAggregationConfig
    ] = None

    #: The operation's serialized data in bytes (converted to a string).
    #: Present only for SharedStorageAccessMethods: run and selectURL.
    #: TODO(crbug.com/401011862): Consider updating this parameter to binary.
    serialized_data: typing.Optional[str] = None

    #: Array of candidate URLs' specs, along with any associated metadata.
    #: Present only for SharedStorageAccessMethod: selectURL.
    urls_with_metadata: typing.Optional[typing.List[SharedStorageUrlWithMetadata]] = (
        None
    )

    #: Spec of the URN:UUID generated for a selectURL call.
    #: Present only for SharedStorageAccessMethod: selectURL.
    urn_uuid: typing.Optional[str] = None

    #: Key for a specific entry in an origin's shared storage.
    #: Present only for SharedStorageAccessMethods: set, append, delete, and
    #: get.
    key: typing.Optional[str] = None

    #: Value for a specific entry in an origin's shared storage.
    #: Present only for SharedStorageAccessMethods: set and append.
    value: typing.Optional[str] = None

    #: Whether or not to set an entry for a key if that key is already present.
    #: Present only for SharedStorageAccessMethod: set.
    ignore_if_present: typing.Optional[bool] = None

    #: A number denoting the (0-based) order of the worklet's
    #: creation relative to all other shared storage worklets created by
    #: documents using the current storage partition.
    #: Present only for SharedStorageAccessMethods: addModule, createWorklet.
    worklet_ordinal: typing.Optional[int] = None

    #: Hex representation of the DevTools token used as the TargetID for the
    #: associated shared storage worklet.
    #: Present only for SharedStorageAccessMethods: addModule, createWorklet,
    #: run, selectURL, and any other SharedStorageAccessMethod when the
    #: SharedStorageAccessScope is sharedStorageWorklet.
    worklet_target_id: typing.Optional[target.TargetID] = None

    #: Name of the lock to be acquired, if present.
    #: Optionally present only for SharedStorageAccessMethods: batchUpdate,
    #: set, append, delete, and clear.
    with_lock: typing.Optional[str] = None

    #: If the method has been called as part of a batchUpdate, then this
    #: number identifies the batch to which it belongs.
    #: Optionally present only for SharedStorageAccessMethods:
    #: batchUpdate (required), set, append, delete, and clear.
    batch_update_id: typing.Optional[str] = None

    #: Number of modifier methods sent in batch.
    #: Present only for SharedStorageAccessMethod: batchUpdate.
    batch_size: typing.Optional[int] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        if self.script_source_url is not None:
            json["scriptSourceUrl"] = self.script_source_url
        if self.data_origin is not None:
            json["dataOrigin"] = self.data_origin
        if self.operation_name is not None:
            json["operationName"] = self.operation_name
        if self.operation_id is not None:
            json["operationId"] = self.operation_id
        if self.keep_alive is not None:
            json["keepAlive"] = self.keep_alive
        if self.private_aggregation_config is not None:
            json["privateAggregationConfig"] = self.private_aggregation_config.to_json()
        if self.serialized_data is not None:
            json["serializedData"] = self.serialized_data
        if self.urls_with_metadata is not None:
            json["urlsWithMetadata"] = [i.to_json() for i in self.urls_with_metadata]
        if self.urn_uuid is not None:
            json["urnUuid"] = self.urn_uuid
        if self.key is not None:
            json["key"] = self.key
        if self.value is not None:
            json["value"] = self.value
        if self.ignore_if_present is not None:
            json["ignoreIfPresent"] = self.ignore_if_present
        if self.worklet_ordinal is not None:
            json["workletOrdinal"] = self.worklet_ordinal
        if self.worklet_target_id is not None:
            json["workletTargetId"] = self.worklet_target_id.to_json()
        if self.with_lock is not None:
            json["withLock"] = self.with_lock
        if self.batch_update_id is not None:
            json["batchUpdateId"] = self.batch_update_id
        if self.batch_size is not None:
            json["batchSize"] = self.batch_size
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> SharedStorageAccessParams:
        return cls(
            script_source_url=str(json["scriptSourceUrl"])
            if json.get("scriptSourceUrl", None) is not None
            else None,
            data_origin=str(json["dataOrigin"])
            if json.get("dataOrigin", None) is not None
            else None,
            operation_name=str(json["operationName"])
            if json.get("operationName", None) is not None
            else None,
            operation_id=str(json["operationId"])
            if json.get("operationId", None) is not None
            else None,
            keep_alive=bool(json["keepAlive"])
            if json.get("keepAlive", None) is not None
            else None,
            private_aggregation_config=SharedStoragePrivateAggregationConfig.from_json(
                json["privateAggregationConfig"]
            )
            if json.get("privateAggregationConfig", None) is not None
            else None,
            serialized_data=str(json["serializedData"])
            if json.get("serializedData", None) is not None
            else None,
            urls_with_metadata=[
                SharedStorageUrlWithMetadata.from_json(i)
                for i in json["urlsWithMetadata"]
            ]
            if json.get("urlsWithMetadata", None) is not None
            else None,
            urn_uuid=str(json["urnUuid"])
            if json.get("urnUuid", None) is not None
            else None,
            key=str(json["key"]) if json.get("key", None) is not None else None,
            value=str(json["value"]) if json.get("value", None) is not None else None,
            ignore_if_present=bool(json["ignoreIfPresent"])
            if json.get("ignoreIfPresent", None) is not None
            else None,
            worklet_ordinal=int(json["workletOrdinal"])
            if json.get("workletOrdinal", None) is not None
            else None,
            worklet_target_id=target.TargetID.from_json(json["workletTargetId"])
            if json.get("workletTargetId", None) is not None
            else None,
            with_lock=str(json["withLock"])
            if json.get("withLock", None) is not None
            else None,
            batch_update_id=str(json["batchUpdateId"])
            if json.get("batchUpdateId", None) is not None
            else None,
            batch_size=int(json["batchSize"])
            if json.get("batchSize", None) is not None
            else None,
        )

batch_size: typing.Optional[int] = None class-attribute instance-attribute

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

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

ignore_if_present: typing.Optional[bool] = None class-attribute instance-attribute

keep_alive: typing.Optional[bool] = None class-attribute instance-attribute

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

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

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

private_aggregation_config: typing.Optional[SharedStoragePrivateAggregationConfig] = None class-attribute instance-attribute

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

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

urls_with_metadata: typing.Optional[typing.List[SharedStorageUrlWithMetadata]] = None class-attribute instance-attribute

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

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

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

worklet_ordinal: typing.Optional[int] = None class-attribute instance-attribute

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

__init__(script_source_url=None, data_origin=None, operation_name=None, operation_id=None, keep_alive=None, private_aggregation_config=None, serialized_data=None, urls_with_metadata=None, urn_uuid=None, key=None, value=None, ignore_if_present=None, worklet_ordinal=None, worklet_target_id=None, with_lock=None, batch_update_id=None, batch_size=None)

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> SharedStorageAccessParams:
    return cls(
        script_source_url=str(json["scriptSourceUrl"])
        if json.get("scriptSourceUrl", None) is not None
        else None,
        data_origin=str(json["dataOrigin"])
        if json.get("dataOrigin", None) is not None
        else None,
        operation_name=str(json["operationName"])
        if json.get("operationName", None) is not None
        else None,
        operation_id=str(json["operationId"])
        if json.get("operationId", None) is not None
        else None,
        keep_alive=bool(json["keepAlive"])
        if json.get("keepAlive", None) is not None
        else None,
        private_aggregation_config=SharedStoragePrivateAggregationConfig.from_json(
            json["privateAggregationConfig"]
        )
        if json.get("privateAggregationConfig", None) is not None
        else None,
        serialized_data=str(json["serializedData"])
        if json.get("serializedData", None) is not None
        else None,
        urls_with_metadata=[
            SharedStorageUrlWithMetadata.from_json(i)
            for i in json["urlsWithMetadata"]
        ]
        if json.get("urlsWithMetadata", None) is not None
        else None,
        urn_uuid=str(json["urnUuid"])
        if json.get("urnUuid", None) is not None
        else None,
        key=str(json["key"]) if json.get("key", None) is not None else None,
        value=str(json["value"]) if json.get("value", None) is not None else None,
        ignore_if_present=bool(json["ignoreIfPresent"])
        if json.get("ignoreIfPresent", None) is not None
        else None,
        worklet_ordinal=int(json["workletOrdinal"])
        if json.get("workletOrdinal", None) is not None
        else None,
        worklet_target_id=target.TargetID.from_json(json["workletTargetId"])
        if json.get("workletTargetId", None) is not None
        else None,
        with_lock=str(json["withLock"])
        if json.get("withLock", None) is not None
        else None,
        batch_update_id=str(json["batchUpdateId"])
        if json.get("batchUpdateId", None) is not None
        else None,
        batch_size=int(json["batchSize"])
        if json.get("batchSize", None) is not None
        else None,
    )

to_json()

Source code in zendriver/cdp/storage.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    if self.script_source_url is not None:
        json["scriptSourceUrl"] = self.script_source_url
    if self.data_origin is not None:
        json["dataOrigin"] = self.data_origin
    if self.operation_name is not None:
        json["operationName"] = self.operation_name
    if self.operation_id is not None:
        json["operationId"] = self.operation_id
    if self.keep_alive is not None:
        json["keepAlive"] = self.keep_alive
    if self.private_aggregation_config is not None:
        json["privateAggregationConfig"] = self.private_aggregation_config.to_json()
    if self.serialized_data is not None:
        json["serializedData"] = self.serialized_data
    if self.urls_with_metadata is not None:
        json["urlsWithMetadata"] = [i.to_json() for i in self.urls_with_metadata]
    if self.urn_uuid is not None:
        json["urnUuid"] = self.urn_uuid
    if self.key is not None:
        json["key"] = self.key
    if self.value is not None:
        json["value"] = self.value
    if self.ignore_if_present is not None:
        json["ignoreIfPresent"] = self.ignore_if_present
    if self.worklet_ordinal is not None:
        json["workletOrdinal"] = self.worklet_ordinal
    if self.worklet_target_id is not None:
        json["workletTargetId"] = self.worklet_target_id.to_json()
    if self.with_lock is not None:
        json["withLock"] = self.with_lock
    if self.batch_update_id is not None:
        json["batchUpdateId"] = self.batch_update_id
    if self.batch_size is not None:
        json["batchSize"] = self.batch_size
    return json

SharedStorageAccessScope

Bases: Enum

Enum of shared storage access scopes.

Source code in zendriver/cdp/storage.py

class SharedStorageAccessScope(enum.Enum):
    """
    Enum of shared storage access scopes.
    """

    WINDOW = "window"
    SHARED_STORAGE_WORKLET = "sharedStorageWorklet"
    PROTECTED_AUDIENCE_WORKLET = "protectedAudienceWorklet"
    HEADER = "header"

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

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

HEADER = 'header' class-attribute instance-attribute

PROTECTED_AUDIENCE_WORKLET = 'protectedAudienceWorklet' class-attribute instance-attribute

SHARED_STORAGE_WORKLET = 'sharedStorageWorklet' class-attribute instance-attribute

WINDOW = 'window' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

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

to_json()

Source code in zendriver/cdp/storage.py

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

SharedStorageAccessed dataclass

Shared storage was accessed by the associated page. The following parameters are included in all events.

Source code in zendriver/cdp/storage.py

@event_class("Storage.sharedStorageAccessed")
@dataclass
class SharedStorageAccessed:
    """
    Shared storage was accessed by the associated page.
    The following parameters are included in all events.
    """

    #: Time of the access.
    access_time: network.TimeSinceEpoch
    #: Enum value indicating the access scope.
    scope: SharedStorageAccessScope
    #: Enum value indicating the Shared Storage API method invoked.
    method: SharedStorageAccessMethod
    #: DevTools Frame Token for the primary frame tree's root.
    main_frame_id: page.FrameId
    #: Serialization of the origin owning the Shared Storage data.
    owner_origin: str
    #: Serialization of the site owning the Shared Storage data.
    owner_site: str
    #: The sub-parameters wrapped by ``params`` are all optional and their
    #: presence/absence depends on ``type``.
    params: SharedStorageAccessParams

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> SharedStorageAccessed:
        return cls(
            access_time=network.TimeSinceEpoch.from_json(json["accessTime"]),
            scope=SharedStorageAccessScope.from_json(json["scope"]),
            method=SharedStorageAccessMethod.from_json(json["method"]),
            main_frame_id=page.FrameId.from_json(json["mainFrameId"]),
            owner_origin=str(json["ownerOrigin"]),
            owner_site=str(json["ownerSite"]),
            params=SharedStorageAccessParams.from_json(json["params"]),
        )

access_time: network.TimeSinceEpoch instance-attribute

main_frame_id: page.FrameId instance-attribute

method: SharedStorageAccessMethod instance-attribute

owner_origin: str instance-attribute

owner_site: str instance-attribute

params: SharedStorageAccessParams instance-attribute

scope: SharedStorageAccessScope instance-attribute

__init__(access_time, scope, method, main_frame_id, owner_origin, owner_site, params)

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> SharedStorageAccessed:
    return cls(
        access_time=network.TimeSinceEpoch.from_json(json["accessTime"]),
        scope=SharedStorageAccessScope.from_json(json["scope"]),
        method=SharedStorageAccessMethod.from_json(json["method"]),
        main_frame_id=page.FrameId.from_json(json["mainFrameId"]),
        owner_origin=str(json["ownerOrigin"]),
        owner_site=str(json["ownerSite"]),
        params=SharedStorageAccessParams.from_json(json["params"]),
    )

SharedStorageEntry dataclass

Struct for a single key-value pair in an origin's shared storage.

Source code in zendriver/cdp/storage.py

@dataclass
class SharedStorageEntry:
    """
    Struct for a single key-value pair in an origin's shared storage.
    """

    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) -> SharedStorageEntry:
        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/storage.py

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

to_json()

Source code in zendriver/cdp/storage.py

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

SharedStorageMetadata dataclass

Details for an origin's shared storage.

Source code in zendriver/cdp/storage.py

@dataclass
class SharedStorageMetadata:
    """
    Details for an origin's shared storage.
    """

    #: Time when the origin's shared storage was last created.
    creation_time: network.TimeSinceEpoch

    #: Number of key-value pairs stored in origin's shared storage.
    length: int

    #: Current amount of bits of entropy remaining in the navigation budget.
    remaining_budget: float

    #: Total number of bytes stored as key-value pairs in origin's shared
    #: storage.
    bytes_used: int

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["creationTime"] = self.creation_time.to_json()
        json["length"] = self.length
        json["remainingBudget"] = self.remaining_budget
        json["bytesUsed"] = self.bytes_used
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> SharedStorageMetadata:
        return cls(
            creation_time=network.TimeSinceEpoch.from_json(json["creationTime"]),
            length=int(json["length"]),
            remaining_budget=float(json["remainingBudget"]),
            bytes_used=int(json["bytesUsed"]),
        )

bytes_used: int instance-attribute

creation_time: network.TimeSinceEpoch instance-attribute

length: int instance-attribute

remaining_budget: float instance-attribute

__init__(creation_time, length, remaining_budget, bytes_used)

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> SharedStorageMetadata:
    return cls(
        creation_time=network.TimeSinceEpoch.from_json(json["creationTime"]),
        length=int(json["length"]),
        remaining_budget=float(json["remainingBudget"]),
        bytes_used=int(json["bytesUsed"]),
    )

to_json()

Source code in zendriver/cdp/storage.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["creationTime"] = self.creation_time.to_json()
    json["length"] = self.length
    json["remainingBudget"] = self.remaining_budget
    json["bytesUsed"] = self.bytes_used
    return json

SharedStoragePrivateAggregationConfig dataclass

Represents a dictionary object passed in as privateAggregationConfig to run or selectURL.

Source code in zendriver/cdp/storage.py

@dataclass
class SharedStoragePrivateAggregationConfig:
    """
    Represents a dictionary object passed in as privateAggregationConfig to
    run or selectURL.
    """

    #: Configures the maximum size allowed for filtering IDs.
    filtering_id_max_bytes: int

    #: The chosen aggregation service deployment.
    aggregation_coordinator_origin: typing.Optional[str] = None

    #: The context ID provided.
    context_id: typing.Optional[str] = None

    #: The limit on the number of contributions in the final report.
    max_contributions: typing.Optional[int] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["filteringIdMaxBytes"] = self.filtering_id_max_bytes
        if self.aggregation_coordinator_origin is not None:
            json["aggregationCoordinatorOrigin"] = self.aggregation_coordinator_origin
        if self.context_id is not None:
            json["contextId"] = self.context_id
        if self.max_contributions is not None:
            json["maxContributions"] = self.max_contributions
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> SharedStoragePrivateAggregationConfig:
        return cls(
            filtering_id_max_bytes=int(json["filteringIdMaxBytes"]),
            aggregation_coordinator_origin=str(json["aggregationCoordinatorOrigin"])
            if json.get("aggregationCoordinatorOrigin", None) is not None
            else None,
            context_id=str(json["contextId"])
            if json.get("contextId", None) is not None
            else None,
            max_contributions=int(json["maxContributions"])
            if json.get("maxContributions", None) is not None
            else None,
        )

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

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

filtering_id_max_bytes: int instance-attribute

max_contributions: typing.Optional[int] = None class-attribute instance-attribute

__init__(filtering_id_max_bytes, aggregation_coordinator_origin=None, context_id=None, max_contributions=None)

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> SharedStoragePrivateAggregationConfig:
    return cls(
        filtering_id_max_bytes=int(json["filteringIdMaxBytes"]),
        aggregation_coordinator_origin=str(json["aggregationCoordinatorOrigin"])
        if json.get("aggregationCoordinatorOrigin", None) is not None
        else None,
        context_id=str(json["contextId"])
        if json.get("contextId", None) is not None
        else None,
        max_contributions=int(json["maxContributions"])
        if json.get("maxContributions", None) is not None
        else None,
    )

to_json()

Source code in zendriver/cdp/storage.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["filteringIdMaxBytes"] = self.filtering_id_max_bytes
    if self.aggregation_coordinator_origin is not None:
        json["aggregationCoordinatorOrigin"] = self.aggregation_coordinator_origin
    if self.context_id is not None:
        json["contextId"] = self.context_id
    if self.max_contributions is not None:
        json["maxContributions"] = self.max_contributions
    return json

SharedStorageReportingMetadata dataclass

Pair of reporting metadata details for a candidate URL for selectURL().

Source code in zendriver/cdp/storage.py

@dataclass
class SharedStorageReportingMetadata:
    """
    Pair of reporting metadata details for a candidate URL for ``selectURL()``.
    """

    event_type: str

    reporting_url: str

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["eventType"] = self.event_type
        json["reportingUrl"] = self.reporting_url
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> SharedStorageReportingMetadata:
        return cls(
            event_type=str(json["eventType"]),
            reporting_url=str(json["reportingUrl"]),
        )

event_type: str instance-attribute

reporting_url: str instance-attribute

__init__(event_type, reporting_url)

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> SharedStorageReportingMetadata:
    return cls(
        event_type=str(json["eventType"]),
        reporting_url=str(json["reportingUrl"]),
    )

to_json()

Source code in zendriver/cdp/storage.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["eventType"] = self.event_type
    json["reportingUrl"] = self.reporting_url
    return json

SharedStorageUrlWithMetadata dataclass

Bundles a candidate URL with its reporting metadata.

Source code in zendriver/cdp/storage.py

@dataclass
class SharedStorageUrlWithMetadata:
    """
    Bundles a candidate URL with its reporting metadata.
    """

    #: Spec of candidate URL.
    url: str

    #: Any associated reporting metadata.
    reporting_metadata: typing.List[SharedStorageReportingMetadata]

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["url"] = self.url
        json["reportingMetadata"] = [i.to_json() for i in self.reporting_metadata]
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> SharedStorageUrlWithMetadata:
        return cls(
            url=str(json["url"]),
            reporting_metadata=[
                SharedStorageReportingMetadata.from_json(i)
                for i in json["reportingMetadata"]
            ],
        )

reporting_metadata: typing.List[SharedStorageReportingMetadata] instance-attribute

url: str instance-attribute

__init__(url, reporting_metadata)

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> SharedStorageUrlWithMetadata:
    return cls(
        url=str(json["url"]),
        reporting_metadata=[
            SharedStorageReportingMetadata.from_json(i)
            for i in json["reportingMetadata"]
        ],
    )

to_json()

Source code in zendriver/cdp/storage.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["url"] = self.url
    json["reportingMetadata"] = [i.to_json() for i in self.reporting_metadata]
    return json

SharedStorageWorkletOperationExecutionFinished dataclass

A shared storage run or selectURL operation finished its execution. The following parameters are included in all events.

Source code in zendriver/cdp/storage.py

@event_class("Storage.sharedStorageWorkletOperationExecutionFinished")
@dataclass
class SharedStorageWorkletOperationExecutionFinished:
    """
    A shared storage run or selectURL operation finished its execution.
    The following parameters are included in all events.
    """

    #: Time that the operation finished.
    finished_time: network.TimeSinceEpoch
    #: Time, in microseconds, from start of shared storage JS API call until
    #: end of operation execution in the worklet.
    execution_time: int
    #: Enum value indicating the Shared Storage API method invoked.
    method: SharedStorageAccessMethod
    #: ID of the operation call.
    operation_id: str
    #: Hex representation of the DevTools token used as the TargetID for the
    #: associated shared storage worklet.
    worklet_target_id: target.TargetID
    #: DevTools Frame Token for the primary frame tree's root.
    main_frame_id: page.FrameId
    #: Serialization of the origin owning the Shared Storage data.
    owner_origin: str

    @classmethod
    def from_json(
        cls, json: T_JSON_DICT
    ) -> SharedStorageWorkletOperationExecutionFinished:
        return cls(
            finished_time=network.TimeSinceEpoch.from_json(json["finishedTime"]),
            execution_time=int(json["executionTime"]),
            method=SharedStorageAccessMethod.from_json(json["method"]),
            operation_id=str(json["operationId"]),
            worklet_target_id=target.TargetID.from_json(json["workletTargetId"]),
            main_frame_id=page.FrameId.from_json(json["mainFrameId"]),
            owner_origin=str(json["ownerOrigin"]),
        )

execution_time: int instance-attribute

finished_time: network.TimeSinceEpoch instance-attribute

main_frame_id: page.FrameId instance-attribute

method: SharedStorageAccessMethod instance-attribute

operation_id: str instance-attribute

owner_origin: str instance-attribute

worklet_target_id: target.TargetID instance-attribute

__init__(finished_time, execution_time, method, operation_id, worklet_target_id, main_frame_id, owner_origin)

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

@classmethod
def from_json(
    cls, json: T_JSON_DICT
) -> SharedStorageWorkletOperationExecutionFinished:
    return cls(
        finished_time=network.TimeSinceEpoch.from_json(json["finishedTime"]),
        execution_time=int(json["executionTime"]),
        method=SharedStorageAccessMethod.from_json(json["method"]),
        operation_id=str(json["operationId"]),
        worklet_target_id=target.TargetID.from_json(json["workletTargetId"]),
        main_frame_id=page.FrameId.from_json(json["mainFrameId"]),
        owner_origin=str(json["ownerOrigin"]),
    )

StorageBucket dataclass

Source code in zendriver/cdp/storage.py

@dataclass
class StorageBucket:
    storage_key: SerializedStorageKey

    #: If not specified, it is the default bucket of the storageKey.
    name: typing.Optional[str] = None

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

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> StorageBucket:
        return cls(
            storage_key=SerializedStorageKey.from_json(json["storageKey"]),
            name=str(json["name"]) if json.get("name", None) is not None else None,
        )

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

storage_key: SerializedStorageKey instance-attribute

__init__(storage_key, name=None)

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> StorageBucket:
    return cls(
        storage_key=SerializedStorageKey.from_json(json["storageKey"]),
        name=str(json["name"]) if json.get("name", None) is not None else None,
    )

to_json()

Source code in zendriver/cdp/storage.py

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

StorageBucketCreatedOrUpdated dataclass

Source code in zendriver/cdp/storage.py

@event_class("Storage.storageBucketCreatedOrUpdated")
@dataclass
class StorageBucketCreatedOrUpdated:
    bucket_info: StorageBucketInfo

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> StorageBucketCreatedOrUpdated:
        return cls(bucket_info=StorageBucketInfo.from_json(json["bucketInfo"]))

bucket_info: StorageBucketInfo instance-attribute

__init__(bucket_info)

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> StorageBucketCreatedOrUpdated:
    return cls(bucket_info=StorageBucketInfo.from_json(json["bucketInfo"]))

StorageBucketDeleted dataclass

Source code in zendriver/cdp/storage.py

@event_class("Storage.storageBucketDeleted")
@dataclass
class StorageBucketDeleted:
    bucket_id: str

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> StorageBucketDeleted:
        return cls(bucket_id=str(json["bucketId"]))

bucket_id: str instance-attribute

__init__(bucket_id)

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> StorageBucketDeleted:
    return cls(bucket_id=str(json["bucketId"]))

StorageBucketInfo dataclass

Source code in zendriver/cdp/storage.py

@dataclass
class StorageBucketInfo:
    bucket: StorageBucket

    id_: str

    expiration: network.TimeSinceEpoch

    #: Storage quota (bytes).
    quota: float

    persistent: bool

    durability: StorageBucketsDurability

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["bucket"] = self.bucket.to_json()
        json["id"] = self.id_
        json["expiration"] = self.expiration.to_json()
        json["quota"] = self.quota
        json["persistent"] = self.persistent
        json["durability"] = self.durability.to_json()
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> StorageBucketInfo:
        return cls(
            bucket=StorageBucket.from_json(json["bucket"]),
            id_=str(json["id"]),
            expiration=network.TimeSinceEpoch.from_json(json["expiration"]),
            quota=float(json["quota"]),
            persistent=bool(json["persistent"]),
            durability=StorageBucketsDurability.from_json(json["durability"]),
        )

bucket: StorageBucket instance-attribute

durability: StorageBucketsDurability instance-attribute

expiration: network.TimeSinceEpoch instance-attribute

id_: str instance-attribute

persistent: bool instance-attribute

quota: float instance-attribute

__init__(bucket, id_, expiration, quota, persistent, durability)

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> StorageBucketInfo:
    return cls(
        bucket=StorageBucket.from_json(json["bucket"]),
        id_=str(json["id"]),
        expiration=network.TimeSinceEpoch.from_json(json["expiration"]),
        quota=float(json["quota"]),
        persistent=bool(json["persistent"]),
        durability=StorageBucketsDurability.from_json(json["durability"]),
    )

to_json()

Source code in zendriver/cdp/storage.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["bucket"] = self.bucket.to_json()
    json["id"] = self.id_
    json["expiration"] = self.expiration.to_json()
    json["quota"] = self.quota
    json["persistent"] = self.persistent
    json["durability"] = self.durability.to_json()
    return json

StorageBucketsDurability

Bases: Enum

Source code in zendriver/cdp/storage.py

class StorageBucketsDurability(enum.Enum):
    RELAXED = "relaxed"
    STRICT = "strict"

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

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

RELAXED = 'relaxed' class-attribute instance-attribute

STRICT = 'strict' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

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

to_json()

Source code in zendriver/cdp/storage.py

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

StorageType

Bases: Enum

Enum of possible storage types.

Source code in zendriver/cdp/storage.py

class StorageType(enum.Enum):
    """
    Enum of possible storage types.
    """

    COOKIES = "cookies"
    FILE_SYSTEMS = "file_systems"
    INDEXEDDB = "indexeddb"
    LOCAL_STORAGE = "local_storage"
    SHADER_CACHE = "shader_cache"
    WEBSQL = "websql"
    SERVICE_WORKERS = "service_workers"
    CACHE_STORAGE = "cache_storage"
    INTEREST_GROUPS = "interest_groups"
    SHARED_STORAGE = "shared_storage"
    STORAGE_BUCKETS = "storage_buckets"
    ALL_ = "all"
    OTHER = "other"

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

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

ALL_ = 'all' class-attribute instance-attribute

CACHE_STORAGE = 'cache_storage' class-attribute instance-attribute

COOKIES = 'cookies' class-attribute instance-attribute

FILE_SYSTEMS = 'file_systems' class-attribute instance-attribute

INDEXEDDB = 'indexeddb' class-attribute instance-attribute

INTEREST_GROUPS = 'interest_groups' class-attribute instance-attribute

LOCAL_STORAGE = 'local_storage' class-attribute instance-attribute

OTHER = 'other' class-attribute instance-attribute

SERVICE_WORKERS = 'service_workers' class-attribute instance-attribute

SHADER_CACHE = 'shader_cache' class-attribute instance-attribute

SHARED_STORAGE = 'shared_storage' class-attribute instance-attribute

STORAGE_BUCKETS = 'storage_buckets' class-attribute instance-attribute

WEBSQL = 'websql' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

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

to_json()

Source code in zendriver/cdp/storage.py

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

TrustTokens dataclass

Pair of issuer origin and number of available (signed, but not used) Trust Tokens from that issuer.

Source code in zendriver/cdp/storage.py

@dataclass
class TrustTokens:
    """
    Pair of issuer origin and number of available (signed, but not used) Trust
    Tokens from that issuer.
    """

    issuer_origin: str

    count: float

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["issuerOrigin"] = self.issuer_origin
        json["count"] = self.count
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> TrustTokens:
        return cls(
            issuer_origin=str(json["issuerOrigin"]),
            count=float(json["count"]),
        )

count: float instance-attribute

issuer_origin: str instance-attribute

__init__(issuer_origin, count)

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> TrustTokens:
    return cls(
        issuer_origin=str(json["issuerOrigin"]),
        count=float(json["count"]),
    )

to_json()

Source code in zendriver/cdp/storage.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["issuerOrigin"] = self.issuer_origin
    json["count"] = self.count
    return json

UsageForType dataclass

Usage for a storage type.

Source code in zendriver/cdp/storage.py

@dataclass
class UsageForType:
    """
    Usage for a storage type.
    """

    #: Name of storage type.
    storage_type: StorageType

    #: Storage usage (bytes).
    usage: float

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["storageType"] = self.storage_type.to_json()
        json["usage"] = self.usage
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> UsageForType:
        return cls(
            storage_type=StorageType.from_json(json["storageType"]),
            usage=float(json["usage"]),
        )

storage_type: StorageType instance-attribute

usage: float instance-attribute

__init__(storage_type, usage)

from_json(json) classmethod

Source code in zendriver/cdp/storage.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> UsageForType:
    return cls(
        storage_type=StorageType.from_json(json["storageType"]),
        usage=float(json["usage"]),
    )

to_json()

Source code in zendriver/cdp/storage.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["storageType"] = self.storage_type.to_json()
    json["usage"] = self.usage
    return json

clear_cookies(browser_context_id=None)

Clears cookies.

Parameters:

Name	Type	Description	Default
browser_context_id	Optional[BrowserContextID]	(Optional) Browser context to use when called on the browser endpoint.	None

Source code in zendriver/cdp/storage.py

def clear_cookies(
    browser_context_id: typing.Optional[browser.BrowserContextID] = None,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Clears cookies.

    :param browser_context_id: *(Optional)* Browser context to use when called on the browser endpoint.
    """
    params: T_JSON_DICT = dict()
    if browser_context_id is not None:
        params["browserContextId"] = browser_context_id.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.clearCookies",
        "params": params,
    }
    json = yield cmd_dict

clear_data_for_origin(origin, storage_types)

Clears storage for origin.

Parameters:

Name	Type	Description	Default
origin	str	Security origin.	required
storage_types	str	Comma separated list of StorageType to clear.	required

Source code in zendriver/cdp/storage.py

def clear_data_for_origin(
    origin: str, storage_types: str
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Clears storage for origin.

    :param origin: Security origin.
    :param storage_types: Comma separated list of StorageType to clear.
    """
    params: T_JSON_DICT = dict()
    params["origin"] = origin
    params["storageTypes"] = storage_types
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.clearDataForOrigin",
        "params": params,
    }
    json = yield cmd_dict

clear_data_for_storage_key(storage_key, storage_types)

Clears storage for storage key.

Parameters:

Name	Type	Description	Default
storage_key	str	Storage key.	required
storage_types	str	Comma separated list of StorageType to clear.	required

Source code in zendriver/cdp/storage.py

def clear_data_for_storage_key(
    storage_key: str, storage_types: str
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Clears storage for storage key.

    :param storage_key: Storage key.
    :param storage_types: Comma separated list of StorageType to clear.
    """
    params: T_JSON_DICT = dict()
    params["storageKey"] = storage_key
    params["storageTypes"] = storage_types
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.clearDataForStorageKey",
        "params": params,
    }
    json = yield cmd_dict

clear_shared_storage_entries(owner_origin)

Clears all entries for a given origin's shared storage.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
owner_origin	str		required

Source code in zendriver/cdp/storage.py

def clear_shared_storage_entries(
    owner_origin: str,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Clears all entries for a given origin's shared storage.

    **EXPERIMENTAL**

    :param owner_origin:
    """
    params: T_JSON_DICT = dict()
    params["ownerOrigin"] = owner_origin
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.clearSharedStorageEntries",
        "params": params,
    }
    json = yield cmd_dict

clear_trust_tokens(issuer_origin)

Removes all Trust Tokens issued by the provided issuerOrigin. Leaves other stored data, including the issuer's Redemption Records, intact.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
issuer_origin	str		required

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, bool]	True if any tokens were deleted, false otherwise.

Source code in zendriver/cdp/storage.py

def clear_trust_tokens(
    issuer_origin: str,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, bool]:
    """
    Removes all Trust Tokens issued by the provided issuerOrigin.
    Leaves other stored data, including the issuer's Redemption Records, intact.

    **EXPERIMENTAL**

    :param issuer_origin:
    :returns: True if any tokens were deleted, false otherwise.
    """
    params: T_JSON_DICT = dict()
    params["issuerOrigin"] = issuer_origin
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.clearTrustTokens",
        "params": params,
    }
    json = yield cmd_dict
    return bool(json["didDeleteTokens"])

delete_shared_storage_entry(owner_origin, key)

Deletes entry for key (if it exists) for a given origin's shared storage.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
owner_origin	str		required
key	str		required

Source code in zendriver/cdp/storage.py

def delete_shared_storage_entry(
    owner_origin: str, key: str
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Deletes entry for ``key`` (if it exists) for a given origin's shared storage.

    **EXPERIMENTAL**

    :param owner_origin:
    :param key:
    """
    params: T_JSON_DICT = dict()
    params["ownerOrigin"] = owner_origin
    params["key"] = key
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.deleteSharedStorageEntry",
        "params": params,
    }
    json = yield cmd_dict

delete_storage_bucket(bucket)

Deletes the Storage Bucket with the given storage key and bucket name.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
bucket	StorageBucket		required

Source code in zendriver/cdp/storage.py

def delete_storage_bucket(
    bucket: StorageBucket,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Deletes the Storage Bucket with the given storage key and bucket name.

    **EXPERIMENTAL**

    :param bucket:
    """
    params: T_JSON_DICT = dict()
    params["bucket"] = bucket.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.deleteStorageBucket",
        "params": params,
    }
    json = yield cmd_dict

get_cookies(browser_context_id=None)

Returns all browser cookies.

Parameters:

Name	Type	Description	Default
browser_context_id	Optional[BrowserContextID]	(Optional) Browser context to use when called on the browser endpoint.	None

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, List[Cookie]]	Array of cookie objects.

Source code in zendriver/cdp/storage.py

def get_cookies(
    browser_context_id: typing.Optional[browser.BrowserContextID] = None,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, typing.List[network.Cookie]]:
    """
    Returns all browser cookies.

    :param browser_context_id: *(Optional)* Browser context to use when called on the browser endpoint.
    :returns: Array of cookie objects.
    """
    params: T_JSON_DICT = dict()
    if browser_context_id is not None:
        params["browserContextId"] = browser_context_id.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.getCookies",
        "params": params,
    }
    json = yield cmd_dict
    return [network.Cookie.from_json(i) for i in json["cookies"]]

get_interest_group_details(owner_origin, name)

Gets details for a named interest group.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
owner_origin	str		required
name	str		required

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, dict]	This largely corresponds to: https://wicg.github.io/turtledove/#dictdef-generatebidinterestgroup but has absolute expirationTime instead of relative lifetimeMs and also adds joiningOrigin.

Source code in zendriver/cdp/storage.py

def get_interest_group_details(
    owner_origin: str, name: str
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, dict]:
    """
    Gets details for a named interest group.

    **EXPERIMENTAL**

    :param owner_origin:
    :param name:
    :returns: This largely corresponds to: https://wicg.github.io/turtledove/#dictdef-generatebidinterestgroup but has absolute expirationTime instead of relative lifetimeMs and also adds joiningOrigin.
    """
    params: T_JSON_DICT = dict()
    params["ownerOrigin"] = owner_origin
    params["name"] = name
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.getInterestGroupDetails",
        "params": params,
    }
    json = yield cmd_dict
    return dict(json["details"])

get_related_website_sets()

Returns the effective Related Website Sets in use by this profile for the browser session. The effective Related Website Sets will not change during a browser session.

EXPERIMENTAL

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, List[RelatedWebsiteSet]]

Source code in zendriver/cdp/storage.py

def get_related_website_sets() -> (
    typing.Generator[T_JSON_DICT, T_JSON_DICT, typing.List[RelatedWebsiteSet]]
):
    """
    Returns the effective Related Website Sets in use by this profile for the browser
    session. The effective Related Website Sets will not change during a browser session.

    **EXPERIMENTAL**

    :returns:
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.getRelatedWebsiteSets",
    }
    json = yield cmd_dict
    return [RelatedWebsiteSet.from_json(i) for i in json["sets"]]

get_shared_storage_entries(owner_origin)

Gets the entries in an given origin's shared storage.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
owner_origin	str		required

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, List[SharedStorageEntry]]

Source code in zendriver/cdp/storage.py

def get_shared_storage_entries(
    owner_origin: str,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, typing.List[SharedStorageEntry]]:
    """
    Gets the entries in an given origin's shared storage.

    **EXPERIMENTAL**

    :param owner_origin:
    :returns:
    """
    params: T_JSON_DICT = dict()
    params["ownerOrigin"] = owner_origin
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.getSharedStorageEntries",
        "params": params,
    }
    json = yield cmd_dict
    return [SharedStorageEntry.from_json(i) for i in json["entries"]]

get_shared_storage_metadata(owner_origin)

Gets metadata for an origin's shared storage.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
owner_origin	str		required

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, SharedStorageMetadata]

Source code in zendriver/cdp/storage.py

def get_shared_storage_metadata(
    owner_origin: str,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, SharedStorageMetadata]:
    """
    Gets metadata for an origin's shared storage.

    **EXPERIMENTAL**

    :param owner_origin:
    :returns:
    """
    params: T_JSON_DICT = dict()
    params["ownerOrigin"] = owner_origin
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.getSharedStorageMetadata",
        "params": params,
    }
    json = yield cmd_dict
    return SharedStorageMetadata.from_json(json["metadata"])

get_storage_key(frame_id=None)

Returns storage key for the given frame. If no frame ID is provided, the storage key of the target executing this command is returned.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
frame_id	Optional[FrameId]	(Optional)	None

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, SerializedStorageKey]

Source code in zendriver/cdp/storage.py

def get_storage_key(
    frame_id: typing.Optional[page.FrameId] = None,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, SerializedStorageKey]:
    """
    Returns storage key for the given frame. If no frame ID is provided,
    the storage key of the target executing this command is returned.

    **EXPERIMENTAL**

    :param frame_id: *(Optional)*
    :returns:
    """
    params: T_JSON_DICT = dict()
    if frame_id is not None:
        params["frameId"] = frame_id.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.getStorageKey",
        "params": params,
    }
    json = yield cmd_dict
    return SerializedStorageKey.from_json(json["storageKey"])

get_storage_key_for_frame(frame_id)

Returns a storage key given a frame id. Deprecated. Please use Storage.getStorageKey instead.

.. deprecated:: 1.3

Parameters:

Name	Type	Description	Default
frame_id	FrameId		required

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, SerializedStorageKey]

Source code in zendriver/cdp/storage.py

@deprecated(version="1.3")
def get_storage_key_for_frame(
    frame_id: page.FrameId,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, SerializedStorageKey]:
    """
    Returns a storage key given a frame id.
    Deprecated. Please use Storage.getStorageKey instead.

    .. deprecated:: 1.3

    :param frame_id:
    :returns:
    """
    params: T_JSON_DICT = dict()
    params["frameId"] = frame_id.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.getStorageKeyForFrame",
        "params": params,
    }
    json = yield cmd_dict
    return SerializedStorageKey.from_json(json["storageKey"])

get_trust_tokens()

Returns the number of stored Trust Tokens per issuer for the current browsing context.

EXPERIMENTAL

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, List[TrustTokens]]

Source code in zendriver/cdp/storage.py

def get_trust_tokens() -> (
    typing.Generator[T_JSON_DICT, T_JSON_DICT, typing.List[TrustTokens]]
):
    """
    Returns the number of stored Trust Tokens per issuer for the
    current browsing context.

    **EXPERIMENTAL**

    :returns:
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.getTrustTokens",
    }
    json = yield cmd_dict
    return [TrustTokens.from_json(i) for i in json["tokens"]]

get_usage_and_quota(origin)

Returns usage and quota in bytes.

Parameters:

Name	Type	Description	Default
origin	str	Security origin.	required

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, Tuple[float, float, bool, List[UsageForType]]]	A tuple with the following items: 0. usage - Storage usage (bytes). 1. quota - Storage quota (bytes). 2. overrideActive - Whether or not the origin has an active storage quota override 3. usageBreakdown - Storage usage per type (bytes).

Source code in zendriver/cdp/storage.py

def get_usage_and_quota(
    origin: str,
) -> typing.Generator[
    T_JSON_DICT,
    T_JSON_DICT,
    typing.Tuple[float, float, bool, typing.List[UsageForType]],
]:
    """
    Returns usage and quota in bytes.

    :param origin: Security origin.
    :returns: A tuple with the following items:

        0. **usage** - Storage usage (bytes).
        1. **quota** - Storage quota (bytes).
        2. **overrideActive** - Whether or not the origin has an active storage quota override
        3. **usageBreakdown** - Storage usage per type (bytes).
    """
    params: T_JSON_DICT = dict()
    params["origin"] = origin
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.getUsageAndQuota",
        "params": params,
    }
    json = yield cmd_dict
    return (
        float(json["usage"]),
        float(json["quota"]),
        bool(json["overrideActive"]),
        [UsageForType.from_json(i) for i in json["usageBreakdown"]],
    )

override_quota_for_origin(origin, quota_size=None)

Override quota for the specified origin

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
origin	str	Security origin.	required
quota_size	Optional[float]	(Optional) The quota size (in bytes) to override the original quota with. If this is called multiple times, the overridden quota will be equal to the quotaSize provided in the final call. If this is called without specifying a quotaSize, the quota will be reset to the default value for the specified origin. If this is called multiple times with different origins, the override will be maintained for each origin until it is disabled (called without a quotaSize).	None

Source code in zendriver/cdp/storage.py

def override_quota_for_origin(
    origin: str, quota_size: typing.Optional[float] = None
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Override quota for the specified origin

    **EXPERIMENTAL**

    :param origin: Security origin.
    :param quota_size: *(Optional)* The quota size (in bytes) to override the original quota with. If this is called multiple times, the overridden quota will be equal to the quotaSize provided in the final call. If this is called without specifying a quotaSize, the quota will be reset to the default value for the specified origin. If this is called multiple times with different origins, the override will be maintained for each origin until it is disabled (called without a quotaSize).
    """
    params: T_JSON_DICT = dict()
    params["origin"] = origin
    if quota_size is not None:
        params["quotaSize"] = quota_size
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.overrideQuotaForOrigin",
        "params": params,
    }
    json = yield cmd_dict

reset_shared_storage_budget(owner_origin)

Resets the budget for ownerOrigin by clearing all budget withdrawals.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
owner_origin	str		required

Source code in zendriver/cdp/storage.py

def reset_shared_storage_budget(
    owner_origin: str,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Resets the budget for ``ownerOrigin`` by clearing all budget withdrawals.

    **EXPERIMENTAL**

    :param owner_origin:
    """
    params: T_JSON_DICT = dict()
    params["ownerOrigin"] = owner_origin
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.resetSharedStorageBudget",
        "params": params,
    }
    json = yield cmd_dict

run_bounce_tracking_mitigations()

Deletes state for sites identified as potential bounce trackers, immediately.

EXPERIMENTAL

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, List[str]]

Source code in zendriver/cdp/storage.py

def run_bounce_tracking_mitigations() -> (
    typing.Generator[T_JSON_DICT, T_JSON_DICT, typing.List[str]]
):
    """
    Deletes state for sites identified as potential bounce trackers, immediately.

    **EXPERIMENTAL**

    :returns:
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.runBounceTrackingMitigations",
    }
    json = yield cmd_dict
    return [str(i) for i in json["deletedSites"]]

set_cookies(cookies, browser_context_id=None)

Sets given cookies.

Parameters:

Name	Type	Description	Default
cookies	List[CookieParam]	Cookies to be set.	required
browser_context_id	Optional[BrowserContextID]	(Optional) Browser context to use when called on the browser endpoint.	None

Source code in zendriver/cdp/storage.py

def set_cookies(
    cookies: typing.List[network.CookieParam],
    browser_context_id: typing.Optional[browser.BrowserContextID] = None,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Sets given cookies.

    :param cookies: Cookies to be set.
    :param browser_context_id: *(Optional)* Browser context to use when called on the browser endpoint.
    """
    params: T_JSON_DICT = dict()
    params["cookies"] = [i.to_json() for i in cookies]
    if browser_context_id is not None:
        params["browserContextId"] = browser_context_id.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.setCookies",
        "params": params,
    }
    json = yield cmd_dict

set_interest_group_auction_tracking(enable)

Enables/Disables issuing of interestGroupAuctionEventOccurred and interestGroupAuctionNetworkRequestCreated.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
enable	bool		required

Source code in zendriver/cdp/storage.py

def set_interest_group_auction_tracking(
    enable: bool,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Enables/Disables issuing of interestGroupAuctionEventOccurred and
    interestGroupAuctionNetworkRequestCreated.

    **EXPERIMENTAL**

    :param enable:
    """
    params: T_JSON_DICT = dict()
    params["enable"] = enable
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.setInterestGroupAuctionTracking",
        "params": params,
    }
    json = yield cmd_dict

set_interest_group_tracking(enable)

Enables/Disables issuing of interestGroupAccessed events.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
enable	bool		required

Source code in zendriver/cdp/storage.py

def set_interest_group_tracking(
    enable: bool,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Enables/Disables issuing of interestGroupAccessed events.

    **EXPERIMENTAL**

    :param enable:
    """
    params: T_JSON_DICT = dict()
    params["enable"] = enable
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.setInterestGroupTracking",
        "params": params,
    }
    json = yield cmd_dict

set_protected_audience_k_anonymity(owner, name, hashes)

Parameters:

Name	Type	Description	Default
owner	str		required
name	str		required
hashes	List[str]		required

Source code in zendriver/cdp/storage.py

def set_protected_audience_k_anonymity(
    owner: str, name: str, hashes: typing.List[str]
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    :param owner:
    :param name:
    :param hashes:
    """
    params: T_JSON_DICT = dict()
    params["owner"] = owner
    params["name"] = name
    params["hashes"] = [i for i in hashes]
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.setProtectedAudienceKAnonymity",
        "params": params,
    }
    json = yield cmd_dict

set_shared_storage_entry(owner_origin, key, value, ignore_if_present=None)

Sets entry with key and value for a given origin's shared storage.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
owner_origin	str		required
key	str		required
value	str		required
ignore_if_present	Optional[bool]	(Optional) If ignoreIfPresent```` is included and true, then only sets the entry if ````key doesn't already exist.	None

Source code in zendriver/cdp/storage.py

def set_shared_storage_entry(
    owner_origin: str,
    key: str,
    value: str,
    ignore_if_present: typing.Optional[bool] = None,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Sets entry with ``key`` and ``value`` for a given origin's shared storage.

    **EXPERIMENTAL**

    :param owner_origin:
    :param key:
    :param value:
    :param ignore_if_present: *(Optional)* If ```ignoreIfPresent```` is included and true, then only sets the entry if ````key``` doesn't already exist.
    """
    params: T_JSON_DICT = dict()
    params["ownerOrigin"] = owner_origin
    params["key"] = key
    params["value"] = value
    if ignore_if_present is not None:
        params["ignoreIfPresent"] = ignore_if_present
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.setSharedStorageEntry",
        "params": params,
    }
    json = yield cmd_dict

set_shared_storage_tracking(enable)

Enables/disables issuing of sharedStorageAccessed events.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
enable	bool		required

Source code in zendriver/cdp/storage.py

def set_shared_storage_tracking(
    enable: bool,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Enables/disables issuing of sharedStorageAccessed events.

    **EXPERIMENTAL**

    :param enable:
    """
    params: T_JSON_DICT = dict()
    params["enable"] = enable
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.setSharedStorageTracking",
        "params": params,
    }
    json = yield cmd_dict

set_storage_bucket_tracking(storage_key, enable)

Set tracking for a storage key's buckets.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
storage_key	str		required
enable	bool		required

Source code in zendriver/cdp/storage.py

def set_storage_bucket_tracking(
    storage_key: str, enable: bool
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Set tracking for a storage key's buckets.

    **EXPERIMENTAL**

    :param storage_key:
    :param enable:
    """
    params: T_JSON_DICT = dict()
    params["storageKey"] = storage_key
    params["enable"] = enable
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.setStorageBucketTracking",
        "params": params,
    }
    json = yield cmd_dict

track_cache_storage_for_origin(origin)

Registers origin to be notified when an update occurs to its cache storage list.

Parameters:

Name	Type	Description	Default
origin	str	Security origin.	required

Source code in zendriver/cdp/storage.py

def track_cache_storage_for_origin(
    origin: str,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Registers origin to be notified when an update occurs to its cache storage list.

    :param origin: Security origin.
    """
    params: T_JSON_DICT = dict()
    params["origin"] = origin
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.trackCacheStorageForOrigin",
        "params": params,
    }
    json = yield cmd_dict

track_cache_storage_for_storage_key(storage_key)

Registers storage key to be notified when an update occurs to its cache storage list.

Parameters:

Name	Type	Description	Default
storage_key	str	Storage key.	required

Source code in zendriver/cdp/storage.py

def track_cache_storage_for_storage_key(
    storage_key: str,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Registers storage key to be notified when an update occurs to its cache storage list.

    :param storage_key: Storage key.
    """
    params: T_JSON_DICT = dict()
    params["storageKey"] = storage_key
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.trackCacheStorageForStorageKey",
        "params": params,
    }
    json = yield cmd_dict

track_indexed_db_for_origin(origin)

Registers origin to be notified when an update occurs to its IndexedDB.

Parameters:

Name	Type	Description	Default
origin	str	Security origin.	required

Source code in zendriver/cdp/storage.py

def track_indexed_db_for_origin(
    origin: str,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Registers origin to be notified when an update occurs to its IndexedDB.

    :param origin: Security origin.
    """
    params: T_JSON_DICT = dict()
    params["origin"] = origin
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.trackIndexedDBForOrigin",
        "params": params,
    }
    json = yield cmd_dict

track_indexed_db_for_storage_key(storage_key)

Registers storage key to be notified when an update occurs to its IndexedDB.

Parameters:

Name	Type	Description	Default
storage_key	str	Storage key.	required

Source code in zendriver/cdp/storage.py

def track_indexed_db_for_storage_key(
    storage_key: str,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Registers storage key to be notified when an update occurs to its IndexedDB.

    :param storage_key: Storage key.
    """
    params: T_JSON_DICT = dict()
    params["storageKey"] = storage_key
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.trackIndexedDBForStorageKey",
        "params": params,
    }
    json = yield cmd_dict

untrack_cache_storage_for_origin(origin)

Unregisters origin from receiving notifications for cache storage.

Parameters:

Name	Type	Description	Default
origin	str	Security origin.	required

Source code in zendriver/cdp/storage.py

def untrack_cache_storage_for_origin(
    origin: str,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Unregisters origin from receiving notifications for cache storage.

    :param origin: Security origin.
    """
    params: T_JSON_DICT = dict()
    params["origin"] = origin
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.untrackCacheStorageForOrigin",
        "params": params,
    }
    json = yield cmd_dict

untrack_cache_storage_for_storage_key(storage_key)

Unregisters storage key from receiving notifications for cache storage.

Parameters:

Name	Type	Description	Default
storage_key	str	Storage key.	required

Source code in zendriver/cdp/storage.py

def untrack_cache_storage_for_storage_key(
    storage_key: str,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Unregisters storage key from receiving notifications for cache storage.

    :param storage_key: Storage key.
    """
    params: T_JSON_DICT = dict()
    params["storageKey"] = storage_key
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.untrackCacheStorageForStorageKey",
        "params": params,
    }
    json = yield cmd_dict

untrack_indexed_db_for_origin(origin)

Unregisters origin from receiving notifications for IndexedDB.

Parameters:

Name	Type	Description	Default
origin	str	Security origin.	required

Source code in zendriver/cdp/storage.py

def untrack_indexed_db_for_origin(
    origin: str,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Unregisters origin from receiving notifications for IndexedDB.

    :param origin: Security origin.
    """
    params: T_JSON_DICT = dict()
    params["origin"] = origin
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.untrackIndexedDBForOrigin",
        "params": params,
    }
    json = yield cmd_dict

untrack_indexed_db_for_storage_key(storage_key)

Unregisters storage key from receiving notifications for IndexedDB.

Parameters:

Name	Type	Description	Default
storage_key	str	Storage key.	required

Source code in zendriver/cdp/storage.py

def untrack_indexed_db_for_storage_key(
    storage_key: str,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Unregisters storage key from receiving notifications for IndexedDB.

    :param storage_key: Storage key.
    """
    params: T_JSON_DICT = dict()
    params["storageKey"] = storage_key
    cmd_dict: T_JSON_DICT = {
        "method": "Storage.untrackIndexedDBForStorageKey",
        "params": params,
    }
    json = yield cmd_dict