Class: UserDataStorage

dg.UserDataStorage

Functionality for working with remote Users Data Storage Remote storage allows to save key-value pairs on the Datagrok server for further use

Constructors

constructor

• new UserDataStorage()

Defined in

src/dapi.ts:734

Methods

get

▸ get(name, currentUser?): Promise<any>

Retrieves a map from Users Data Storage

Parameters

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

Returns

Promise<any>

Defined in

src/dapi.ts:769

---

getValue

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

Retrieves a single value from Users Data Storage

Parameters

Name	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>

Defined in

src/dapi.ts:778

---

post

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

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

Parameters

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

Returns

Promise<void>

Defined in

src/dapi.ts:752

---

postValue

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

Saves a single value to Users Data Storage

Parameters

Name	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>

Defined in

src/dapi.ts:743

---

put

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

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

Parameters

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

Returns

Promise<void>

Defined in

src/dapi.ts:761

---

remove

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

Removes a single value from Users Data Storage

Parameters

Name	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>

Defined in

src/dapi.ts:787