domstorage

Documentation

Overview

Package domstorage provides the Chrome DevTools Protocol commands, types, and events for the DOMStorage domain.

Query and modify DOM storage.

Generated by the cdproto-gen command.

Index

• Constants
• type ClearParams
  • func Clear(storageID *StorageID) *ClearParams
  • func (p *ClearParams) Do(ctx context.Context) (err error)
• type DisableParams
  • func Disable() *DisableParams
  • func (p *DisableParams) Do(ctx context.Context) (err error)
• type EnableParams
  • func Enable() *EnableParams
  • func (p *EnableParams) Do(ctx context.Context) (err error)
• type EventDomStorageItemAdded
• type EventDomStorageItemRemoved
• type EventDomStorageItemUpdated
• type EventDomStorageItemsCleared
• type GetDOMStorageItemsParams
  • func GetDOMStorageItems(storageID *StorageID) *GetDOMStorageItemsParams
  • func (p *GetDOMStorageItemsParams) Do(ctx context.Context) (entries []Item, err error)
• type GetDOMStorageItemsReturns
• type Item
• type RemoveDOMStorageItemParams
  • func RemoveDOMStorageItem(storageID *StorageID, key string) *RemoveDOMStorageItemParams
  • func (p *RemoveDOMStorageItemParams) Do(ctx context.Context) (err error)
• type SerializedStorageKey
  • func (t SerializedStorageKey) String() string
• type SetDOMStorageItemParams
  • func SetDOMStorageItem(storageID *StorageID, key string, value string) *SetDOMStorageItemParams
  • func (p *SetDOMStorageItemParams) Do(ctx context.Context) (err error)
• type StorageID

Constants

const (
	CommandClear                = "DOMStorage.clear"
	CommandDisable              = "DOMStorage.disable"
	CommandEnable               = "DOMStorage.enable"
	CommandGetDOMStorageItems   = "DOMStorage.getDOMStorageItems"
	CommandRemoveDOMStorageItem = "DOMStorage.removeDOMStorageItem"
	CommandSetDOMStorageItem    = "DOMStorage.setDOMStorageItem"
)

Command names.

Types

type ClearParams

type ClearParams struct {
	StorageID *StorageID `json:"storageId"`
}

ClearParams [no description].

func Clear

func Clear(storageID *StorageID) *ClearParams

Clear [no description].

See: https://chromedevtools.github.io/devtools-protocol/tot/DOMStorage#method-clear

parameters:

storageID

func (*ClearParams) Do

func (p *ClearParams) Do(ctx context.Context) (err error)

Do executes DOMStorage.clear against the provided context.

type DisableParams

type DisableParams struct{}

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

func Disable

func Disable() *DisableParams

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

See: https://chromedevtools.github.io/devtools-protocol/tot/DOMStorage#method-disable

func (*DisableParams) Do

func (p *DisableParams) Do(ctx context.Context) (err error)

Do executes DOMStorage.disable against the provided context.

type EnableParams

type EnableParams struct{}

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

func Enable

func Enable() *EnableParams

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

See: https://chromedevtools.github.io/devtools-protocol/tot/DOMStorage#method-enable

func (*EnableParams) Do

func (p *EnableParams) Do(ctx context.Context) (err error)

Do executes DOMStorage.enable against the provided context.

type EventDomStorageItemAdded

type EventDomStorageItemAdded struct {
	StorageID *StorageID `json:"storageId"`
	Key       string     `json:"key"`
	NewValue  string     `json:"newValue"`
}

EventDomStorageItemAdded [no description].

See: https://chromedevtools.github.io/devtools-protocol/tot/DOMStorage#event-domStorageItemAdded

type EventDomStorageItemRemoved

type EventDomStorageItemRemoved struct {
	StorageID *StorageID `json:"storageId"`
	Key       string     `json:"key"`
}

EventDomStorageItemRemoved [no description].

See: https://chromedevtools.github.io/devtools-protocol/tot/DOMStorage#event-domStorageItemRemoved

type EventDomStorageItemUpdated

type EventDomStorageItemUpdated struct {
	StorageID *StorageID `json:"storageId"`
	Key       string     `json:"key"`
	OldValue  string     `json:"oldValue"`
	NewValue  string     `json:"newValue"`
}

EventDomStorageItemUpdated [no description].

See: https://chromedevtools.github.io/devtools-protocol/tot/DOMStorage#event-domStorageItemUpdated

type EventDomStorageItemsCleared

type EventDomStorageItemsCleared struct {
	StorageID *StorageID `json:"storageId"`
}

EventDomStorageItemsCleared [no description].

See: https://chromedevtools.github.io/devtools-protocol/tot/DOMStorage#event-domStorageItemsCleared

type GetDOMStorageItemsParams

type GetDOMStorageItemsParams struct {
	StorageID *StorageID `json:"storageId"`
}

GetDOMStorageItemsParams [no description].

func GetDOMStorageItems

func GetDOMStorageItems(storageID *StorageID) *GetDOMStorageItemsParams

GetDOMStorageItems [no description].

See: https://chromedevtools.github.io/devtools-protocol/tot/DOMStorage#method-getDOMStorageItems

parameters:

storageID

func (*GetDOMStorageItemsParams) Do

func (p *GetDOMStorageItemsParams) Do(ctx context.Context) (entries []Item, err error)

Do executes DOMStorage.getDOMStorageItems against the provided context.

returns:

entries

type GetDOMStorageItemsReturns

type GetDOMStorageItemsReturns struct {
	Entries []Item `json:"entries,omitempty,omitzero"`
}

GetDOMStorageItemsReturns return values.

type Item

type Item []string

Item DOM Storage item.

See: https://chromedevtools.github.io/devtools-protocol/tot/DOMStorage#type-Item

type RemoveDOMStorageItemParams

type RemoveDOMStorageItemParams struct {
	StorageID *StorageID `json:"storageId"`
	Key       string     `json:"key"`
}

RemoveDOMStorageItemParams [no description].

func RemoveDOMStorageItem

func RemoveDOMStorageItem(storageID *StorageID, key string) *RemoveDOMStorageItemParams

RemoveDOMStorageItem [no description].

See: https://chromedevtools.github.io/devtools-protocol/tot/DOMStorage#method-removeDOMStorageItem

parameters:

storageID
key

func (*RemoveDOMStorageItemParams) Do

func (p *RemoveDOMStorageItemParams) Do(ctx context.Context) (err error)

Do executes DOMStorage.removeDOMStorageItem against the provided context.

type SerializedStorageKey

type SerializedStorageKey string

SerializedStorageKey [no description].

See: https://chromedevtools.github.io/devtools-protocol/tot/DOMStorage#type-SerializedStorageKey

func (SerializedStorageKey) String

func (t SerializedStorageKey) String() string

String returns the SerializedStorageKey as string value.

type SetDOMStorageItemParams

type SetDOMStorageItemParams struct {
	StorageID *StorageID `json:"storageId"`
	Key       string     `json:"key"`
	Value     string     `json:"value"`
}

SetDOMStorageItemParams [no description].

func SetDOMStorageItem

func SetDOMStorageItem(storageID *StorageID, key string, value string) *SetDOMStorageItemParams

SetDOMStorageItem [no description].

See: https://chromedevtools.github.io/devtools-protocol/tot/DOMStorage#method-setDOMStorageItem

parameters:

storageID
key
value

func (*SetDOMStorageItemParams) Do

func (p *SetDOMStorageItemParams) Do(ctx context.Context) (err error)

Do executes DOMStorage.setDOMStorageItem against the provided context.

type StorageID

type StorageID struct {
	SecurityOrigin string               `json:"securityOrigin,omitempty,omitzero"` // Security origin for the storage.
	StorageKey     SerializedStorageKey `json:"storageKey,omitempty,omitzero"`     // Represents a key by which DOM Storage keys its CachedStorageAreas
	IsLocalStorage bool                 `json:"isLocalStorage"`                    // Whether the storage is local storage (not session storage).
}

StorageID DOM Storage identifier.

See: https://chromedevtools.github.io/devtools-protocol/tot/DOMStorage#type-StorageId