@hiloenergie/capacitor-plugin-shared-storage
Share data between app and native widgets
Install
npm install @hiloenergie/capacitor-plugin-shared-storage
npx cap syncAPI
configure(...)
configure(options: ConfigureOptions) => Promise<void>Configure the Shared Storage plugin at runtime.
Options that are undefined will not be used.
| Param | Type |
|---|---|
options |
ConfigureOptions |
Since: 0.0.1
get(...)
get(options: GetOptions) => Promise<GetResult>Get the value from preferences of a given key.
| Param | Type |
|---|---|
options |
GetOptions |
Returns: Promise<GetResult>
Since: 0.0.1
set(...)
set(options: SetOptions) => Promise<void>Set the value in preferences for a given key.
| Param | Type |
|---|---|
options |
SetOptions |
Since: 0.0.1
remove(...)
remove(options: RemoveOptions) => Promise<void>Remove the value from preferences for a given key, if any.
| Param | Type |
|---|---|
options |
RemoveOptions |
Since: 0.0.1
clear()
clear() => Promise<void>Clear keys and values from preferences.
Since: 0.0.1
keys()
keys() => Promise<KeysResult>Return the list of known keys in preferences.
Returns: Promise<KeysResult>
Since: 0.0.1
Interfaces
ConfigureOptions
| Prop | Type | Description | Since |
|---|---|---|---|
group |
string |
Set the preferences group. Preferences groups are used to organize key/value pairs. | 0.0.1 |
suiteName |
string |
iOS Only Set the suiteName, which equals de App Group Id created to share data between widgets through UserDefaults | 0.0.2 |
widgetKind |
string |
iOS Only Set the widgetKind to refresh a specific widget timeline If no widgetKind is specified, all widget Timelines will be updated by the plugin | 0.0.2 |
GetResult
| Prop | Type | Description | Since |
|---|---|---|---|
value |
string | null |
The value from preferences associated with the given key. If a value was not previously set or was removed, value will be null. |
0.0.1 |
GetOptions
| Prop | Type | Description | Since |
|---|---|---|---|
key |
string |
The key whose value to retrieve from preferences. | 0.0.1 |
SetOptions
| Prop | Type | Description | Since |
|---|---|---|---|
key |
string |
The key to associate with the value being set in preferences. | 0.0.1 |
value |
string |
The value to set in preferences with the associated key. | 0.0.1 |
RemoveOptions
| Prop | Type | Description | Since |
|---|---|---|---|
key |
string |
The key whose value to remove from preferences. | 0.0.1 |
KeysResult
| Prop | Type | Description | Since |
|---|---|---|---|
keys |
string[] |
The known keys in preferences. | 0.0.1 |