movementsdk/com.foursquare.movement

Package-level declarations

Types

data class BackfillNotification(val visit: Visit) : Parcelable

The notification wrapper class that encapsulates the information passed through from the Movement SDK for at a visit backfill notification. See NotificationHandler for implementation details.

Confidence

enum Confidence : Enum<Confidence>

The Confidence value attached to notifications from the Movement SDK. It tells you how confident Foursquare is that your user is at the corresponding place. The confidence levels equate to the ballpark of: 50% for low, 80% for medium and 90% for high. The confidence value for the default trigger is Confidence.MEDIUM.

CurrentLocation

class CurrentLocation

Data class containing the current/last known location and user state the matched geofences a user has broken into.

DebugLogItem

data class DebugLogItem

The wrapper class for persisted logs which are saved when MovementSdk.setEnableDebugLogs is turned on.

ExceptionHandler

fun interface ExceptionHandler

A pass through for exceptions that are handled by the Movement SDK but are of note to the developer. The Movement SDK in some cases needs to handle exceptions so that it can continue is passive work. These exceptions often indicate an issue in the implementation of NotificationHandler and are useful for debugging.

FrequentLocations

object FrequentLocations

A utility class to access information about the locations your user frequents.

GeofenceEventNotification

data class GeofenceEventNotification(val geofenceEvents: List<GeofenceEvent> = emptyList()) : Parcelable

The notification wrapper class that encapsulates the information passed through from the Movement SDK for geofence events that are triggered by your user. See NotificationHandler for implementation details.

JourneyException

class JourneyException(val reason: JourneyException.Reason) : Exception

LocationType

enum LocationType : Enum<LocationType>

The type of place attached to notifications from the Movement SDK.

LogLevel

enum LogLevel : Enum<LogLevel>

The level of logging that you want the SDK to write out. Corresponds generally with the logging calls for logcat in Log.

MovementSdk

class MovementSdk

The main entry point for starting the Movement SDK

NotificationHandler

fun interface NotificationHandler

The interface that is implemented to handle delivery of visits from the Movement Sdk to your app.

NotificationTester

object NotificationTester

OnForegroundModeStarted

fun interface OnForegroundModeStarted

Result

abstract class Result<T, E>

A result class models the possibility of a success or failure event occurring.

UserInfo

class UserInfo : HashMap<String, String>

A wrapper of @link{HashMap} that provides some predefined fields you can set for your user

UserState

data class UserState(val traveling: Boolean, val commuting: Boolean, val state: String?, val city: String?, val postalCode: String?, val country: String?, val dma: String?) : FoursquareType, Parcelable

UserStateNotification

data class UserStateNotification(val userState: UserState, val changedComponents: List<UserState.Component>) : Parcelable

Visit

data class Visit(visitId: String? = null, venue: Venue?, type: LocationType = LocationType.UNKNOWN, val arrival: Long = 0, confidence: Confidence = Confidence.NONE, var location: FoursquareLocation, val wifi: String?, otherPossibleVenues: List<Venue> = emptyList(), stopDetectionAlgorithm: StopDetectionAlgorithm? = null, segments: List<Segment> = emptyList(), stateProvider: String?, departure: Long = 0, sentArrivalTrigger: Boolean = false) : Parcelable

This is the main entity of the Movement SDK. It encapsulates all of the information about the users visit.

VisitFeedback

enum VisitFeedback : Enum<VisitFeedback>

Use VisitFeedback to give Foursquare feedback on the notification it sent you to improve future notifications.

VisitNotification

data class VisitNotification(val visit: Visit, val currentLocation: FoursquareLocation? = null) : Parcelable

The notification wrapper class that encapsulates the information passed through from the Movement SDK for at a visit notifications. See NotificationHandler for implementation details.