capacitor-widgetsbridge-plugin

Capacitor plugin to interact with ios widgetkit

Demo

Install

npm install capacitor-widgetsbridge-plugin
npx cap sync

API

• getItem(...)
• setItem(...)
• removeItem(...)
• reloadAllTimelines()
• reloadTimelines(...)
• getCurrentConfigurations()
• Interfaces

getItem(...)

getItem(options: UserDefaultsOptions) => Promise<DataResults<any>>

Return the value from user’s defaults database associated with the specified key

Param	Type
options	UserDefaultsOptions

Returns: Promise<DataResults<any>>

Since: 0.0.1

---

setItem(...)

setItem(options: UserDefaultsOptions) => Promise<DataResults<boolean>>

Set the value to user’s defaults database associated with the specified key

Param	Type
options	UserDefaultsOptions

Returns: Promise<DataResults<boolean>>

Since: 0.0.1

---

removeItem(...)

removeItem(options: UserDefaultsOptions) => Promise<DataResults<boolean>>

Remove the value from user’s defaults database associated with the specified key

Param	Type
options	UserDefaultsOptions

Returns: Promise<DataResults<boolean>>

Since: 0.0.1

---

reloadAllTimelines()

reloadAllTimelines() => Promise<DataResults<boolean>>

Reloads the timelines for all configured widgets belonging to the containing app

Returns: Promise<DataResults<boolean>>

Since: 0.0.1

---

reloadTimelines(...)

reloadTimelines(options: TimelinesOptions) => Promise<DataResults<boolean>>

Reloads the timelines for all widgets of a particular kind

Param	Type
options	TimelinesOptions

Returns: Promise<DataResults<boolean>>

Since: 0.0.1

---

getCurrentConfigurations()

getCurrentConfigurations() => Promise<DataResults<any>>

Get current widget configurations

Returns: Promise<DataResults<any>>

Since: 0.0.1

---

Interfaces

DataResults

Prop	Type	Description	Since
results	T	Holds response results from native code	0.0.1

UserDefaultsOptions

Prop	Type	Description	Since
key	string	The key whose value to retrieve from storage.	0.0.1
group	string	User defaults database name which holds and organizes key/value pairs	0.0.1
value	string	The value to set in storage with the associated key	0.0.1

TimelinesOptions

Prop	Type	Description	Since
ofKind	string	A string that identifies the widget and matches the value you used when you created the widget’s configuration	0.0.1