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(...)
• Interfaces

getItem(...)

getItem(options: UserDefaultsOptions) => any

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

Param	Type
options	UserDefaultsOptions

Returns: any

Since: 0.0.1

---

setItem(...)

setItem(options: UserDefaultsOptions) => any

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

Param	Type
options	UserDefaultsOptions

Returns: any

Since: 0.0.1

---

removeItem(...)

removeItem(options: UserDefaultsOptions) => any

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

Param	Type
options	UserDefaultsOptions

Returns: any

Since: 0.0.1

---

reloadAllTimelines()

reloadAllTimelines() => any

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

Returns: any

Since: 0.0.1

---

reloadTimelines(...)

reloadTimelines(options: TimelinesOptions) => any

Reloads the timelines for all widgets of a particular kind

Param	Type
options	TimelinesOptions

Returns: any

Since: 0.0.1

---

Interfaces

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

DataResults

Prop	Type	Description	Since
results	T	Holds response results from native code	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