Package com.foursquare.pilgrim
See: Description
-
Interface Summary Interface Description OnPilgrimForegroundModeStarted PilgrimErrorReporter Class to report an exception to the pilgrim sdk engine. PilgrimExceptionHandler A pass through for exceptions that are handled by the Pilgrim SDK but are of note to the developer. PilgrimLogEntry Interface defining an entry in the PilgrimSdk engine -
Class Summary Class Description PilgrimNotificationHandler The interface that is implemented to handle delivery of visits from the Pilgrim Sdk to your app. CurrentLocation Data class containing the current/last known location and user state the matched geofences a user has broken into. DebugLogItem The wrapper class for persisted logs which are saved when PilgrimSdk.setEnableDebugLogs is turned on. PilgrimBootReceiver PilgrimBootService Builder Builder for supplying your notification handler and other configuration options on the Pilgrim SDKExample: new PilgrimSdk.Builder(context).exceptionHandler(...).notificationHandler(...)PilgrimSdk The main entry point for starting the Pilgrim SDK PilgrimSdkBackfillNotification The notification wrapper class that encapsulates the information passed through from the Pilgrim SDK for at a visit backfill notification. PilgrimSdkGeofenceEventNotification The notification wrapper class that encapsulates the information passed through from the Pilgrim SDK for geofence events that are triggered by your user. PilgrimSdkUserStateNotification PilgrimSdkVisitNotification The notification wrapper class that encapsulates the information passed through from the Pilgrim SDK for at a visit notifications. LocationNotAvailable Other Reason PilgrimTripException PilgrimUserInfo A wrapper of @link{HashMap} that provides some predefined fields you can set for your user Ok Err Result A result class models the possibility of a success or failure event occurring. Builder Trigger UserState Visit This is the main entity of the Pilgrim SDK. MapExtensionsKt -
Object Summary Object Description Companion FrequentLocations A utility class to access information about the locations your user frequents. Companion Companion PilgrimNotificationTester Companion PreciseLocationPermissionDenied NetworkError TripAlreadyActive TripNotActive Companion Companion Companion -
Enum Summary Enum Description Confidence The Confidence value attached to notifications from Pilgrim. LocationType The type of place attached to notifications from Pilgrim. LogLevel The level of logging that you want the SDK to write out. Gender TriggerPlaceType The type of Place that you would like to be triggered at. Component VisitFeedback Use VisitFeedback to give Foursquare feedback on the notification it sent you to improve future notifications.