Represents the current user state. This includes the user’s location, geofences, place, beacons, regions, segments, and trip information.
Properties The Radar ID of the user.
The unique ID of the user, provided when you identified the user. May be nil if the user has not been identified.
The device ID of the user.
The optional description of the user. Not to be confused with the NSObject description property.
The optional set of custom key-value pairs for the user.
The user’s current location.
The user’s current altitude in meters.
activityType
RadarActivityType
required
The user’s current activity type. See Activity Types for possible values. 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. 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. 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. A boolean indicating whether the user is stopped.
A boolean indicating whether the user was last updated in the foreground.
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. 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. 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. 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. The user’s nearby chains. May be nil if no chains are nearby or if nearby chains are not enabled.
The user’s segments. May be nil if segments are not enabled.
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. A boolean indicating whether the user is marked as debug.
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:
Location Sources The RadarLocationSource enum defines the sources for location updates:
Foreground location update.
Background location update.
Visit arrival location update.
Visit departure location update.
Geofence enter location update.
Geofence exit location update.
Beacon enter location update.
Beacon exit location update.
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 Represents a geofence the user is currently in. The Radar ID of the geofence.
The description of the geofence.
The external ID of the geofence.
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.
The optional operating hours for the geofence.
Represents a place where the user is currently located. The Radar ID of the place.
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 . The location of the place.
The metadata for the place, if part of a group.
The address of the place.
Represents a Bluetooth beacon near the user. The Radar ID of the beacon.
The description of the beacon.
The external ID of the beacon.
The major ID of the beacon.
The minor ID of the beacon.
The optional set of custom key-value pairs for the beacon.
The location of the beacon.
The RSSI of the beacon, or 0 if not available.
Represents a geographic region (country, state, DMA, or postal code). The Radar ID of the region.
The unique code for the region.
The optional flag of the region.
A boolean indicating whether the jurisdiction is allowed. May be false if Fraud is not enabled.
A boolean indicating whether all jurisdiction checks for the region have passed. May be false if Fraud is not enabled.
A boolean indicating whether the user is in an exclusion zone for the jurisdiction. May be false if Fraud is not enabled.
A boolean indicating whether the user is too close to the border for the jurisdiction. May be false if Fraud is not enabled.
The distance in meters to the border of the jurisdiction. May be 0 if Fraud is not enabled.
A boolean indicating whether the jurisdiction is expected based on the values passed to setExpectedJurisdiction().
Represents the chain of a place. The external ID of the chain.
The optional set of custom key-value pairs for the chain.
Represents a user segment. The description of the segment.
The external ID of the segment.
Represents a trip the user is currently on. The Radar ID of the trip.
The external ID of the trip.
The optional set of custom key-value pairs for the trip.
For trips with a destination, the tag of the destination geofence.
destinationGeofenceExternalId
For trips with a destination, the external ID of the destination geofence.
For trips with a destination, the location of the destination geofence.
The travel mode for the trip.
For trips with a destination, the distance to the destination geofence in meters based on the travel mode for the trip.
For trips with a destination, the ETA to the destination geofence in minutes based on the travel mode for the trip.
The status of the trip. Possible values: unknown, started, approaching, arrived, expired, completed, canceled.
The optional array of trip orders associated with this trip.
For multi-destination trips, the array of trip legs. Each leg contains destination info, status, and metadata. Use leg._id when calling updateTripLeg.
For multi-destination trips, the ID of the current active leg.
Represents fraud detection signals for location verification. These values should not be trusted unless you called trackVerified() instead of trackOnce().
A boolean indicating whether the user passed fraud detection checks. May be false if Fraud is not enabled.
A boolean indicating whether fraud detection checks were bypassed for the user for testing. May be false if Fraud is not enabled.
A boolean indicating whether the request was made with SSL pinning configured successfully. May be false if Fraud is not enabled.
A boolean indicating whether the user’s IP address is a known proxy. May be false if Fraud is not enabled.
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.
A boolean indicating whether the user’s device or app has been compromised according to DeviceCheck. May be false if Fraud is not enabled.
A boolean indicating whether the user moved too far too fast. May be false if Fraud is not enabled.
A boolean indicating whether the user’s location is not accurate enough. May be false if Fraud is not enabled.
A boolean indicating whether the user is sharing location. May be false if Fraud is not enabled.
A boolean indicating whether the user has been manually blocked. May be false if Fraud is not enabled.
See Also 