RadarUser

API reference for the RadarUser class

Represents the current user state. This includes the user’s location, geofences, place, beacons, regions, segments, and trip information.

Properties

_id · String · required

The Radar ID of the user.

userId · String

The unique ID of the user, provided when you identified the user. May be nil if the user has not been identified.

deviceId · String

The device ID of the user.

__description · String

The optional description of the user. Not to be confused with the NSObject description property.

metadata · [String: Any]

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

location · CLLocation · required

The user’s current location.

altitude · Double · required

The user’s current altitude in meters.

activityType · RadarActivityType · required

The user’s current activity type. See Activity Types for possible values.

geofences · [RadarGeofence]

An array of the user’s current geofences. May be nil or empty if the user is not in any geofences.

See the Geofences documentation for more information.

place · RadarPlace

The user’s current place. May be nil if the user is not at a place or if Places is not enabled.

See the Places documentation for more information.

beacons · [RadarBeacon]

An array of the user’s nearby beacons. May be nil or empty if the user is not near any beacons or if Beacons is not enabled.

See the Beacons documentation for more information.

stopped · Bool · required

A boolean indicating whether the user is stopped.

foreground · Bool · required

A boolean indicating whether the user was last updated in the foreground.

country · RadarRegion

The user’s current country. May be nil if country is not available or if Regions is not enabled.

See the Regions documentation for more information.

state · RadarRegion

The user’s current state. May be nil if state is not available or if Regions is not enabled.

See the Regions documentation for more information.

dma · RadarRegion

The user’s current designated market area (DMA). May be nil if DMA is not available or if Regions is not enabled.

See the Regions documentation for more information.

postalCode · RadarRegion

The user’s current postal code. May be nil if postal code is not available or if Regions is not enabled.

See the Regions documentation for more information.

nearbyPlaceChains · [RadarChain]

The user’s nearby chains. May be nil if no chains are nearby or if nearby chains are not enabled.

segments · [RadarSegment]

The user’s segments. May be nil if segments are not enabled.

topChains · [RadarChain]

The user’s top chains. May be nil if segments are not enabled.

source · RadarLocationSource · required

The source of the user’s current location. See Location Sources for possible values.

trip · RadarTrip

The user’s current trip. May be nil if the user is not currently on a trip.

See the Trip Tracking documentation for more information.

debug · Bool · required

A boolean indicating whether the user is marked as debug.

fraud · RadarFraud

The user’s current fraud state. May be nil if Fraud is not enabled.

See the Fraud documentation for more information.

Activity Types

The RadarActivityType enum defines the types of user activity:

unknown · RadarActivityType

Unknown activity (0).

stationary · RadarActivityType

Stationary activity (1).

foot · RadarActivityType

Walking activity (2).

run · RadarActivityType

Running activity (3).

bike · RadarActivityType

Biking activity (4).

car · RadarActivityType

Driving activity (5).

Location Sources

The RadarLocationSource enum defines the sources for location updates:

foregroundLocation · RadarLocationSource

Foreground location update.

backgroundLocation · RadarLocationSource

Background location update.

manualLocation · RadarLocationSource

Manual location update.

visitArrival · RadarLocationSource

Visit arrival location update.

visitDeparture · RadarLocationSource

Visit departure location update.

geofenceEnter · RadarLocationSource

Geofence enter location update.

geofenceExit · RadarLocationSource

Geofence exit location update.

mockLocation · RadarLocationSource

Mock location update.

beaconEnter · RadarLocationSource

Beacon enter location update.

beaconExit · RadarLocationSource

Beacon exit location update.

unknown · RadarLocationSource

Unknown location source.

Methods

dictionaryValue

func dictionaryValue() -> [AnyHashable: Any]

- (NSDictionary *_Nonnull)dictionaryValue;

Converts the user to a dictionary representation.

Returns: A dictionary representation of the user.

Nested Objects

Show RadarGeofence

Represents a geofence the user is currently in.

_id · String · required

The Radar ID of the geofence.

__description · String · required

The description of the geofence.

tag · String

The tag of the geofence.

externalId · String

The external ID of the geofence.

metadata · [String: Any]

The optional set of custom key-value pairs for the geofence.

geometry · RadarGeofenceGeometry · required

The geometry of the geofence, which can be cast to either RadarCircleGeometry or RadarPolygonGeometry.

operatingHours · RadarOperatingHours

The optional operating hours for the geofence.

Show RadarPlace

Represents a place where the user is currently located.

_id · String · required

The Radar ID of the place.

name · String · required

The name of the place.

categories · [String] · required

The categories of the place. For a full list of categories, see the Places categories documentation.

chain · RadarChain

The chain of the place, if known. May be nil for places without a chain. For a full list of chains, see the Places chains documentation.

location · RadarCoordinate · required

The location of the place.

group · String

The group for the place, if any. For a full list of groups, see the Places groups documentation.

metadata · [String: Any]

The metadata for the place, if part of a group.

address · RadarAddress

The address of the place.

Show RadarBeacon

Represents a Bluetooth beacon near the user.

_id · String

The Radar ID of the beacon.

__description · String

The description of the beacon.

tag · String

The tag of the beacon.

externalId · String

The external ID of the beacon.

uuid · String · required

The UUID of the beacon.

major · String · required

The major ID of the beacon.

minor · String · required

The minor ID of the beacon.

metadata · [String: Any]

The optional set of custom key-value pairs for the beacon.

geometry · RadarCoordinate

The location of the beacon.

rssi · Int · required

The RSSI of the beacon, or 0 if not available.

Show RadarRegion

Represents a geographic region (country, state, DMA, or postal code).

_id · String · required

The Radar ID of the region.

name · String · required

The name of the region.

code · String · required

The unique code for the region.

type · String · required

The type of the region.

flag · String

The optional flag of the region.

allowed · Bool · required

A boolean indicating whether the jurisdiction is allowed. May be false if Fraud is not enabled.

passed · Bool · required

A boolean indicating whether all jurisdiction checks for the region have passed. May be false if Fraud is not enabled.

inExclusionZone · Bool · required

A boolean indicating whether the user is in an exclusion zone for the jurisdiction. May be false if Fraud is not enabled.

inBufferZone · Bool · required

A boolean indicating whether the user is too close to the border for the jurisdiction. May be false if Fraud is not enabled.

distanceToBorder · Double · required

The distance in meters to the border of the jurisdiction. May be 0 if Fraud is not enabled.

expected · Bool · required

A boolean indicating whether the jurisdiction is expected based on the values passed to setExpectedJurisdiction().

Show RadarChain

Represents the chain of a place.

slug · String · required

The unique ID of the chain. For a full list of chains, see the Places chains documentation.

name · String · required

The name of the chain.

externalId · String

The external ID of the chain.

metadata · [String: Any]

The optional set of custom key-value pairs for the chain.

Show RadarSegment

Represents a user segment.

__description · String · required

The description of the segment.

externalId · String · required

The external ID of the segment.

Show RadarTrip

Represents a trip the user is currently on.

_id · String · required

The Radar ID of the trip.

externalId · String

The external ID of the trip.

metadata · [String: Any]

The optional set of custom key-value pairs for the trip.

destinationGeofenceTag · String

For trips with a destination, the tag of the destination geofence.

destinationGeofenceExternalId · String

For trips with a destination, the external ID of the destination geofence.

destinationLocation · RadarCoordinate

For trips with a destination, the location of the destination geofence.

mode · RadarRouteMode · required

The travel mode for the trip.

etaDistance · Float · required

For trips with a destination, the distance to the destination geofence in meters based on the travel mode for the trip.

etaDuration · Float · required

For trips with a destination, the ETA to the destination geofence in minutes based on the travel mode for the trip.

status · RadarTripStatus · required

The status of the trip. Possible values: unknown, started, approaching, arrived, expired, completed, canceled.

orders · [RadarTripOrder]

The optional array of trip orders associated with this trip.

legs · [RadarTripLeg]

For multi-destination trips, the array of trip legs. Each leg contains destination info, status, and metadata. Use leg._id when calling updateTripLeg.

currentLegId · String

For multi-destination trips, the ID of the current active leg.

Show RadarFraud

Represents fraud detection signals for location verification.

These values should not be trusted unless you called trackVerified() instead of trackOnce().

passed · Bool · required

A boolean indicating whether the user passed fraud detection checks. May be false if Fraud is not enabled.

bypassed · Bool · required

A boolean indicating whether fraud detection checks were bypassed for the user for testing. May be false if Fraud is not enabled.

verified · Bool · required

A boolean indicating whether the request was made with SSL pinning configured successfully. May be false if Fraud is not enabled.

proxy · Bool · required

A boolean indicating whether the user’s IP address is a known proxy. May be false if Fraud is not enabled.

mocked · Bool · required

A boolean indicating whether the user’s location is being mocked, such as in the simulator or using a location spoofing app. May be false if Fraud is not enabled.

compromised · Bool · required

A boolean indicating whether the user’s device or app has been compromised according to DeviceCheck. May be false if Fraud is not enabled.

jumped · Bool · required

A boolean indicating whether the user moved too far too fast. May be false if Fraud is not enabled.

inaccurate · Bool · required

A boolean indicating whether the user’s location is not accurate enough. May be false if Fraud is not enabled.

sharing · Bool · required

A boolean indicating whether the user is sharing location. May be false if Fraud is not enabled.

blocked · Bool · required

A boolean indicating whether the user has been manually blocked. May be false if Fraud is not enabled.

See Also

• RadarEvent
• RadarContext
• SDK Documentation