1.2.2 • Published 1 year ago
stefanskia-capacitor-plugin-background-mode v1.2.2
capacitor-plugin-background-mode (DEPRECATED)
Capacitor plugin to perform infinite background execution
This plugin was replaced with @anuradev/capacitor-background-mode
Install
npm install capacitor-plugin-background-mode
npx cap sync
API
enable()
disable()
getSettings()
setSettings(...)
checkForegroundPermission()
requestForegroundPermission()
isIgnoringBatteryOptimizations()
disableBatteryOptimizations()
enableWebViewOptimizations()
disableWebViewOptimizations()
moveToBackground()
moveToForeground()
isScreenOff()
isEnabled()
isActive()
wakeUp()
unlock()
addListener('appInBackground', ...)
addListener('appInForeground', ...)
removeAllListeners()
- Interfaces
- Type Aliases
enable()
enable() => Promise<void>
disable()
disable() => Promise<void>
getSettings()
getSettings() => Promise<{ settings: ISettings; }>
Returns: Promise<{ settings: ISettings; }>
setSettings(...)
setSettings(settings: Partial<ISettings>) => Promise<void>
Param | Type |
---|---|
settings | Partial<ISettings> |
checkForegroundPermission()
checkForegroundPermission() => Promise<{ enabled: boolean; }>
Returns: Promise<{ enabled: boolean; }>
requestForegroundPermission()
requestForegroundPermission() => Promise<void>
isIgnoringBatteryOptimizations()
isIgnoringBatteryOptimizations() => Promise<{ isIgnoring: boolean; }>
Returns: Promise<{ isIgnoring: boolean; }>
disableBatteryOptimizations()
disableBatteryOptimizations() => Promise<void>
enableWebViewOptimizations()
enableWebViewOptimizations() => Promise<void>
disableWebViewOptimizations()
disableWebViewOptimizations() => Promise<void>
moveToBackground()
moveToBackground() => Promise<void>
moveToForeground()
moveToForeground() => Promise<void>
isScreenOff()
isScreenOff() => Promise<{ isScreenOff: boolean; }>
Returns: Promise<{ isScreenOff: boolean; }>
isEnabled()
isEnabled() => Promise<{ enabled: boolean; }>
Returns: Promise<{ enabled: boolean; }>
isActive()
isActive() => Promise<{ activated: boolean; }>
Returns: Promise<{ activated: boolean; }>
wakeUp()
wakeUp() => Promise<void>
unlock()
unlock() => Promise<void>
addListener('appInBackground', ...)
addListener(eventName: 'appInBackground', listenerFunc: () => void) => Promise<PluginListenerHandle> & PluginListenerHandle
Param | Type |
---|---|
eventName | 'appInBackground' |
listenerFunc | () => void |
Returns: Promise<PluginListenerHandle> & PluginListenerHandle
addListener('appInForeground', ...)
addListener(eventName: 'appInForeground', listenerFunc: () => void) => Promise<PluginListenerHandle> & PluginListenerHandle
Param | Type |
---|---|
eventName | 'appInForeground' |
listenerFunc | () => void |
Returns: Promise<PluginListenerHandle> & PluginListenerHandle
removeAllListeners()
removeAllListeners() => Promise<void>
Interfaces
ISettings
Prop | Type |
---|---|
title | string |
text | string |
subText | string |
bigText | boolean |
resume | boolean |
silent | boolean |
hidden | boolean |
color | string |
icon | string |
channelName | string |
channelDescription | string |
allowClose | boolean |
closeIcon | string |
closeTitle | string |
showWhen | boolean |
disableWebViewOptimization | boolean |
visibility | 'public' | 'private' | 'secret' |
PluginListenerHandle
Prop | Type |
---|---|
remove | () => Promise<void> |
Type Aliases
Partial
Make all properties in T optional
{ P in keyof T?: TP; }
1.2.2
1 year ago