UserDataStorage
Defined in: src/dapi.ts:706
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
Constructor
new UserDataStorage():
UserDataStorage
Defined in: src/dapi.ts:707
Returns
UserDataStorage
Methods
get()
get(
name,currentUser?):Promise<any>
Defined in: src/dapi.ts:732
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>
getValue()
getValue(
name,key,currentUser?):Promise<string>
Defined in: src/dapi.ts:741
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>
post()
post(
name,data,currentUser?):Promise<void>
Defined in: src/dapi.ts:719
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>
postValue()
postValue(
name,key,value,currentUser?):Promise<void>
Defined in: src/dapi.ts:713
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>
put()
put(
name,data,currentUser?):Promise<void>
Defined in: src/dapi.ts:725
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>
remove()
remove(
name,key,currentUser?):Promise<void>
Defined in: src/dapi.ts:750
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>