UserDataStorage

Deprecated

The UserDataStorage should not be used. Use UserSettingsStorage instead Functionality for working with remote Users Data Storage Remote storage allows to save key-value pairs on the Datagrok server for further use

Constructors

new UserDataStorage()

new UserDataStorage(): UserDataStorage

Returns

UserDataStorage

Source

src/dapi.ts:708

Methods

get()

get(name, currentUser): Promise<any>

Retrieves a map from Users Data Storage

Parameters

Parameter	Type	Default value	Description
name	string	undefined	-
currentUser	boolean	true	get a value from a current user storage. If false, shared storage is used.

Returns

Promise<any>

Source

src/dapi.ts:733

---

getValue()

getValue(name, key, currentUser): Promise<string>

Retrieves a single value from Users Data Storage

Parameters

Parameter	Type	Default value	Description
name	string	undefined	Storage name
key	string	undefined	Value key
currentUser	boolean	true	get a value from a current user storage. If false, shared storage is used.

Returns

Promise<string>

Source

src/dapi.ts:742

---

post()

post(name, data, currentUser): Promise<void>

Saves a map to Users Data Storage, will be appended to existing data

Parameters

Parameter	Type	Default value	Description
name	string	undefined	-
data	any	undefined	-
currentUser	boolean	true	Value should be available only for current user. If false, shared storage is used.

Returns

Promise<void>

Source

src/dapi.ts:720

---

postValue()

postValue(name, key, value, currentUser): Promise<void>

Saves a single value to Users Data Storage

Parameters

Parameter	Type	Default value	Description
name	string	undefined	Storage name
key	string	undefined	-
value	string	undefined	-
currentUser	boolean	true	Value should be available only for current user. If false, shared storage is used.

Returns

Promise<void>

Source

src/dapi.ts:714

---

put()

put(name, data, currentUser): Promise<void>

Saves a map to Users Data Storage, will replace existing data

Parameters

Parameter	Type	Default value	Description
name	string	undefined	-
data	any	undefined	-
currentUser	boolean	true	Value should be available only for current user. If false, shared storage is used.

Returns

Promise<void>

Source

src/dapi.ts:726

---

remove()

remove(name, key, currentUser): Promise<void>

Removes a single value from Users Data Storage

Parameters

Parameter	Type	Default value	Description
name	string	undefined	Storage name
key	string	undefined	Value key
currentUser	boolean	true	get a value from a current user storage. If false, shared storage is used.

Returns

Promise<void>

Source

src/dapi.ts:751