GenerallyPositive.Browser.StorageAction Class Reference

Represents a single storage-related action to perform before navigating to a URL. More...

Public Member Functions
	StorageAction (StorageAction action)

Properties
WebsiteStorageAction	Action = WebsiteStorageAction.notSet [get, set]
	The action to perform: "get", "set", or "delete".
WebsiteStorageType	StorageType = WebsiteStorageType.notSet [get, set]
	The target storage type (cookies, localStorage, indexedDb, etc.).
string	Key [get, set]
	Key name for localStorage, sessionStorage, IndexedDB, or cookie name.
string	Path [get, set]
	Path restriction (primarily for cookies).
string	Domain [get, set]
	Domain restriction (primarily for cookies).
string	StoreName [get, set]
	IndexedDB object store name.
string	Data [get, set]
	Value to get/set (used when Action = "get" or "set"). NOTE: context sensitive (json) data NOTE: Data can vary by impelementation as exposed by the respective API.
bool	IncludeProvenance [get, set]
	For wildcard storage gets returning multiple elements. If set to true, return domain, path, storename (if applicable) and key to locate the returned value Otherwise, just return a list of string values.
string	UserDefined [get, set]
	User defined data strictly used for filtering in GPAL, can store any data of value.
bool	DeleteAcrossOrigins = false [get, set]
	OttoMagic Only: For delete operations without a domain, limit to origin? true = delete across origins false = delete only in the current origin (default).

Detailed Description

Represents a single storage-related action to perform before navigating to a URL.

Definition at line 273 of file GPALUrl.cs.

Constructor & Destructor Documentation

StorageAction() [1/2]

GenerallyPositive.Browser.StorageAction.StorageAction

(

)

Definition at line 275 of file GPALUrl.cs.

StorageAction() [2/2]

GenerallyPositive.Browser.StorageAction.StorageAction

(

StorageAction

action

)

Definition at line 279 of file GPALUrl.cs.

Property Documentation

Action

WebsiteStorageAction GenerallyPositive.Browser.StorageAction.Action = WebsiteStorageAction.notSet

getset

The action to perform: "get", "set", or "delete".

Definition at line 293 of file GPALUrl.cs.

Data

string GenerallyPositive.Browser.StorageAction.Data

getset

Value to get/set (used when Action = "get" or "set"). NOTE: context sensitive (json) data NOTE: Data can vary by impelementation as exposed by the respective API.

Definition at line 327 of file GPALUrl.cs.

DeleteAcrossOrigins

bool GenerallyPositive.Browser.StorageAction.DeleteAcrossOrigins = false

getset

OttoMagic Only: For delete operations without a domain, limit to origin? true = delete across origins false = delete only in the current origin (default).

Definition at line 351 of file GPALUrl.cs.

Domain

string GenerallyPositive.Browser.StorageAction.Domain

getset

Domain restriction (primarily for cookies).

Definition at line 313 of file GPALUrl.cs.

IncludeProvenance

bool GenerallyPositive.Browser.StorageAction.IncludeProvenance

getset

For wildcard storage gets returning multiple elements. If set to true, return domain, path, storename (if applicable) and key to locate the returned value Otherwise, just return a list of string values.

Definition at line 339 of file GPALUrl.cs.

Key

string GenerallyPositive.Browser.StorageAction.Key

getset

Key name for localStorage, sessionStorage, IndexedDB, or cookie name.

Definition at line 303 of file GPALUrl.cs.

Path

string GenerallyPositive.Browser.StorageAction.Path

getset

Path restriction (primarily for cookies).

Definition at line 308 of file GPALUrl.cs.

StorageType

WebsiteStorageType GenerallyPositive.Browser.StorageAction.StorageType = WebsiteStorageType.notSet

getset

The target storage type (cookies, localStorage, indexedDb, etc.).

Definition at line 298 of file GPALUrl.cs.

StoreName

string GenerallyPositive.Browser.StorageAction.StoreName

getset

IndexedDB object store name.

Definition at line 318 of file GPALUrl.cs.

UserDefined

string GenerallyPositive.Browser.StorageAction.UserDefined

getset

User defined data strictly used for filtering in GPAL, can store any data of value.

Definition at line 344 of file GPALUrl.cs.

---

The documentation for this class was generated from the following file:

• Browser/GPALUrl.cs