MCPcopy Create free account

hub / github.com/transistorsoft/react-native-background-geolocation / types & classes

Types & classes85 in github.com/transistorsoft/react-native-background-geolocation

Class
mocks/react-native.js:3
Class
src/index.js:83
Class
src/TransistorAuthorizationService.js:17
Class
src/DeviceSettings.js:15
Class
src/NativeModule.js:83
Class
src/NativeModule.js:160
Class
src/Logger.js:30
Class
bin/lib.js:4
ClassActivityChangeCallback
activitychange event callback
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/RNBackgroundGeolocationModule.java:196
InterfaceAuthorization
* Configures the SDK for authorization wtih your server's [[accessToken]] token (eg: [JSON Web Token](https://jwt.io/)) and automatically requests new
src/declarations/interfaces/Authorization.d.ts:62
ClassAuthorizationCallback
authorization event callback
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/RNBackgroundGeolocationModule.java:309
InterfaceAuthorizationEvent
* The event-object provided to [[BackgroundGeolocation.onAuthorization]] * * @example * ```typescript * BackgroundGeolocation.onAuthorization(auth
src/declarations/interfaces/AuthorizationEvent.d.ts:16
ClassBackgroundGeolocation
src/index.js:83
InterfaceBattery
* This object is attached to instances of [[Location.battery]].
src/declarations/interfaces/Location.d.ts:84
ClassBuilder
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/HeadlessTaskManager.java:407
ClassCLIError
bin/lib.js:4
InterfaceConfig
* ## 🔧 Configuration API. * * The following configuration options are used to configure the SDK via the methods [[BackgroundGeolocation.ready]] an
src/declarations/interfaces/Config.d.ts:169
InterfaceConfigViewProps
example/Advanced/src/ConfigView.tsx:25
ClassConnectivityChangeCallback
connectivitychange event callback
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/RNBackgroundGeolocationModule.java:220
InterfaceConnectivityChangeEvent
* The event-object provided to [[BackgroundGeolocation.onConnectivityChange]] * * @example * ```typescript * BackgroundGeolocation.onConnectivityC
src/declarations/interfaces/ConnectivityChangeEvent.d.ts:12
ClassContextError
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/HeadlessTaskManager.java:453
InterfaceCoords
* This object is attached to instances of [[Location.coords]].
src/declarations/interfaces/Location.d.ts:10
InterfaceCurrentPositionRequest
* Options provided to [[getCurrentPosition]]. * * @example * ```typescript * let location = await BackgroundGeolocation.getCurrentPosition({
src/declarations/interfaces/CurrentPositionRequest.d.ts:19
InterfaceDeviceInfo
* Simple device information, much simpler than other 3rd party libraries. * * @example * ```typescript * let deviceInfo = await BackgroundGeol
src/declarations/interfaces/DeviceInfo.d.ts:10
ClassDeviceSettings
src/DeviceSettings.js:15
InterfaceDeviceSettings
* Device Settings API. * * Provides an API to show Android & vendor-specific Battery / Power Management settings screens that can affect performance
src/declarations/interfaces/DeviceSettings.d.ts:84
InterfaceDeviceSettingsRequest
* An object for redirecting a User to an Android device's settings screen from a [DeviceSettings] request. * * This object contains meta-data about
src/declarations/interfaces/DeviceSettings.d.ts:9
InterfaceDropdownFieldProps
example/Advanced/src/components/DropdownField.tsx:15
ClassEnabledChangeCallback
enabledchange event callback
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/RNBackgroundGeolocationModule.java:230
InterfaceFABMenuProps
example/Advanced/src/FABMenu.tsx:35
InterfaceGeofence
* The Background Geolocation SDK implements the native iOS and Android Geofencing APIs. * * __ℹ️ Note:__ * - Native iOS & Android API support on
src/declarations/interfaces/Geofence.d.ts:223
ClassGeofenceCallback
geofence event callback
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/RNBackgroundGeolocationModule.java:259
InterfaceGeofenceEvent
* The event-object provided to [[BackgroundGeolocation.onGeofence]] when a geofence transition event occurs. * * @example * ```typescript * Ba
src/declarations/interfaces/GeofenceEvent.d.ts:12
ClassGeofencesChangeCallback
geofenceschange event callback
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/RNBackgroundGeolocationModule.java:246
InterfaceGeofencesChangeEvent
* The event-object provided to [[BackgroundGeolocation.onGeofencesChange]]. * * The [[GeofencesChangeEvent]] provides only the *changed* geofences
src/declarations/interfaces/GeofencesChangeEvent.d.ts:18
InterfaceHeadlessEvent
* This is the event-object provided to Android headless-tasks registered via [[BackgroundGeolocation.registerHeadlessTask]]. * * @example *
src/declarations/interfaces/HeadlessEvent.d.ts:38
ClassHeadlessTask
The BackgroundGeolocation SDK creates a single instance of this class (via reflection upon Config.headlessJobService) The SDK delivers events to this
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/HeadlessTask.java:28
ClassHeadlessTaskManager
This is a general singleton for managing invoking RN headless-tasks. This class could be copied and implemented in any plugin. RN headless-tasks hav
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/HeadlessTaskManager.java:70
ClassHeartbeatCallback
heartbeat event callback
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/RNBackgroundGeolocationModule.java:268
InterfaceHeartbeatEvent
* The event-object provided to [[BackgroundGeolocation.onHeartbeat]] * * @example * ```typescript * BackgroundGeolocation.onHeartbeat(heartbea
src/declarations/interfaces/HeartbeatEvent.d.ts:12
InterfaceHttpEvent
* The event-object provided to [[BackgroundGeolocation.onHttp]] when an HTTP response arrives from your configured [[Config.url]]. * * @example
src/declarations/interfaces/HttpEvent.d.ts:299
ClassHttpResponseCallback
http event callback
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/RNBackgroundGeolocationModule.java:277
InterfaceLocation
src/declarations/interfaces/Location.d.ts:192
InterfaceLocationAuthorizationAlert
* __`[iOS only]`__ Controls the text-elements of the plugin's location-authorization dialog. * * When you configure the plugin [[locationAuthoriza
src/declarations/interfaces/LocationAuthorizationAlert.d.ts:9
ClassLocationCallback
location event callback
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/RNBackgroundGeolocationModule.java:165
ClassLocationProviderChangeCallback
providerchange event callback
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/RNBackgroundGeolocationModule.java:205
ClassLogger
src/Logger.js:30
InterfaceLogger
* # Logger API * * The Background Geolocation SDK includes powerful logging features for debugging location-tracking problems. The SDK stores log
src/declarations/interfaces/Logger.d.ts:96
InterfaceMotionActivity
* The last known motion-activity when this location was recorded.
src/declarations/interfaces/Location.d.ts:98
InterfaceMotionActivityEvent
* The event-object provided to [[BackgroundGeolocation.onActivityChange]]. * * @example * ```typescript * BackgroundGeolocation.onActivityChan
src/declarations/interfaces/MotionActivityEvent.d.ts:14
ClassMotionChangeCallback
motionchange event callback
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/RNBackgroundGeolocationModule.java:179
InterfaceMotionChangeEvent
* The event-object provided to [[BackgroundGeolocation.onMotionChange]] when the SDK changes state between *moving* and *stationary*.
src/declarations/interfaces/MotionChangeEvent.d.ts:5
ClassNativeEventEmitter
mocks/react-native.js:3
ClassNativeModule
src/NativeModule.js:160
InterfaceNotification
* __[Android only]__ The Android operating system requires a persistent notification when running a foreground service. * * ![](https://dl.dropbox
src/declarations/interfaces/Notification.d.ts:35
ClassNotificationActionCallback
notificationaction event callback
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/RNBackgroundGeolocationModule.java:238
InterfaceOnErrorCallback
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/HeadlessTaskManager.java:465
InterfaceOnFinishCallback
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/HeadlessTaskManager.java:462
InterfaceOnInvokeCallback
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/HeadlessTaskManager.java:459
InterfacePermissionRationale
* __[Android only]__ Configuration for showing an android dialog prior to forwarding the user to a permission settings-screen. *
src/declarations/interfaces/PermissionRationale.d.ts:9
InterfacePluginSettings
example/Advanced/src/config/PluginSettings.ts:15
ClassPowerSaveChangeCallack
powersavechange event callback
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/RNBackgroundGeolocationModule.java:300
InterfaceProps
example/Advanced/src/AddGeofenceTypeSheet.tsx:22
InterfaceProps
example/Advanced/src/AddGeofenceSheet.tsx:37
InterfaceProviderChangeEvent
* The event-object provided to [[BackgroundGeolocation.onProviderChange]] * * @example * ```typescript * BackgroundGeolocation.onProviderChang
src/declarations/interfaces/ProviderChangeEvent.d.ts:14
ClassRNBackgroundGeolocation
React Native package for RNBackgroundGeolocation. This is used by the old architecture and by autolinking. The new architecture / TurboModule path is
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/RNBackgroundGeolocation.java:20
ClassRNBackgroundGeolocationModule
Created by chris on 2015-10-30.
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/RNBackgroundGeolocationModule.java:81
InterfaceSQLQuery
* Used for selecting a range of records from the SDK"s database. * Used with the methods: * - [[Logger.getLog]] * - [[Logger.emailLog]] * - [[
src/declarations/interfaces/SQLQuery.d.ts:41
ClassScheduleCallback
schedule event callback
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/RNBackgroundGeolocationModule.java:290
InterfaceSensors
* Detected device sensors related to motion-detection.
src/declarations/interfaces/Sensors.d.ts:5
InterfaceSettingOption
example/Advanced/src/config/PluginSettings.ts:5
InterfaceSpec
src/specs/NativeRNBackgroundGeolocation.js:12
InterfaceSpec
src/native/specs/NativeBackgroundGeolocation.ts:4
InterfaceState
* This `State` object contains all the provided [[Config]] options in addition to: * - [[enabled]]. * - [[schedulerEnabled]]. * - [[trackingMode]].
src/declarations/interfaces/State.d.ts:13
InterfaceStepperFieldProps
example/Advanced/src/components/StepperField.tsx:12
ClassSubscription
src/NativeModule.js:83
InterfaceSubscription
* Object returned by BackgroundGeolocation event-listeners. `Subscription` contains just a single method [[remove]], used for removing an event-liste
src/declarations/interfaces/Subscription.d.ts:82
InterfaceTSMapViewProps
example/Advanced/src/TSMapView.tsx:63
ClassTask
Wrapper for a client event. Inserts our custom taskId into the RN ClientEvent params.
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/HeadlessTaskManager.java:337
ClassTaskNotFoundError
android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/HeadlessTaskManager.java:447
InterfaceTextFieldProps
example/Advanced/src/components/TextField.tsx:9
InterfaceToggleFieldProps
example/Advanced/src/components/ToggleField.tsx:11
ClassTransistorAuthorizationService
src/TransistorAuthorizationService.js:17
InterfaceTransistorAuthorizationToken
* Response object returned by [[BackgroundGeolocation.findOrCreateTransistorAuthorizationToken]] for configuring the SDK's [[Authorization]] with Tran
src/declarations/interfaces/TransistorAuthorizationToken.d.ts:35
InterfaceWatchPositionRequest
* Options provided to [[BackgroundGeolocation.watchPosition]]. * * @example * ```typescript * BackgroundGeolocation.watchPosition((location) =
src/declarations/interfaces/WatchPositionRequest.d.ts:20