CDPotion.Domain.Storage (cdpotion v0.1.4)
Summary
Types
description not provided :(
description not provided :(
description not provided :(
description not provided :(
description not provided :(
Enum of interest group access types.
Ad advertising element inside an interest group.
The full details of an interest group.
description not provided :(
Bundles the parameters for shared storage access events whose presence/absence can vary according to SharedStorageAccessType.
Enum of shared storage access types.
Struct for a single key-value pair in an origin's shared storage.
Details for an origin's shared storage.
Pair of reporting metadata details for a candidate URL for selectURL()
.
Bundles a candidate URL with its reporting metadata.
description not provided :(
description not provided :(
description not provided :(
description not provided :(
Enum of possible storage types.
Pair of issuer origin and number of available (signed, but not used) Trust Tokens from that issuer.
description not provided :(
description not provided :(
Usage for a storage type.
Functions
Clears cookies.
Clears storage for origin.
Clears storage for storage key.
Clears all entries for a given origin's shared storage.
Removes all Trust Tokens issued by the provided issuerOrigin. Leaves other stored data, including the issuer's Redemption Records, intact.
Deletes entry for key
(if it exists) for a given origin's shared storage.
Deletes the Storage Bucket with the given storage key and bucket name.
Returns all browser cookies.
Gets details for a named interest group.
Gets the entries in an given origin's shared storage.
Gets metadata for an origin's shared storage.
Returns a storage key given a frame id.
Returns the number of stored Trust Tokens per issuer for the current browsing context.
Returns usage and quota in bytes.
Override quota for the specified origin
Resets the budget for ownerOrigin
by clearing all budget withdrawals.
Deletes state for sites identified as potential bounce trackers, immediately.
Enables/disables issuing of Attribution Reporting events.
Sets given cookies.
Enables/Disables issuing of interestGroupAccessed events.
Sets entry with key
and value
for a given origin's shared storage.
Enables/disables issuing of sharedStorageAccessed events.
Set tracking for a storage key's buckets.
Registers origin to be notified when an update occurs to its cache storage list.
Registers storage key to be notified when an update occurs to its cache storage list.
Registers origin to be notified when an update occurs to its IndexedDB.
Registers storage key to be notified when an update occurs to its IndexedDB.
Unregisters origin from receiving notifications for cache storage.
Unregisters storage key from receiving notifications for cache storage.
Unregisters origin from receiving notifications for IndexedDB.
Unregisters storage key from receiving notifications for IndexedDB.
Types
attribution_reporting_aggregation_keys_entry()
@type attribution_reporting_aggregation_keys_entry() :: %{ key: String.t(), value: unsigned_int128_as_base16() }
description not provided :(
attribution_reporting_filter_data_entry()
description not provided :(
attribution_reporting_source_registration()
@type attribution_reporting_source_registration() :: %{ aggregatableReportWindow: integer() | nil, aggregationKeys: [attribution_reporting_aggregation_keys_entry()], debugKey: unsigned_int64_as_base10() | nil, destinationSites: [String.t()], eventId: unsigned_int64_as_base10(), eventReportWindow: integer() | nil, expiry: integer() | nil, filterData: [attribution_reporting_filter_data_entry()], priority: signed_int64_as_base10(), reportingOrigin: String.t(), sourceOrigin: String.t(), time: CDPotion.Domain.Network.time_since_epoch(), type: attribution_reporting_source_type() }
description not provided :(
attribution_reporting_source_registration_result()
@type attribution_reporting_source_registration_result() ::
:success
| :internalError
| :insufficientSourceCapacity
| :insufficientUniqueDestinationCapacity
| :excessiveReportingOrigins
| :prohibitedByBrowserPolicy
| :successNoised
| :destinationReportingLimitReached
| :destinationGlobalLimitReached
| :destinationBothLimitsReached
| :reportingOriginsPerSiteLimitReached
description not provided :(
attribution_reporting_source_type()
@type attribution_reporting_source_type() :: :navigation | :event
description not provided :(
interest_group_access_type()
@type interest_group_access_type() :: :join | :leave | :update | :loaded | :bid | :win
Enum of interest group access types.
interest_group_ad()
Ad advertising element inside an interest group.
interest_group_details()
@type interest_group_details() :: %{ adComponents: [interest_group_ad()], ads: [interest_group_ad()], biddingUrl: String.t() | nil, biddingWasmHelperUrl: String.t() | nil, expirationTime: CDPotion.Domain.Network.time_since_epoch(), joiningOrigin: String.t(), name: String.t(), ownerOrigin: String.t(), trustedBiddingSignalsKeys: [String.t()], trustedBiddingSignalsUrl: String.t() | nil, updateUrl: String.t() | nil, userBiddingSignals: String.t() | nil }
The full details of an interest group.
serialized_storage_key()
@type serialized_storage_key() :: String.t()
description not provided :(
signed_int64_as_base10()
@type signed_int64_as_base10() :: String.t()
description not provided :(
storage_bucket()
@type storage_bucket() :: %{ name: String.t() | nil, storageKey: serialized_storage_key() }
description not provided :(
storage_bucket_info()
@type storage_bucket_info() :: %{ bucket: storage_bucket(), durability: storage_buckets_durability(), expiration: CDPotion.Domain.Network.time_since_epoch(), id: String.t(), persistent: boolean(), quota: number() }
description not provided :(
storage_buckets_durability()
@type storage_buckets_durability() :: :relaxed | :strict
description not provided :(
storage_type()
@type storage_type() ::
:appcache
| :cookies
| :file_systems
| :indexeddb
| :local_storage
| :shader_cache
| :websql
| :service_workers
| :cache_storage
| :interest_groups
| :shared_storage
| :storage_buckets
| :all
| :other
Enum of possible storage types.
trust_tokens()
Pair of issuer origin and number of available (signed, but not used) Trust Tokens from that issuer.
unsigned_int64_as_base10()
@type unsigned_int64_as_base10() :: String.t()
description not provided :(
unsigned_int128_as_base16()
@type unsigned_int128_as_base16() :: String.t()
description not provided :(
usage_for_type()
@type usage_for_type() :: %{storageType: storage_type(), usage: number()}
Usage for a storage type.
Functions
clear_cookies(browser_context_id \\ nil)
@spec clear_cookies(CDPotion.Domain.Browser.browser_context_id()) :: {String.t(), map()}
Clears cookies.
Parameters:
- (Optional)
browser_context_id
: Browser context to use when called on the browser endpoint.
clear_data_for_origin(origin, storage_types)
Clears storage for origin.
Parameters:
- (Required)
origin
: Security origin. - (Required)
storage_types
: Comma separated list of StorageType to clear.
clear_data_for_storage_key(storage_key, storage_types)
Clears storage for storage key.
Parameters:
- (Required)
storage_key
: Storage key. - (Required)
storage_types
: Comma separated list of StorageType to clear.
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.
Parameters:
- (Required)
issuer_origin
: description not provided :(
delete_storage_bucket(bucket)
@spec delete_storage_bucket(storage_bucket()) :: {String.t(), map()}
Deletes the Storage Bucket with the given storage key and bucket name.
Parameters:
- (Required)
bucket
: description not provided :(
get_cookies(browser_context_id \\ nil)
@spec get_cookies(CDPotion.Domain.Browser.browser_context_id()) :: {String.t(), map()}
Returns all browser cookies.
Parameters:
- (Optional)
browser_context_id
: Browser context to use when called on the browser endpoint.
get_interest_group_details(owner_origin, name)
Gets details for a named interest group.
Parameters:
- (Required)
owner_origin
: description not provided :( - (Required)
name
: description not provided :(
get_storage_key_for_frame(frame_id)
@spec get_storage_key_for_frame(CDPotion.Domain.Page.frame_id()) :: {String.t(), map()}
Returns a storage key given a frame id.
Parameters:
- (Required)
frame_id
: description not provided :(
get_trust_tokens()
Returns the number of stored Trust Tokens per issuer for the current browsing context.
get_usage_and_quota(origin)
Returns usage and quota in bytes.
Parameters:
- (Required)
origin
: Security origin.
override_quota_for_origin(origin, quota_size \\ nil)
Override quota for the specified origin
Parameters:
- (Required)
origin
: Security origin. - (Optional)
quota_size
: 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).
run_bounce_tracking_mitigations()
Deletes state for sites identified as potential bounce trackers, immediately.
set_attribution_reporting_local_testing_mode(enabled)
https://wicg.github.io/attribution-reporting-api/
Parameters:
- (Required)
enabled
: If enabled, noise is suppressed and reports are sent immediately.
set_attribution_reporting_tracking(enable)
Enables/disables issuing of Attribution Reporting events.
Parameters:
- (Required)
enable
: description not provided :(
set_cookies(cookies, browser_context_id \\ nil)
@spec set_cookies( [CDPotion.Domain.Network.cookie_param()], CDPotion.Domain.Browser.browser_context_id() ) :: {String.t(), map()}
Sets given cookies.
Parameters:
- (Required)
cookies
: Cookies to be set. - (Optional)
browser_context_id
: Browser context to use when called on the browser endpoint.
set_interest_group_tracking(enable)
Enables/Disables issuing of interestGroupAccessed events.
Parameters:
- (Required)
enable
: description not provided :(
set_storage_bucket_tracking(storage_key, enable)
Set tracking for a storage key's buckets.
Parameters:
- (Required)
storage_key
: description not provided :( - (Required)
enable
: description not provided :(
track_cache_storage_for_origin(origin)
Registers origin to be notified when an update occurs to its cache storage list.
Parameters:
- (Required)
origin
: Security origin.
track_cache_storage_for_storage_key(storage_key)
Registers storage key to be notified when an update occurs to its cache storage list.
Parameters:
- (Required)
storage_key
: Storage key.
track_indexed_db_for_origin(origin)
Registers origin to be notified when an update occurs to its IndexedDB.
Parameters:
- (Required)
origin
: Security origin.
track_indexed_db_for_storage_key(storage_key)
Registers storage key to be notified when an update occurs to its IndexedDB.
Parameters:
- (Required)
storage_key
: Storage key.
untrack_cache_storage_for_origin(origin)
Unregisters origin from receiving notifications for cache storage.
Parameters:
- (Required)
origin
: Security origin.
untrack_cache_storage_for_storage_key(storage_key)
Unregisters storage key from receiving notifications for cache storage.
Parameters:
- (Required)
storage_key
: Storage key.
untrack_indexed_db_for_origin(origin)
Unregisters origin from receiving notifications for IndexedDB.
Parameters:
- (Required)
origin
: Security origin.
untrack_indexed_db_for_storage_key(storage_key)
Unregisters storage key from receiving notifications for IndexedDB.
Parameters:
- (Required)
storage_key
: Storage key.