RadarUser
@interface RadarUser : NSObject
Represents the current user state. For more information, see https://radar.io/documentation.
-
The Radar ID of the user.
Declaration
Objective-C
@property (nonatomic, copy, readonly, nonnull) NSString *_id;
Swift
var _id: String { get }
-
The unique ID of the user, provided when you identified the user. May be
nil
if the user has not been identified.Declaration
Objective-C
@property (nonatomic, copy, readonly, nullable) NSString *userId;
Swift
var userId: String? { get }
-
The device ID of the user.
Declaration
Objective-C
@property (nonatomic, copy, readonly, nullable) NSString *deviceId;
Swift
var deviceId: String? { get }
-
The optional description of the user. Not to be confused with the
NSObject
description
property.Declaration
Objective-C
@property (nonatomic, copy, readonly, nullable) NSString *_description;
Swift
var _description: String? { get }
-
The optional set of custom key-value pairs for the user.
Declaration
Objective-C
@property (nonatomic, copy, readonly, nullable) NSDictionary *metadata;
Swift
var metadata: [AnyHashable : Any]? { get }
-
The user’s last known location.
Declaration
Objective-C
@property (nonatomic, strong, readonly, nonnull) CLLocation *location;
Swift
var location: CLLocation { get }
-
An array of the user’s last known geofences. May be
nil
or empty if the user is not in any geofences.Declaration
Objective-C
@property (nonatomic, copy, readonly, nullable) NSArray<RadarGeofence *> *geofences;
Swift
var geofences: [RadarGeofence]? { get }
-
The user’s last known place. May be
nil
if the user is not at a place or if Places is not enabled.Declaration
Objective-C
@property (nonatomic, copy, readonly, nullable) RadarPlace *place;
Swift
@NSCopying var place: RadarPlace? { get }
-
Learned insights for the user. May be
nil
if no insights are available or if Insights is not enabled.Declaration
Objective-C
@property (nonatomic, strong, readonly, nullable) RadarUserInsights *insights;
Swift
var insights: RadarUserInsights? { get }
-
A boolean indicating whether the user is stopped.
Declaration
Objective-C
@property (nonatomic, readonly) BOOL stopped;
Swift
var stopped: Bool { get }
-
A boolean indicating whether the user was last updated in the foreground.
Declaration
Objective-C
@property (nonatomic, readonly) BOOL foreground;
Swift
var foreground: Bool { get }
-
The user’s last known country. May be
nil
if country is not available or if Regions is not enabled.Declaration
Objective-C
@property (nonatomic, strong, readonly, nullable) RadarRegion *country;
Swift
var country: RadarRegion? { get }
-
The user’s last known state. May be
nil
if state is not available or if Regions is not enabled.Declaration
Objective-C
@property (nonatomic, strong, readonly, nullable) RadarRegion *state;
Swift
var state: RadarRegion? { get }
-
The user’s last known designated market area (DMA). May be
nil
if DMA is not available or if Regions is not enabled.Declaration
Objective-C
@property (nonatomic, strong, readonly, nullable) RadarRegion *dma;
Swift
var dma: RadarRegion? { get }
-
The user’s last known postal code. May be
nil
if postal code is not available or if Regions is not enabled.Declaration
Objective-C
@property (nonatomic, strong, readonly, nullable) RadarRegion *postalCode;
Swift
var postalCode: RadarRegion? { get }
-
The user’s nearby chains. May be
nil
if no chains are nearby or if nearby chains are not enabled.Declaration
Objective-C
@property (nonatomic, copy, readonly, nullable) NSArray<RadarChain *> *nearbyPlaceChains;
Swift
var nearbyPlaceChains: [RadarChain]? { get }
-
The user’s segments. May be
nil
if segments are not enabled.Declaration
Objective-C
@property (nonatomic, copy, readonly, nullable) NSArray<RadarSegment *> *segments;
Swift
var segments: [RadarSegment]? { get }
-
The user’s nearby chains. May be
nil
if segments are not enabled.Declaration
Objective-C
@property (nonatomic, copy, readonly, nullable) NSArray<RadarChain *> *topChains;
Swift
var topChains: [RadarChain]? { get }