Radar

object Radar

The main class used to interact with the Radar SDK.

Types

RadarBeaconCallback

interface RadarBeaconCallback

Called when a beacon ranging request succeeds, fails, or times out.

RadarContextCallback

interface RadarContextCallback

Called when a context request succeeds, fails, or times out.

RadarGeocodeCallback

interface RadarGeocodeCallback

Called when a geocoding request succeeds, fails, or times out.

RadarIpGeocodeCallback

interface RadarIpGeocodeCallback

Called when an IP geocoding request succeeds, fails, or times out.

RadarLocationCallback

interface RadarLocationCallback

Called when a location request succeeds, fails, or times out.

RadarLocationSource

enum RadarLocationSource : Enum<Radar.RadarLocationSource>

The sources for location updates.

RadarLogLevel

enum RadarLogLevel : Enum<Radar.RadarLogLevel>

The levels for debug logs.

RadarMatrixCallback

interface RadarMatrixCallback

Called when a matrix request succeeds, fails, or times out.

RadarRouteCallback

interface RadarRouteCallback

Called when a distance request succeeds, fails, or times out.

RadarRouteMode

enum RadarRouteMode : Enum<Radar.RadarRouteMode>

The travel modes for routes.

RadarRouteUnits

enum RadarRouteUnits : Enum<Radar.RadarRouteUnits>

The distance units for routes.

RadarSearchGeofencesCallback

interface RadarSearchGeofencesCallback

Called when a geofence search request succeeds, fails, or times out.

RadarSearchPlacesCallback

interface RadarSearchPlacesCallback

Called when a place search request succeeds, fails, or times out.

RadarStatus

enum RadarStatus : Enum<Radar.RadarStatus>

The status types for a request.

RadarTrackCallback

interface RadarTrackCallback

Called when a track request succeeds, fails, or times out.

RadarTripCallback

interface RadarTripCallback

Called when a trip update succeeds, fails, or times out.

Functions

acceptEvent

@JvmStatic()

fun acceptEvent(eventId: String, verifiedPlaceId: String? = null)

Accepts an event.

autocomplete

@JvmStatic()

fun autocomplete(query: String, near: Location? = null, limit: Int? = null, callback: Radar.RadarGeocodeCallback)

Autocompletes partial addresses and place names, sorted by relevance.

fun autocomplete(query: String, near: Location? = null, limit: Int? = null, block: (status: Radar.RadarStatus, addresses: Array<RadarAddress>?) -> Unit)

Autocompletes partial addresses and place names, sorted by relevance.

@JvmStatic()

fun autocomplete(query: String, near: Location? = null, layers: Array<String>? = null, limit: Int? = null, country: String? = null, callback: Radar.RadarGeocodeCallback)

Autocompletes partial addresses and place names, sorted by relevance.

fun autocomplete(query: String, near: Location? = null, layers: Array<String>? = null, limit: Int? = null, country: String? = null, block: (status: Radar.RadarStatus, addresses: Array<RadarAddress>?) -> Unit)

Autocompletes partial addresses and place names, sorted by relevance.

cancelTrip

@JvmStatic()

fun cancelTrip(callback: Radar.RadarTripCallback? = null)

Cancels a trip.

@JvmStatic()

fun cancelTrip(block: (status: Radar.RadarStatus, trip: RadarTrip?, events: Array<RadarEvent>?) -> Unit)

Cancels a trip.

completeTrip

@JvmStatic()

fun completeTrip(callback: Radar.RadarTripCallback? = null)

Completes a trip.

@JvmStatic()

fun completeTrip(block: (status: Radar.RadarStatus, trip: RadarTrip?, events: Array<RadarEvent>?) -> Unit)

Completes a trip.

geocode

@JvmStatic()

fun geocode(query: String, callback: Radar.RadarGeocodeCallback)

Geocodes an address, converting address to coordinates.

fun geocode(query: String, block: (status: Radar.RadarStatus, addresses: Array<RadarAddress>?) -> Unit)

Geocodes an address, converting address to coordinates.

getContext

@JvmStatic()

fun getContext(callback: Radar.RadarContextCallback)

Gets the device's current location, then gets context for that location without sending device or user identifiers to the server.

fun getContext(block: (status: Radar.RadarStatus, location: Location?, context: RadarContext?) -> Unit)

Gets the device's current location, then gets context for that location without sending device or user identifiers to the server.

@JvmStatic()

fun getContext(location: Location, callback: Radar.RadarContextCallback)

Gets context for a location without sending device or user identifiers to the server.

fun getContext(location: Location, block: (status: Radar.RadarStatus, location: Location?, context: RadarContext?) -> Unit)

Gets context for a location without sending device or user identifiers to the server.

getDescription

@JvmStatic()

fun getDescription(): String?

Returns the current description.

getDistance

@JvmStatic()

fun getDistance(destination: Location, modes: EnumSet<Radar.RadarRouteMode>, units: Radar.RadarRouteUnits, callback: Radar.RadarRouteCallback)

Gets the device's current location, then calculates the travel distance and duration to a destination.

fun getDistance(destination: Location, modes: EnumSet<Radar.RadarRouteMode>, units: Radar.RadarRouteUnits, block: (status: Radar.RadarStatus, routes: RadarRoutes?) -> Unit)

Gets the device's current location, then calculates the travel distance and duration to a destination.

@JvmStatic()

fun getDistance(origin: Location, destination: Location, modes: EnumSet<Radar.RadarRouteMode>, units: Radar.RadarRouteUnits, callback: Radar.RadarRouteCallback)

Calculates the travel distance and duration from an origin to a destination.

fun getDistance(origin: Location, destination: Location, modes: EnumSet<Radar.RadarRouteMode>, units: Radar.RadarRouteUnits, block: (status: Radar.RadarStatus, routes: RadarRoutes?) -> Unit)

Calculates the travel distance and duration from an origin to a destination.

getLocation

@JvmStatic()

fun getLocation(callback: Radar.RadarLocationCallback? = null)

Gets the device's current location.

fun getLocation(block: (status: Radar.RadarStatus, location: Location?, stopped: Boolean) -> Unit)

Gets the device's current location.

@JvmStatic()

fun getLocation(desiredAccuracy: RadarTrackingOptions.RadarTrackingOptionsDesiredAccuracy, callback: Radar.RadarLocationCallback? = null)

Gets the device's current location with the desired accuracy.

fun getLocation(desiredAccuracy: RadarTrackingOptions.RadarTrackingOptionsDesiredAccuracy, block: (status: Radar.RadarStatus, location: Location?, stopped: Boolean) -> Unit)

Gets the device's current location with the desired accuracy.

getMatrix

@JvmStatic()

fun getMatrix(origins: Array<Location>, destinations: Array<Location>, mode: Radar.RadarRouteMode, units: Radar.RadarRouteUnits, callback: Radar.RadarMatrixCallback)

Calculates the travel distances and durations between multiple origins and destinations for up to 25 routes.

fun getMatrix(origins: Array<Location>, destinations: Array<Location>, mode: Radar.RadarRouteMode, units: Radar.RadarRouteUnits, block: (status: Radar.RadarStatus, matrix: RadarRouteMatrix?) -> Unit)

Calculates the travel distances and durations between multiple origins and destinations for up to 25 routes.

getMetadata

@JvmStatic()

fun getMetadata(): JSONObject?

Returns the current metadata.

getTrackingOptions

@JvmStatic()

fun getTrackingOptions(): RadarTrackingOptions

Returns the current tracking options.

getTripOptions

@JvmStatic()

fun getTripOptions(): RadarTripOptions?

Returns the current trip options.

getUserId

@JvmStatic()

fun getUserId(): String?

Returns the current userId.

initialize

@JvmStatic()

fun initialize(context: Context?, publishableKey: String? = null)

Initializes the Radar SDK.

@JvmStatic()

fun initialize(context: Context?, publishableKey: String? = null, receiver: RadarReceiver? = null)

Initializes the Radar SDK.

ipGeocode

@JvmStatic()

fun ipGeocode(callback: Radar.RadarIpGeocodeCallback)

Geocodes the device's current IP address, converting IP address to partial address.

fun ipGeocode(block: (status: Radar.RadarStatus, address: RadarAddress?, proxy: Boolean) -> Unit)

Geocodes the device's current IP address, converting IP address to partial address.

isTracking

@JvmStatic()

fun isTracking(): Boolean

Returns a boolean indicating whether tracking has been started.

jsonForLocation

@JvmStatic()

fun jsonForLocation(location: Location): JSONObject

Returns a JSON object for a location.

mockTracking

@JvmStatic()

fun mockTracking(origin: Location, destination: Location, mode: Radar.RadarRouteMode, steps: Int, interval: Int, callback: Radar.RadarTrackCallback?)

Mocks tracking the user's location from an origin to a destination.

@JvmStatic()

fun mockTracking(origin: Location, destination: Location, mode: Radar.RadarRouteMode, steps: Int, interval: Int, block: (status: Radar.RadarStatus, location: Location?, events: Array<RadarEvent>?, user: RadarUser?) -> Unit)

Mocks tracking the user's location from an origin to a destination.

rejectEvent

@JvmStatic()

fun rejectEvent(eventId: String)

Rejects an event.

reverseGeocode

@JvmStatic()

fun reverseGeocode(callback: Radar.RadarGeocodeCallback)

Gets the device's current location, then reverse geocodes that location, converting coordinates to address.

fun reverseGeocode(block: (status: Radar.RadarStatus, addresses: Array<RadarAddress>?) -> Unit)

Gets the device's current location, then reverse geocodes that location, converting coordinates to address.

@JvmStatic()

fun reverseGeocode(location: Location, callback: Radar.RadarGeocodeCallback)

Reverse geocodes a location, converting coordinates to address.

fun reverseGeocode(location: Location, block: (status: Radar.RadarStatus, addresses: Array<RadarAddress>?) -> Unit)

Reverse geocodes a location, converting coordinates to address.

searchGeofences

@JvmStatic()

fun searchGeofences(radius: Int, tags: Array<String>?, metadata: JSONObject?, limit: Int?, callback: Radar.RadarSearchGeofencesCallback)

Gets the device's current location, then searches for geofences near that location, sorted by distance.

fun searchGeofences(radius: Int, tags: Array<String>?, metadata: JSONObject?, limit: Int?, block: (status: Radar.RadarStatus, location: Location?, geofences: Array<RadarGeofence>?) -> Unit)

Gets the device's current location, then searches for geofences near that location, sorted by distance.

@JvmStatic()

fun searchGeofences(near: Location, radius: Int, tags: Array<String>?, metadata: JSONObject?, limit: Int?, callback: Radar.RadarSearchGeofencesCallback)

Search for geofences near a location, sorted by distance.

fun searchGeofences(near: Location, radius: Int, tags: Array<String>?, metadata: JSONObject?, limit: Int?, block: (status: Radar.RadarStatus, location: Location?, geofences: Array<RadarGeofence>?) -> Unit)

Search for geofences near a location, sorted by distance.

searchPlaces

@JvmStatic()

fun searchPlaces(radius: Int, chains: Array<String>?, categories: Array<String>?, groups: Array<String>?, limit: Int?, callback: Radar.RadarSearchPlacesCallback)

Gets the device's current location, then searches for places near that location, sorted by distance.

fun searchPlaces(radius: Int, chains: Array<String>?, categories: Array<String>?, groups: Array<String>?, limit: Int?, block: (status: Radar.RadarStatus, location: Location?, places: Array<RadarPlace>?) -> Unit)

Gets the device's current location, then searches for places near that location, sorted by distance.

@JvmStatic()

fun searchPlaces(near: Location, radius: Int, chains: Array<String>?, categories: Array<String>?, groups: Array<String>?, limit: Int?, callback: Radar.RadarSearchPlacesCallback)

Search for places near a location, sorted by distance.

fun searchPlaces(near: Location, radius: Int, chains: Array<String>?, categories: Array<String>?, groups: Array<String>?, limit: Int?, block: (status: Radar.RadarStatus, location: Location?, places: Array<RadarPlace>?) -> Unit)

Search for places near a location, sorted by distance.

setAdIdEnabled

@JvmStatic()

fun setAdIdEnabled(enabled: Boolean)

Enables adId (Android advertising ID) collection.

setDescription

@JvmStatic()

fun setDescription(description: String?)

Sets an optional description for the user, displayed in the dashboard.

setForegroundServiceOptions

@JvmStatic()

fun setForegroundServiceOptions(options: RadarTrackingOptions.RadarTrackingOptionsForegroundService)

Settings for the foreground notification when the foregroundServiceEnabled parameter is true on Radar tracking options.

setLogLevel

@JvmStatic()

fun setLogLevel(level: Radar.RadarLogLevel)

Sets the log level for debug logs.

setMetadata

@JvmStatic()

fun setMetadata(metadata: JSONObject?)

Sets an optional set of custom key-value pairs for the user.

setReceiver

@JvmStatic()

fun setReceiver(receiver: RadarReceiver?)

Sets a receiver for client-side delivery of events, location updates, and debug logs.

setUserId

@JvmStatic()

fun setUserId(userId: String?)

Identifies the user.

startTracking

@JvmStatic()

fun startTracking(options: RadarTrackingOptions)

Starts tracking the user's location in the background.

startTrip

@JvmStatic()

fun startTrip(options: RadarTripOptions, callback: Radar.RadarTripCallback? = null)

Starts a trip.

@JvmStatic()

fun startTrip(options: RadarTripOptions, block: (status: Radar.RadarStatus, trip: RadarTrip?, events: Array<RadarEvent>?) -> Unit)

Starts a trip.

stopTracking

@JvmStatic()

fun stopTracking()

Stops tracking the user's location in the background.

stringForMode

@JvmStatic()

fun stringForMode(mode: Radar.RadarRouteMode): String

Returns a display string for a travel mode value.

stringForSource

@JvmStatic()

fun stringForSource(source: Radar.RadarLocationSource): String

Returns a display string for a location source value.

stringForTripStatus

@JvmStatic()

fun stringForTripStatus(status: RadarTrip.RadarTripStatus): String

Returns a display string for a trip status value.

trackOnce

@JvmStatic()

fun trackOnce(callback: Radar.RadarTrackCallback? = null)

Tracks the user's location once in the foreground.

fun trackOnce(block: (status: Radar.RadarStatus, location: Location?, events: Array<RadarEvent>?, user: RadarUser?) -> Unit)

Tracks the user's location once in the foreground.

@JvmStatic()

fun trackOnce(location: Location, callback: Radar.RadarTrackCallback?)

Manually updates the user's location.

@JvmStatic()

fun trackOnce(location: Location, block: (status: Radar.RadarStatus, location: Location?, events: Array<RadarEvent>?, user: RadarUser?) -> Unit)

Manually updates the user's location.

@JvmStatic()

fun trackOnce(desiredAccuracy: RadarTrackingOptions.RadarTrackingOptionsDesiredAccuracy, beacons: Boolean, callback: Radar.RadarTrackCallback? = null)

Tracks the user's location once with the desired accuracy and optionally ranges beacons in the foreground.

@JvmStatic()

fun trackOnce(desiredAccuracy: RadarTrackingOptions.RadarTrackingOptionsDesiredAccuracy, beacons: Boolean, block: (status: Radar.RadarStatus, location: Location?, events: Array<RadarEvent>?, user: RadarUser?) -> Unit)

Tracks the user's location once with the desired accuracy and optionally ranges beacons in the foreground.

updateTrip

@JvmStatic()

fun updateTrip(options: RadarTripOptions, status: RadarTrip.RadarTripStatus?, callback: Radar.RadarTripCallback? = null)

Manually updates a trip.

@JvmStatic()

fun updateTrip(options: RadarTripOptions, status: RadarTrip.RadarTripStatus?, block: (status: Radar.RadarStatus, trip: RadarTrip?, events: Array<RadarEvent>?) -> Unit)

Manually updates a trip.

Radar

See also

Types

Functions