Documentation ¶
Overview ¶
Package indexeddb provides the Chrome Debugging Protocol commands, types, and events for the Chrome IndexedDB domain.
Generated by the chromedp-gen command.
Index ¶
- type ClearObjectStoreParams
- func (p *ClearObjectStoreParams) Do(ctxt context.Context, h cdp.FrameHandler) (err error)
- func (v ClearObjectStoreParams) MarshalEasyJSON(w *jwriter.Writer)
- func (v ClearObjectStoreParams) MarshalJSON() ([]byte, error)
- func (v *ClearObjectStoreParams) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *ClearObjectStoreParams) UnmarshalJSON(data []byte) error
- type DataEntry
- type DatabaseWithObjectStores
- type DisableParams
- func (p *DisableParams) Do(ctxt context.Context, h cdp.FrameHandler) (err error)
- func (v DisableParams) MarshalEasyJSON(w *jwriter.Writer)
- func (v DisableParams) MarshalJSON() ([]byte, error)
- func (v *DisableParams) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *DisableParams) UnmarshalJSON(data []byte) error
- type EnableParams
- func (p *EnableParams) Do(ctxt context.Context, h cdp.FrameHandler) (err error)
- func (v EnableParams) MarshalEasyJSON(w *jwriter.Writer)
- func (v EnableParams) MarshalJSON() ([]byte, error)
- func (v *EnableParams) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *EnableParams) UnmarshalJSON(data []byte) error
- type Key
- type KeyPath
- type KeyPathType
- type KeyRange
- type KeyType
- type ObjectStore
- type ObjectStoreIndex
- type RequestDataParams
- func (p *RequestDataParams) Do(ctxt context.Context, h cdp.FrameHandler) (objectStoreDataEntries []*DataEntry, hasMore bool, err error)
- func (v RequestDataParams) MarshalEasyJSON(w *jwriter.Writer)
- func (v RequestDataParams) MarshalJSON() ([]byte, error)
- func (v *RequestDataParams) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *RequestDataParams) UnmarshalJSON(data []byte) error
- func (p RequestDataParams) WithKeyRange(keyRange *KeyRange) *RequestDataParams
- type RequestDataReturns
- type RequestDatabaseNamesParams
- func (p *RequestDatabaseNamesParams) Do(ctxt context.Context, h cdp.FrameHandler) (databaseNames []string, err error)
- func (v RequestDatabaseNamesParams) MarshalEasyJSON(w *jwriter.Writer)
- func (v RequestDatabaseNamesParams) MarshalJSON() ([]byte, error)
- func (v *RequestDatabaseNamesParams) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *RequestDatabaseNamesParams) UnmarshalJSON(data []byte) error
- type RequestDatabaseNamesReturns
- type RequestDatabaseParams
- func (p *RequestDatabaseParams) Do(ctxt context.Context, h cdp.FrameHandler) (databaseWithObjectStores *DatabaseWithObjectStores, err error)
- func (v RequestDatabaseParams) MarshalEasyJSON(w *jwriter.Writer)
- func (v RequestDatabaseParams) MarshalJSON() ([]byte, error)
- func (v *RequestDatabaseParams) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *RequestDatabaseParams) UnmarshalJSON(data []byte) error
- type RequestDatabaseReturns
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ClearObjectStoreParams ¶
type ClearObjectStoreParams struct { SecurityOrigin string `json:"securityOrigin"` // Security origin. DatabaseName string `json:"databaseName"` // Database name. ObjectStoreName string `json:"objectStoreName"` // Object store name. }
ClearObjectStoreParams clears all entries from an object store.
func ClearObjectStore ¶
func ClearObjectStore(securityOrigin string, databaseName string, objectStoreName string) *ClearObjectStoreParams
ClearObjectStore clears all entries from an object store.
parameters:
securityOrigin - Security origin. databaseName - Database name. objectStoreName - Object store name.
func (*ClearObjectStoreParams) Do ¶
func (p *ClearObjectStoreParams) Do(ctxt context.Context, h cdp.FrameHandler) (err error)
Do executes IndexedDB.clearObjectStore.
func (ClearObjectStoreParams) MarshalEasyJSON ¶
func (v ClearObjectStoreParams) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (ClearObjectStoreParams) MarshalJSON ¶
func (v ClearObjectStoreParams) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*ClearObjectStoreParams) UnmarshalEasyJSON ¶
func (v *ClearObjectStoreParams) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*ClearObjectStoreParams) UnmarshalJSON ¶
func (v *ClearObjectStoreParams) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type DataEntry ¶
type DataEntry struct { Key *runtime.RemoteObject `json:"key,omitempty"` // Key object. PrimaryKey *runtime.RemoteObject `json:"primaryKey,omitempty"` // Primary key object. Value *runtime.RemoteObject `json:"value,omitempty"` // Value object. }
DataEntry data entry.
func (DataEntry) MarshalEasyJSON ¶
MarshalEasyJSON supports easyjson.Marshaler interface
func (DataEntry) MarshalJSON ¶
MarshalJSON supports json.Marshaler interface
func (*DataEntry) UnmarshalEasyJSON ¶
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*DataEntry) UnmarshalJSON ¶
UnmarshalJSON supports json.Unmarshaler interface
type DatabaseWithObjectStores ¶
type DatabaseWithObjectStores struct { Name string `json:"name,omitempty"` // Database name. Version int64 `json:"version,omitempty"` // Database version. ObjectStores []*ObjectStore `json:"objectStores,omitempty"` // Object stores in this database. }
DatabaseWithObjectStores database with an array of object stores.
func (DatabaseWithObjectStores) MarshalEasyJSON ¶
func (v DatabaseWithObjectStores) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (DatabaseWithObjectStores) MarshalJSON ¶
func (v DatabaseWithObjectStores) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*DatabaseWithObjectStores) UnmarshalEasyJSON ¶
func (v *DatabaseWithObjectStores) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*DatabaseWithObjectStores) UnmarshalJSON ¶
func (v *DatabaseWithObjectStores) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type DisableParams ¶
type DisableParams struct{}
DisableParams disables events from backend.
func (*DisableParams) Do ¶
func (p *DisableParams) Do(ctxt context.Context, h cdp.FrameHandler) (err error)
Do executes IndexedDB.disable.
func (DisableParams) MarshalEasyJSON ¶
func (v DisableParams) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (DisableParams) MarshalJSON ¶
func (v DisableParams) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*DisableParams) UnmarshalEasyJSON ¶
func (v *DisableParams) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*DisableParams) UnmarshalJSON ¶
func (v *DisableParams) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type EnableParams ¶
type EnableParams struct{}
EnableParams enables events from backend.
func (*EnableParams) Do ¶
func (p *EnableParams) Do(ctxt context.Context, h cdp.FrameHandler) (err error)
Do executes IndexedDB.enable.
func (EnableParams) MarshalEasyJSON ¶
func (v EnableParams) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (EnableParams) MarshalJSON ¶
func (v EnableParams) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*EnableParams) UnmarshalEasyJSON ¶
func (v *EnableParams) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*EnableParams) UnmarshalJSON ¶
func (v *EnableParams) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type Key ¶
type Key struct { Type KeyType `json:"type,omitempty"` // Key type. Number float64 `json:"number,omitempty"` // Number value. String string `json:"string,omitempty"` // String value. Date float64 `json:"date,omitempty"` // Date value. Array []*Key `json:"array,omitempty"` // Array value. }
Key key.
func (Key) MarshalEasyJSON ¶
MarshalEasyJSON supports easyjson.Marshaler interface
func (Key) MarshalJSON ¶
MarshalJSON supports json.Marshaler interface
func (*Key) UnmarshalEasyJSON ¶
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*Key) UnmarshalJSON ¶
UnmarshalJSON supports json.Unmarshaler interface
type KeyPath ¶
type KeyPath struct { Type KeyPathType `json:"type,omitempty"` // Key path type. String string `json:"string,omitempty"` // String value. Array []string `json:"array,omitempty"` // Array value. }
KeyPath key path.
func (KeyPath) MarshalEasyJSON ¶
MarshalEasyJSON supports easyjson.Marshaler interface
func (KeyPath) MarshalJSON ¶
MarshalJSON supports json.Marshaler interface
func (*KeyPath) UnmarshalEasyJSON ¶
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*KeyPath) UnmarshalJSON ¶
UnmarshalJSON supports json.Unmarshaler interface
type KeyPathType ¶
type KeyPathType string
KeyPathType key path type.
const ( KeyPathTypeNull KeyPathType = "null" KeyPathTypeString KeyPathType = "string" KeyPathTypeArray KeyPathType = "array" )
KeyPathType values.
func (KeyPathType) MarshalEasyJSON ¶
func (t KeyPathType) MarshalEasyJSON(out *jwriter.Writer)
MarshalEasyJSON satisfies easyjson.Marshaler.
func (KeyPathType) MarshalJSON ¶
func (t KeyPathType) MarshalJSON() ([]byte, error)
MarshalJSON satisfies json.Marshaler.
func (KeyPathType) String ¶
func (t KeyPathType) String() string
String returns the KeyPathType as string value.
func (*KeyPathType) UnmarshalEasyJSON ¶
func (t *KeyPathType) UnmarshalEasyJSON(in *jlexer.Lexer)
UnmarshalEasyJSON satisfies easyjson.Unmarshaler.
func (*KeyPathType) UnmarshalJSON ¶
func (t *KeyPathType) UnmarshalJSON(buf []byte) error
UnmarshalJSON satisfies json.Unmarshaler.
type KeyRange ¶
type KeyRange struct { Lower *Key `json:"lower,omitempty"` // Lower bound. Upper *Key `json:"upper,omitempty"` // Upper bound. LowerOpen bool `json:"lowerOpen,omitempty"` // If true lower bound is open. UpperOpen bool `json:"upperOpen,omitempty"` // If true upper bound is open. }
KeyRange key range.
func (KeyRange) MarshalEasyJSON ¶
MarshalEasyJSON supports easyjson.Marshaler interface
func (KeyRange) MarshalJSON ¶
MarshalJSON supports json.Marshaler interface
func (*KeyRange) UnmarshalEasyJSON ¶
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*KeyRange) UnmarshalJSON ¶
UnmarshalJSON supports json.Unmarshaler interface
type KeyType ¶
type KeyType string
KeyType key type.
const ( KeyTypeNumber KeyType = "number" KeyTypeString KeyType = "string" KeyTypeDate KeyType = "date" KeyTypeArray KeyType = "array" )
KeyType values.
func (KeyType) MarshalEasyJSON ¶
MarshalEasyJSON satisfies easyjson.Marshaler.
func (KeyType) MarshalJSON ¶
MarshalJSON satisfies json.Marshaler.
func (*KeyType) UnmarshalEasyJSON ¶
UnmarshalEasyJSON satisfies easyjson.Unmarshaler.
func (*KeyType) UnmarshalJSON ¶
UnmarshalJSON satisfies json.Unmarshaler.
type ObjectStore ¶
type ObjectStore struct { Name string `json:"name,omitempty"` // Object store name. KeyPath *KeyPath `json:"keyPath,omitempty"` // Object store key path. AutoIncrement bool `json:"autoIncrement,omitempty"` // If true, object store has auto increment flag set. Indexes []*ObjectStoreIndex `json:"indexes,omitempty"` // Indexes in this object store. }
ObjectStore object store.
func (ObjectStore) MarshalEasyJSON ¶
func (v ObjectStore) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (ObjectStore) MarshalJSON ¶
func (v ObjectStore) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*ObjectStore) UnmarshalEasyJSON ¶
func (v *ObjectStore) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*ObjectStore) UnmarshalJSON ¶
func (v *ObjectStore) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type ObjectStoreIndex ¶
type ObjectStoreIndex struct { Name string `json:"name,omitempty"` // Index name. KeyPath *KeyPath `json:"keyPath,omitempty"` // Index key path. Unique bool `json:"unique,omitempty"` // If true, index is unique. MultiEntry bool `json:"multiEntry,omitempty"` // If true, index allows multiple entries for a key. }
ObjectStoreIndex object store index.
func (ObjectStoreIndex) MarshalEasyJSON ¶
func (v ObjectStoreIndex) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (ObjectStoreIndex) MarshalJSON ¶
func (v ObjectStoreIndex) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*ObjectStoreIndex) UnmarshalEasyJSON ¶
func (v *ObjectStoreIndex) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*ObjectStoreIndex) UnmarshalJSON ¶
func (v *ObjectStoreIndex) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type RequestDataParams ¶
type RequestDataParams struct { SecurityOrigin string `json:"securityOrigin"` // Security origin. DatabaseName string `json:"databaseName"` // Database name. ObjectStoreName string `json:"objectStoreName"` // Object store name. IndexName string `json:"indexName"` // Index name, empty string for object store data requests. SkipCount int64 `json:"skipCount"` // Number of records to skip. PageSize int64 `json:"pageSize"` // Number of records to fetch. KeyRange *KeyRange `json:"keyRange,omitempty"` // Key range. }
RequestDataParams requests data from object store or index.
func RequestData ¶
func RequestData(securityOrigin string, databaseName string, objectStoreName string, indexName string, skipCount int64, pageSize int64) *RequestDataParams
RequestData requests data from object store or index.
parameters:
securityOrigin - Security origin. databaseName - Database name. objectStoreName - Object store name. indexName - Index name, empty string for object store data requests. skipCount - Number of records to skip. pageSize - Number of records to fetch.
func (*RequestDataParams) Do ¶
func (p *RequestDataParams) Do(ctxt context.Context, h cdp.FrameHandler) (objectStoreDataEntries []*DataEntry, hasMore bool, err error)
Do executes IndexedDB.requestData.
returns:
objectStoreDataEntries - Array of object store data entries. hasMore - If true, there are more entries to fetch in the given range.
func (RequestDataParams) MarshalEasyJSON ¶
func (v RequestDataParams) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (RequestDataParams) MarshalJSON ¶
func (v RequestDataParams) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*RequestDataParams) UnmarshalEasyJSON ¶
func (v *RequestDataParams) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*RequestDataParams) UnmarshalJSON ¶
func (v *RequestDataParams) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
func (RequestDataParams) WithKeyRange ¶
func (p RequestDataParams) WithKeyRange(keyRange *KeyRange) *RequestDataParams
WithKeyRange key range.
type RequestDataReturns ¶
type RequestDataReturns struct { ObjectStoreDataEntries []*DataEntry `json:"objectStoreDataEntries,omitempty"` // Array of object store data entries. HasMore bool `json:"hasMore,omitempty"` // If true, there are more entries to fetch in the given range. }
RequestDataReturns return values.
func (RequestDataReturns) MarshalEasyJSON ¶
func (v RequestDataReturns) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (RequestDataReturns) MarshalJSON ¶
func (v RequestDataReturns) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*RequestDataReturns) UnmarshalEasyJSON ¶
func (v *RequestDataReturns) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*RequestDataReturns) UnmarshalJSON ¶
func (v *RequestDataReturns) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type RequestDatabaseNamesParams ¶
type RequestDatabaseNamesParams struct {
SecurityOrigin string `json:"securityOrigin"` // Security origin.
}
RequestDatabaseNamesParams requests database names for given security origin.
func RequestDatabaseNames ¶
func RequestDatabaseNames(securityOrigin string) *RequestDatabaseNamesParams
RequestDatabaseNames requests database names for given security origin.
parameters:
securityOrigin - Security origin.
func (*RequestDatabaseNamesParams) Do ¶
func (p *RequestDatabaseNamesParams) Do(ctxt context.Context, h cdp.FrameHandler) (databaseNames []string, err error)
Do executes IndexedDB.requestDatabaseNames.
returns:
databaseNames - Database names for origin.
func (RequestDatabaseNamesParams) MarshalEasyJSON ¶
func (v RequestDatabaseNamesParams) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (RequestDatabaseNamesParams) MarshalJSON ¶
func (v RequestDatabaseNamesParams) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*RequestDatabaseNamesParams) UnmarshalEasyJSON ¶
func (v *RequestDatabaseNamesParams) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*RequestDatabaseNamesParams) UnmarshalJSON ¶
func (v *RequestDatabaseNamesParams) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type RequestDatabaseNamesReturns ¶
type RequestDatabaseNamesReturns struct {
DatabaseNames []string `json:"databaseNames,omitempty"` // Database names for origin.
}
RequestDatabaseNamesReturns return values.
func (RequestDatabaseNamesReturns) MarshalEasyJSON ¶
func (v RequestDatabaseNamesReturns) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (RequestDatabaseNamesReturns) MarshalJSON ¶
func (v RequestDatabaseNamesReturns) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*RequestDatabaseNamesReturns) UnmarshalEasyJSON ¶
func (v *RequestDatabaseNamesReturns) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*RequestDatabaseNamesReturns) UnmarshalJSON ¶
func (v *RequestDatabaseNamesReturns) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type RequestDatabaseParams ¶
type RequestDatabaseParams struct { SecurityOrigin string `json:"securityOrigin"` // Security origin. DatabaseName string `json:"databaseName"` // Database name. }
RequestDatabaseParams requests database with given name in given frame.
func RequestDatabase ¶
func RequestDatabase(securityOrigin string, databaseName string) *RequestDatabaseParams
RequestDatabase requests database with given name in given frame.
parameters:
securityOrigin - Security origin. databaseName - Database name.
func (*RequestDatabaseParams) Do ¶
func (p *RequestDatabaseParams) Do(ctxt context.Context, h cdp.FrameHandler) (databaseWithObjectStores *DatabaseWithObjectStores, err error)
Do executes IndexedDB.requestDatabase.
returns:
databaseWithObjectStores - Database with an array of object stores.
func (RequestDatabaseParams) MarshalEasyJSON ¶
func (v RequestDatabaseParams) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (RequestDatabaseParams) MarshalJSON ¶
func (v RequestDatabaseParams) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*RequestDatabaseParams) UnmarshalEasyJSON ¶
func (v *RequestDatabaseParams) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*RequestDatabaseParams) UnmarshalJSON ¶
func (v *RequestDatabaseParams) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type RequestDatabaseReturns ¶
type RequestDatabaseReturns struct {
DatabaseWithObjectStores *DatabaseWithObjectStores `json:"databaseWithObjectStores,omitempty"` // Database with an array of object stores.
}
RequestDatabaseReturns return values.
func (RequestDatabaseReturns) MarshalEasyJSON ¶
func (v RequestDatabaseReturns) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (RequestDatabaseReturns) MarshalJSON ¶
func (v RequestDatabaseReturns) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*RequestDatabaseReturns) UnmarshalEasyJSON ¶
func (v *RequestDatabaseReturns) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*RequestDatabaseReturns) UnmarshalJSON ¶
func (v *RequestDatabaseReturns) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface