storage

package
v0.34.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 4, 2023 License: MIT Imports: 6 Imported by: 8

Documentation

Overview

Package storage implements the Storage domain.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewClient

func NewClient(conn *rpcc.Conn) *domainClient

NewClient returns a client for the Storage domain with the connection set to conn.

Types

type CacheStorageContentUpdatedClient added in v0.11.2

type CacheStorageContentUpdatedClient interface {
	// Recv calls RecvMsg on rpcc.Stream, blocks until the event is
	// triggered, context canceled or connection closed.
	Recv() (*CacheStorageContentUpdatedReply, error)
	rpcc.Stream
}

CacheStorageContentUpdatedClient is a client for CacheStorageContentUpdated events. A cache's contents have been modified.

type CacheStorageContentUpdatedReply added in v0.11.2

type CacheStorageContentUpdatedReply struct {
	Origin    string `json:"origin"`    // Origin to update.
	CacheName string `json:"cacheName"` // Name of cache in origin.
}

CacheStorageContentUpdatedReply is the reply for CacheStorageContentUpdated events.

type CacheStorageListUpdatedClient added in v0.11.2

type CacheStorageListUpdatedClient interface {
	// Recv calls RecvMsg on rpcc.Stream, blocks until the event is
	// triggered, context canceled or connection closed.
	Recv() (*CacheStorageListUpdatedReply, error)
	rpcc.Stream
}

CacheStorageListUpdatedClient is a client for CacheStorageListUpdated events. A cache has been added/deleted.

type CacheStorageListUpdatedReply added in v0.11.2

type CacheStorageListUpdatedReply struct {
	Origin string `json:"origin"` // Origin to update.
}

CacheStorageListUpdatedReply is the reply for CacheStorageListUpdated events.

type ClearCookiesArgs added in v0.25.0

type ClearCookiesArgs struct {
	BrowserContextID *browser.ContextID `json:"browserContextId,omitempty"` // Browser context to use when called on the browser endpoint.
}

ClearCookiesArgs represents the arguments for ClearCookies in the Storage domain.

func NewClearCookiesArgs added in v0.25.0

func NewClearCookiesArgs() *ClearCookiesArgs

NewClearCookiesArgs initializes ClearCookiesArgs with the required arguments.

func (*ClearCookiesArgs) SetBrowserContextID added in v0.25.0

func (a *ClearCookiesArgs) SetBrowserContextID(browserContextID browser.ContextID) *ClearCookiesArgs

SetBrowserContextID sets the BrowserContextID optional argument. Browser context to use when called on the browser endpoint.

type ClearDataForOriginArgs

type ClearDataForOriginArgs struct {
	Origin       string `json:"origin"`       // Security origin.
	StorageTypes string `json:"storageTypes"` // Comma separated list of StorageType to clear.
}

ClearDataForOriginArgs represents the arguments for ClearDataForOrigin in the Storage domain.

func NewClearDataForOriginArgs

func NewClearDataForOriginArgs(origin string, storageTypes string) *ClearDataForOriginArgs

NewClearDataForOriginArgs initializes ClearDataForOriginArgs with the required arguments.

type ClearTrustTokensArgs added in v0.31.0

type ClearTrustTokensArgs struct {
	IssuerOrigin string `json:"issuerOrigin"` // No description.
}

ClearTrustTokensArgs represents the arguments for ClearTrustTokens in the Storage domain.

func NewClearTrustTokensArgs added in v0.31.0

func NewClearTrustTokensArgs(issuerOrigin string) *ClearTrustTokensArgs

NewClearTrustTokensArgs initializes ClearTrustTokensArgs with the required arguments.

type ClearTrustTokensReply added in v0.31.0

type ClearTrustTokensReply struct {
	DidDeleteTokens bool `json:"didDeleteTokens"` // True if any tokens were deleted, false otherwise.
}

ClearTrustTokensReply represents the return values for ClearTrustTokens in the Storage domain.

type GetCookiesArgs added in v0.25.0

type GetCookiesArgs struct {
	BrowserContextID *browser.ContextID `json:"browserContextId,omitempty"` // Browser context to use when called on the browser endpoint.
}

GetCookiesArgs represents the arguments for GetCookies in the Storage domain.

func NewGetCookiesArgs added in v0.25.0

func NewGetCookiesArgs() *GetCookiesArgs

NewGetCookiesArgs initializes GetCookiesArgs with the required arguments.

func (*GetCookiesArgs) SetBrowserContextID added in v0.25.0

func (a *GetCookiesArgs) SetBrowserContextID(browserContextID browser.ContextID) *GetCookiesArgs

SetBrowserContextID sets the BrowserContextID optional argument. Browser context to use when called on the browser endpoint.

type GetCookiesReply added in v0.25.0

type GetCookiesReply struct {
	Cookies []network.Cookie `json:"cookies"` // Array of cookie objects.
}

GetCookiesReply represents the return values for GetCookies in the Storage domain.

type GetInterestGroupDetailsArgs added in v0.33.0

type GetInterestGroupDetailsArgs struct {
	OwnerOrigin string `json:"ownerOrigin"` // No description.
	Name        string `json:"name"`        // No description.
}

GetInterestGroupDetailsArgs represents the arguments for GetInterestGroupDetails in the Storage domain.

func NewGetInterestGroupDetailsArgs added in v0.33.0

func NewGetInterestGroupDetailsArgs(ownerOrigin string, name string) *GetInterestGroupDetailsArgs

NewGetInterestGroupDetailsArgs initializes GetInterestGroupDetailsArgs with the required arguments.

type GetInterestGroupDetailsReply added in v0.33.0

type GetInterestGroupDetailsReply struct {
	Details InterestGroupDetails `json:"details"` // No description.
}

GetInterestGroupDetailsReply represents the return values for GetInterestGroupDetails in the Storage domain.

type GetStorageKeyForFrameArgs added in v0.33.0

type GetStorageKeyForFrameArgs struct {
	FrameID page.FrameID `json:"frameId"` // No description.
}

GetStorageKeyForFrameArgs represents the arguments for GetStorageKeyForFrame in the Storage domain.

func NewGetStorageKeyForFrameArgs added in v0.33.0

func NewGetStorageKeyForFrameArgs(frameID page.FrameID) *GetStorageKeyForFrameArgs

NewGetStorageKeyForFrameArgs initializes GetStorageKeyForFrameArgs with the required arguments.

type GetStorageKeyForFrameReply added in v0.33.0

type GetStorageKeyForFrameReply struct {
	StorageKey SerializedStorageKey `json:"storageKey"` // No description.
}

GetStorageKeyForFrameReply represents the return values for GetStorageKeyForFrame in the Storage domain.

type GetTrustTokensReply added in v0.31.0

type GetTrustTokensReply struct {
	Tokens []TrustTokens `json:"tokens"` // No description.
}

GetTrustTokensReply represents the return values for GetTrustTokens in the Storage domain.

type GetUsageAndQuotaArgs

type GetUsageAndQuotaArgs struct {
	Origin string `json:"origin"` // Security origin.
}

GetUsageAndQuotaArgs represents the arguments for GetUsageAndQuota in the Storage domain.

func NewGetUsageAndQuotaArgs

func NewGetUsageAndQuotaArgs(origin string) *GetUsageAndQuotaArgs

NewGetUsageAndQuotaArgs initializes GetUsageAndQuotaArgs with the required arguments.

type GetUsageAndQuotaReply

type GetUsageAndQuotaReply struct {
	Usage          float64        `json:"usage"`          // Storage usage (bytes).
	Quota          float64        `json:"quota"`          // Storage quota (bytes).
	OverrideActive bool           `json:"overrideActive"` // Whether or not the origin has an active storage quota override
	UsageBreakdown []UsageForType `json:"usageBreakdown"` // Storage usage per type (bytes).
}

GetUsageAndQuotaReply represents the return values for GetUsageAndQuota in the Storage domain.

type IndexedDBContentUpdatedClient added in v0.13.3

type IndexedDBContentUpdatedClient interface {
	// Recv calls RecvMsg on rpcc.Stream, blocks until the event is
	// triggered, context canceled or connection closed.
	Recv() (*IndexedDBContentUpdatedReply, error)
	rpcc.Stream
}

IndexedDBContentUpdatedClient is a client for IndexedDBContentUpdated events. The origin's IndexedDB object store has been modified.

type IndexedDBContentUpdatedReply added in v0.13.3

type IndexedDBContentUpdatedReply struct {
	Origin          string `json:"origin"`          // Origin to update.
	DatabaseName    string `json:"databaseName"`    // Database to update.
	ObjectStoreName string `json:"objectStoreName"` // ObjectStore to update.
}

IndexedDBContentUpdatedReply is the reply for IndexedDBContentUpdated events.

type IndexedDBListUpdatedClient added in v0.13.3

type IndexedDBListUpdatedClient interface {
	// Recv calls RecvMsg on rpcc.Stream, blocks until the event is
	// triggered, context canceled or connection closed.
	Recv() (*IndexedDBListUpdatedReply, error)
	rpcc.Stream
}

IndexedDBListUpdatedClient is a client for IndexedDBListUpdated events. The origin's IndexedDB database list has been modified.

type IndexedDBListUpdatedReply added in v0.13.3

type IndexedDBListUpdatedReply struct {
	Origin string `json:"origin"` // Origin to update.
}

IndexedDBListUpdatedReply is the reply for IndexedDBListUpdated events.

type InterestGroupAccessType added in v0.33.0

type InterestGroupAccessType string

InterestGroupAccessType Enum of interest group access types.

const (
	InterestGroupAccessTypeNotSet InterestGroupAccessType = ""
	InterestGroupAccessTypeJoin   InterestGroupAccessType = "join"
	InterestGroupAccessTypeLeave  InterestGroupAccessType = "leave"
	InterestGroupAccessTypeUpdate InterestGroupAccessType = "update"
	InterestGroupAccessTypeBid    InterestGroupAccessType = "bid"
	InterestGroupAccessTypeWin    InterestGroupAccessType = "win"
)

InterestGroupAccessType as enums.

func (InterestGroupAccessType) String added in v0.33.0

func (e InterestGroupAccessType) String() string

func (InterestGroupAccessType) Valid added in v0.33.0

func (e InterestGroupAccessType) Valid() bool

type InterestGroupAccessedClient added in v0.33.0

type InterestGroupAccessedClient interface {
	// Recv calls RecvMsg on rpcc.Stream, blocks until the event is
	// triggered, context canceled or connection closed.
	Recv() (*InterestGroupAccessedReply, error)
	rpcc.Stream
}

InterestGroupAccessedClient is a client for InterestGroupAccessed events. One of the interest groups was accessed by the associated page.

type InterestGroupAccessedReply added in v0.33.0

type InterestGroupAccessedReply struct {
	AccessTime  network.TimeSinceEpoch  `json:"accessTime"`  // No description.
	Type        InterestGroupAccessType `json:"type"`        // No description.
	OwnerOrigin string                  `json:"ownerOrigin"` // No description.
	Name        string                  `json:"name"`        // No description.
}

InterestGroupAccessedReply is the reply for InterestGroupAccessed events.

type InterestGroupAd added in v0.33.0

type InterestGroupAd struct {
	RenderURL string  `json:"renderUrl"`          // No description.
	Metadata  *string `json:"metadata,omitempty"` // No description.
}

InterestGroupAd Ad advertising element inside an interest group.

type InterestGroupDetails added in v0.33.0

type InterestGroupDetails struct {
	OwnerOrigin               string                 `json:"ownerOrigin"`                        // No description.
	Name                      string                 `json:"name"`                               // No description.
	ExpirationTime            network.TimeSinceEpoch `json:"expirationTime"`                     // No description.
	JoiningOrigin             string                 `json:"joiningOrigin"`                      // No description.
	BiddingURL                *string                `json:"biddingUrl,omitempty"`               // No description.
	BiddingWASMHelperURL      *string                `json:"biddingWasmHelperUrl,omitempty"`     // No description.
	UpdateURL                 *string                `json:"updateUrl,omitempty"`                // No description.
	TrustedBiddingSignalsURL  *string                `json:"trustedBiddingSignalsUrl,omitempty"` // No description.
	TrustedBiddingSignalsKeys []string               `json:"trustedBiddingSignalsKeys"`          // No description.
	UserBiddingSignals        *string                `json:"userBiddingSignals,omitempty"`       // No description.
	Ads                       []InterestGroupAd      `json:"ads"`                                // No description.
	AdComponents              []InterestGroupAd      `json:"adComponents"`                       // No description.
}

InterestGroupDetails The full details of an interest group.

type OverrideQuotaForOriginArgs added in v0.31.0

type OverrideQuotaForOriginArgs struct {
	Origin    string   `json:"origin"`              // Security origin.
	QuotaSize *float64 `json:"quotaSize,omitempty"` // 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).
}

OverrideQuotaForOriginArgs represents the arguments for OverrideQuotaForOrigin in the Storage domain.

func NewOverrideQuotaForOriginArgs added in v0.31.0

func NewOverrideQuotaForOriginArgs(origin string) *OverrideQuotaForOriginArgs

NewOverrideQuotaForOriginArgs initializes OverrideQuotaForOriginArgs with the required arguments.

func (*OverrideQuotaForOriginArgs) SetQuotaSize added in v0.31.0

SetQuotaSize sets the QuotaSize optional argument. 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).

type SerializedStorageKey added in v0.33.0

type SerializedStorageKey string

SerializedStorageKey

type SetCookiesArgs added in v0.25.0

type SetCookiesArgs struct {
	Cookies          []network.CookieParam `json:"cookies"`                    // Cookies to be set.
	BrowserContextID *browser.ContextID    `json:"browserContextId,omitempty"` // Browser context to use when called on the browser endpoint.
}

SetCookiesArgs represents the arguments for SetCookies in the Storage domain.

func NewSetCookiesArgs added in v0.25.0

func NewSetCookiesArgs(cookies []network.CookieParam) *SetCookiesArgs

NewSetCookiesArgs initializes SetCookiesArgs with the required arguments.

func (*SetCookiesArgs) SetBrowserContextID added in v0.25.0

func (a *SetCookiesArgs) SetBrowserContextID(browserContextID browser.ContextID) *SetCookiesArgs

SetBrowserContextID sets the BrowserContextID optional argument. Browser context to use when called on the browser endpoint.

type SetInterestGroupTrackingArgs added in v0.33.0

type SetInterestGroupTrackingArgs struct {
	Enable bool `json:"enable"` // No description.
}

SetInterestGroupTrackingArgs represents the arguments for SetInterestGroupTracking in the Storage domain.

func NewSetInterestGroupTrackingArgs added in v0.33.0

func NewSetInterestGroupTrackingArgs(enable bool) *SetInterestGroupTrackingArgs

NewSetInterestGroupTrackingArgs initializes SetInterestGroupTrackingArgs with the required arguments.

type TrackCacheStorageForOriginArgs added in v0.11.1

type TrackCacheStorageForOriginArgs struct {
	Origin string `json:"origin"` // Security origin.
}

TrackCacheStorageForOriginArgs represents the arguments for TrackCacheStorageForOrigin in the Storage domain.

func NewTrackCacheStorageForOriginArgs added in v0.11.1

func NewTrackCacheStorageForOriginArgs(origin string) *TrackCacheStorageForOriginArgs

NewTrackCacheStorageForOriginArgs initializes TrackCacheStorageForOriginArgs with the required arguments.

type TrackIndexedDBForOriginArgs added in v0.13.3

type TrackIndexedDBForOriginArgs struct {
	Origin string `json:"origin"` // Security origin.
}

TrackIndexedDBForOriginArgs represents the arguments for TrackIndexedDBForOrigin in the Storage domain.

func NewTrackIndexedDBForOriginArgs added in v0.13.3

func NewTrackIndexedDBForOriginArgs(origin string) *TrackIndexedDBForOriginArgs

NewTrackIndexedDBForOriginArgs initializes TrackIndexedDBForOriginArgs with the required arguments.

type TrustTokens added in v0.31.0

type TrustTokens struct {
	IssuerOrigin string  `json:"issuerOrigin"` // No description.
	Count        float64 `json:"count"`        // No description.
}

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

Note: This type is experimental.

type Type

type Type string

Type Enum of possible storage types.

const (
	TypeNotSet         Type = ""
	TypeAppcache       Type = "appcache"
	TypeCookies        Type = "cookies"
	TypeFileSystems    Type = "file_systems"
	TypeIndexeddb      Type = "indexeddb"
	TypeLocalStorage   Type = "local_storage"
	TypeShaderCache    Type = "shader_cache"
	TypeWebsql         Type = "websql"
	TypeServiceWorkers Type = "service_workers"
	TypeCacheStorage   Type = "cache_storage"
	TypeInterestGroups Type = "interest_groups"
	TypeAll            Type = "all"
	TypeOther          Type = "other"
)

Type as enums.

func (Type) String

func (e Type) String() string

func (Type) Valid

func (e Type) Valid() bool

type UntrackCacheStorageForOriginArgs added in v0.11.1

type UntrackCacheStorageForOriginArgs struct {
	Origin string `json:"origin"` // Security origin.
}

UntrackCacheStorageForOriginArgs represents the arguments for UntrackCacheStorageForOrigin in the Storage domain.

func NewUntrackCacheStorageForOriginArgs added in v0.11.1

func NewUntrackCacheStorageForOriginArgs(origin string) *UntrackCacheStorageForOriginArgs

NewUntrackCacheStorageForOriginArgs initializes UntrackCacheStorageForOriginArgs with the required arguments.

type UntrackIndexedDBForOriginArgs added in v0.13.3

type UntrackIndexedDBForOriginArgs struct {
	Origin string `json:"origin"` // Security origin.
}

UntrackIndexedDBForOriginArgs represents the arguments for UntrackIndexedDBForOrigin in the Storage domain.

func NewUntrackIndexedDBForOriginArgs added in v0.13.3

func NewUntrackIndexedDBForOriginArgs(origin string) *UntrackIndexedDBForOriginArgs

NewUntrackIndexedDBForOriginArgs initializes UntrackIndexedDBForOriginArgs with the required arguments.

type UsageForType

type UsageForType struct {
	StorageType Type    `json:"storageType"` // Name of storage type.
	Usage       float64 `json:"usage"`       // Storage usage (bytes).
}

UsageForType Usage for a storage type.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL