capacitor-foreground

Tracking the location of the user

Install

npm install capacitor-foreground
npx cap sync

API

• echo(...)
• startTracking(...)
• stopTracking()
• pauseTimer()
• playTimer()
• stopAllServices()
• stopRunningTask()
• waitForAlarmPermission()
• startTaskTracking(...)
• deleteTask()
• syncData()
• checkBiometric()
• addListener('trackingTimeUpdated', ...)
• addListener('trackerModeChanged', ...)
• addListener('serviceStopped', ...)
• addListener('signOutMode', ...)
• addListener('mobileTrackingResponse', ...)
• addListener('runningTaskTimeUpdated', ...)
• addListener('timesheetDate', ...)
• Interfaces

echo(...)

echo(options: { value: string; }) => Promise<{ value: string; }>

| Param | Type | | ------------- | ------------------------------- | | options | { value: string; } |

Returns: Promise<{ value: string; }>

startTracking(...)

startTracking(options: StartTrackingOptions) => Promise<void>

| Param | Type | | ------------- | --------------------------------------------------------------------- | | options | StartTrackingOptions |

stopTracking()

stopTracking() => Promise<void>

pauseTimer()

pauseTimer() => Promise<void>

playTimer()

playTimer() => Promise<void>

stopAllServices()

stopAllServices() => Promise<void>

stopRunningTask()

stopRunningTask() => Promise<void>

waitForAlarmPermission()

waitForAlarmPermission() => Promise<{ granted: boolean; }>

Returns: Promise<{ granted: boolean; }>

startTaskTracking(...)

startTaskTracking(options: TaskTrackingOptions) => Promise<void>

| Param | Type | | ------------- | ------------------------------------------------------------------- | | options | TaskTrackingOptions |

deleteTask()

deleteTask() => Promise<void>

syncData()

syncData() => Promise<void>

checkBiometric()

checkBiometric() => Promise<{ granted: boolean; }>

Returns: Promise<{ granted: boolean; }>

addListener('trackingTimeUpdated', ...)

addListener(eventName: 'trackingTimeUpdated', listenerFunc: (data: { totalWorkingSeconds: number; }) => void) => Promise<PluginListenerHandle>

| Param | Type | | ------------------ | ---------------------------------------------------------------- | | eventName | 'trackingTimeUpdated' | | listenerFunc | (data: { totalWorkingSeconds: number; }) => void |

Returns: Promise<PluginListenerHandle>

addListener('trackerModeChanged', ...)

addListener(eventName: 'trackerModeChanged', listenerFunc: (data: { trackerMode: string; }) => void) => Promise<PluginListenerHandle>

| Param | Type | | ------------------ | -------------------------------------------------------- | | eventName | 'trackerModeChanged' | | listenerFunc | (data: { trackerMode: string; }) => void |

Returns: Promise<PluginListenerHandle>

addListener('serviceStopped', ...)

addListener(eventName: 'serviceStopped', listenerFunc: (data: { isServiceStopped: boolean; }) => void) => Promise<PluginListenerHandle>

| Param | Type | | ------------------ | -------------------------------------------------------------- | | eventName | 'serviceStopped' | | listenerFunc | (data: { isServiceStopped: boolean; }) => void |

Returns: Promise<PluginListenerHandle>

addListener('signOutMode', ...)

addListener(eventName: 'signOutMode', listenerFunc: (data: { isUserSignOut: boolean; }) => void) => Promise<PluginListenerHandle>

| Param | Type | | ------------------ | ----------------------------------------------------------- | | eventName | 'signOutMode' | | listenerFunc | (data: { isUserSignOut: boolean; }) => void |

Returns: Promise<PluginListenerHandle>

addListener('mobileTrackingResponse', ...)

addListener(eventName: 'mobileTrackingResponse', listenerFunc: (data: { response: string; }) => void) => Promise<PluginListenerHandle>

| Param | Type | | ------------------ | ----------------------------------------------------- | | eventName | 'mobileTrackingResponse' | | listenerFunc | (data: { response: string; }) => void |

Returns: Promise<PluginListenerHandle>

addListener('runningTaskTimeUpdated', ...)

addListener(eventName: 'runningTaskTimeUpdated', listenerFunc: (data: { response: any; }) => void) => Promise<PluginListenerHandle>

| Param | Type | | ------------------ | -------------------------------------------------- | | eventName | 'runningTaskTimeUpdated' | | listenerFunc | (data: { response: any; }) => void |

Returns: Promise<PluginListenerHandle>

addListener('timesheetDate', ...)

addListener(eventName: 'timesheetDate', listenerFunc: (data: { response: any; }) => void) => Promise<PluginListenerHandle>

| Param | Type | | ------------------ | -------------------------------------------------- | | eventName | 'timesheetDate' | | listenerFunc | (data: { response: any; }) => void |

Returns: Promise<PluginListenerHandle>

Interfaces

StartTrackingOptions

| Prop | Type | | ------------------------- | -------------------- | | userId | string | | userName | string | | companyId | string | | apiUrl | string | | signalRUrl | string | | authToken | string | | apiBasePaths | string | | trackingInterval | number | | syncPeriod | string | | geofencePeriod | string | | configurationPeriod | string | | trackerMode | string | | isStartedManually | boolean | | isTaskMandatory | boolean | | taskId | string | | taskName | string | | projectId | string | | offsetMinutes | string | | userUniqueId | string |

TaskTrackingOptions

| Prop | Type | | --------------- | ------------------- | | taskId | string | | taskName | string | | projectId | string |

PluginListenerHandle

| Prop | Type | | ------------ | ----------------------------------------- | | remove | () => Promise<void> |