domstorage

Documentation

Overview

Package domstorage implements the DOMStorage domain. Query and modify DOM storage.

Index

• func NewClient(conn *rpcc.Conn) *domainClient
• type ClearArgs
  • func NewClearArgs(storageID StorageID) *ClearArgs
• type GetDOMStorageItemsArgs
  • func NewGetDOMStorageItemsArgs(storageID StorageID) *GetDOMStorageItemsArgs
• type GetDOMStorageItemsReply
• type Item
• type ItemAddedClient
• type ItemAddedReply
• type ItemRemovedClient
• type ItemRemovedReply
• type ItemUpdatedClient
• type ItemUpdatedReply
• type ItemsClearedClient
• type ItemsClearedReply
• type RemoveDOMStorageItemArgs
  • func NewRemoveDOMStorageItemArgs(storageID StorageID, key string) *RemoveDOMStorageItemArgs
• type SetDOMStorageItemArgs
  • func NewSetDOMStorageItemArgs(storageID StorageID, key string, value string) *SetDOMStorageItemArgs
• type StorageID

Functions

func NewClient

func NewClient(conn *rpcc.Conn) *domainClient

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

Types

type ClearArgs

type ClearArgs struct {
	StorageID StorageID `json:"storageId"` // No description.
}

ClearArgs represents the arguments for Clear in the DOMStorage domain.

func NewClearArgs

func NewClearArgs(storageID StorageID) *ClearArgs

NewClearArgs initializes ClearArgs with the required arguments.

type GetDOMStorageItemsArgs

type GetDOMStorageItemsArgs struct {
	StorageID StorageID `json:"storageId"` // No description.
}

GetDOMStorageItemsArgs represents the arguments for GetDOMStorageItems in the DOMStorage domain.

func NewGetDOMStorageItemsArgs

func NewGetDOMStorageItemsArgs(storageID StorageID) *GetDOMStorageItemsArgs

NewGetDOMStorageItemsArgs initializes GetDOMStorageItemsArgs with the required arguments.

type GetDOMStorageItemsReply

type GetDOMStorageItemsReply struct {
	Entries []Item `json:"entries"` // No description.
}

GetDOMStorageItemsReply represents the return values for GetDOMStorageItems in the DOMStorage domain.

type Item

type Item []string

Item DOM Storage item.

type ItemAddedClient

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

ItemAddedClient is a client for DOMStorageItemAdded events.

type ItemAddedReply

type ItemAddedReply struct {
	StorageID StorageID `json:"storageId"` // No description.
	Key       string    `json:"key"`       // No description.
	NewValue  string    `json:"newValue"`  // No description.
}

ItemAddedReply is the reply for DOMStorageItemAdded events.

type ItemRemovedClient

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

ItemRemovedClient is a client for DOMStorageItemRemoved events.

type ItemRemovedReply

type ItemRemovedReply struct {
	StorageID StorageID `json:"storageId"` // No description.
	Key       string    `json:"key"`       // No description.
}

ItemRemovedReply is the reply for DOMStorageItemRemoved events.

type ItemUpdatedClient

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

ItemUpdatedClient is a client for DOMStorageItemUpdated events.

type ItemUpdatedReply

type ItemUpdatedReply struct {
	StorageID StorageID `json:"storageId"` // No description.
	Key       string    `json:"key"`       // No description.
	OldValue  string    `json:"oldValue"`  // No description.
	NewValue  string    `json:"newValue"`  // No description.
}

ItemUpdatedReply is the reply for DOMStorageItemUpdated events.

type ItemsClearedClient

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

ItemsClearedClient is a client for DOMStorageItemsCleared events.

type ItemsClearedReply

type ItemsClearedReply struct {
	StorageID StorageID `json:"storageId"` // No description.
}

ItemsClearedReply is the reply for DOMStorageItemsCleared events.

type RemoveDOMStorageItemArgs

type RemoveDOMStorageItemArgs struct {
	StorageID StorageID `json:"storageId"` // No description.
	Key       string    `json:"key"`       // No description.
}

RemoveDOMStorageItemArgs represents the arguments for RemoveDOMStorageItem in the DOMStorage domain.

func NewRemoveDOMStorageItemArgs

func NewRemoveDOMStorageItemArgs(storageID StorageID, key string) *RemoveDOMStorageItemArgs

NewRemoveDOMStorageItemArgs initializes RemoveDOMStorageItemArgs with the required arguments.

type SetDOMStorageItemArgs

type SetDOMStorageItemArgs struct {
	StorageID StorageID `json:"storageId"` // No description.
	Key       string    `json:"key"`       // No description.
	Value     string    `json:"value"`     // No description.
}

SetDOMStorageItemArgs represents the arguments for SetDOMStorageItem in the DOMStorage domain.

func NewSetDOMStorageItemArgs

func NewSetDOMStorageItemArgs(storageID StorageID, key string, value string) *SetDOMStorageItemArgs

NewSetDOMStorageItemArgs initializes SetDOMStorageItemArgs with the required arguments.

type StorageID

type StorageID struct {
	SecurityOrigin string `json:"securityOrigin"` // Security origin for the storage.
	IsLocalStorage bool   `json:"isLocalStorage"` // Whether the storage is local storage (not session storage).
}

StorageID DOM Storage identifier.