0.0.2 • Published 4 months ago

capacitor-geofence-background v0.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

capacitor-geofence-background

This plugin track your location in app kill state

Install

npm install capacitor-geofence-background
npx cap sync

API

startLocationService()

startLocationService() => Promise<void>

stopLocationService()

stopLocationService() => Promise<void>

checkAndRequestPermissions()

checkAndRequestPermissions() => Promise<void>

addGeofence(...)

addGeofence(options: { id: string; latitude: number; longitude: number; radius: number; transitionType: number; }) => Promise<void>
ParamType
options{ id: string; latitude: number; longitude: number; radius: number; transitionType: number; }

removeGeofence(...)

removeGeofence(options: { id: string; }) => Promise<void>
ParamType
options{ id: string; }

removeAllGeofences()

removeAllGeofences() => Promise<void>

getGeofences()

getGeofences() => Promise<{ geofences: any[]; }>

Returns: Promise<{ geofences: any[]; }>


getLocations()

getLocations() => Promise<{ locations: any[]; }>

Returns: Promise<{ locations: any[]; }>


getPermissionsStatus()

getPermissionsStatus() => Promise<{ status: string; }>

Returns: Promise<{ status: string; }>


isIgnoringBatteryOptimizations()

isIgnoringBatteryOptimizations() => Promise<{ isIgnoring: boolean; }>

Returns: Promise<{ isIgnoring: boolean; }>


requestIgnoreBatteryOptimizations()

requestIgnoreBatteryOptimizations() => Promise<void>

openSettings()

openSettings() => Promise<void>

isLocationServiceRunning()

isLocationServiceRunning() => Promise<{ isRunning: boolean; }>

Returns: Promise<{ isRunning: boolean; }>


isGooglePlayServicesAvailable()

isGooglePlayServicesAvailable() => Promise<{ isAvailable: boolean; }>

Returns: Promise<{ isAvailable: boolean; }>


requestGooglePlayServices()

requestGooglePlayServices() => Promise<void>

isLocationEnabled()

isLocationEnabled() => Promise<{ isEnabled: boolean; }>

Returns: Promise<{ isEnabled: boolean; }>


requestLocationEnabling()

requestLocationEnabling() => Promise<void>

isBackgroundLocationPermissionGranted()

isBackgroundLocationPermissionGranted() => Promise<{ isGranted: boolean; }>

Returns: Promise<{ isGranted: boolean; }>


requestBackgroundLocationPermission()

requestBackgroundLocationPermission() => Promise<void>

isIgnoringOptimizations()

isIgnoringOptimizations() => Promise<{ isIgnoring: boolean; }>

Returns: Promise<{ isIgnoring: boolean; }>


requestIgnoreOptimizations()

requestIgnoreOptimizations() => Promise<void>

isIgnoringDataSaver()

isIgnoringDataSaver() => Promise<{ isIgnoring: boolean; }>

Returns: Promise<{ isIgnoring: boolean; }>


requestIgnoreDataSaver()

requestIgnoreDataSaver() => Promise<void>