Interface GeofenceEvent

Emitted by BackgroundGeolocation.onGeofence.

interface GeofenceEvent {
    timestamp: string;
    identifier: string;
    action: GeofenceAction;
    location: Location;
    extras?: Record<string, any>;
    geofence?: Geofence;
}

Index

Properties

timestamp identifier action location extras? geofence?

Properties

timestamp

timestamp: string

Device system time when the OS received the geofence event.

identifier

identifier: string

Identifier of the geofence which fired.

action

action: GeofenceAction

Transition type: 'ENTER' | 'EXIT' | 'DWELL'.

location

location: Location

Location where the geofence transition occurred.

`Optional`extras

extras?: Record<string, any>

Optional extras originally configured on the Geofence.

`Optional`geofence

geofence?: Geofence

Geofence record which fired