Radar Class Reference

Initialization


                    
                    
                    +initializeWithPublishableKey:

Initializes the Radar SDK.

Warning

Call this method from the main thread in your AppDelegate class before calling any other Radar methods.

See

https://radar.com/documentation/sdk/ios#initialize-sdk

Declaration

Objective-C

+ (void)initializeWithPublishableKey:(NSString *_Nonnull)publishableKey;

Swift

class func initialize(publishableKey: String)

Parameters


                                publishableKey

Your publishable API key.

Properties

sdkVersion
Gets the version number of the Radar SDK, such as “3.5.1” or “3.5.1-beta.2”.
Declaration
Objective-C

@property (class, readonly) NSString *_Nonnull sdkVersion;
Swift

class var sdkVersion: String { get }


                    
                    
                    +setUserId:

Identifies the user.

Note

Until you identify the user, Radar will automatically identify the user by deviceId (IDFV).

See

https://radar.com/documentation/sdk/ios#identify-user

Declaration

Objective-C

+ (void)setUserId:(NSString *_Nullable)userId;

Swift

class func setUserId(_ userId: String?)

Parameters


                                userId

A stable unique ID for the user. If nil, the previous userId will be cleared.

+getUserId
Returns the current userId.

See

https://radar.com/documentation/sdk/ios#identify-user
Declaration
Objective-C

+ (NSString *_Nullable)getUserId;
Swift

class func getUserId() -> String?
Return Value

The current userId.


                    
                    
                    +setDescription:

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

See

https://radar.com/documentation/sdk/ios#identify-user

Declaration

Objective-C

+ (void)setDescription:(NSString *_Nullable)description;

Swift

class func setDescription(_ description: String?)

Parameters


                                description

A description for the user. If nil, the previous description will be cleared.

+getDescription
Returns the current description.

See

https://radar.com/documentation/sdk/ios#identify-user
Declaration
Objective-C

+ (NSString *_Nullable)getDescription;
Swift

class func getDescription() -> String?
Return Value

The current description.


                    
                    
                    +setMetadata:

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

See

https://radar.com/documentation/sdk/ios#identify-user

Declaration

Objective-C

+ (void)setMetadata:(NSDictionary *_Nullable)metadata;

Swift

class func setMetadata(_ metadata: [AnyHashable : Any]?)

Parameters


                                metadata

A set of custom key-value pairs for the user. Must have 16 or fewer keys and values of type string, boolean, or number. If nil, the previous metadata will be cleared.

+getMetadata
Returns the current metadata.

See

https://radar.com/documentation/sdk/ios#identify-user
Declaration
Objective-C

+ (NSDictionary *_Nullable)getMetadata;
Swift

class func getMetadata() -> [AnyHashable : Any]?
Return Value

The current metadata.


                    
                    
                    +setAdIdEnabled:

Enables adId (IDFA) collection. Disabled by default.

Declaration

Objective-C

+ (void)setAdIdEnabled:(BOOL)enabled;

Swift

class func setAdIdEnabled(_ enabled: Bool)

Parameters


                                enabled

A boolean indicating whether adId should be collected.

Get Location


                    
                    
                    +getLocationWithCompletionHandler:

Gets the device’s current location.

See

https://radar.com/documentation/sdk/ios#get-location

Declaration

Objective-C

+ (void)getLocationWithCompletionHandler:
    (RadarLocationCompletionHandler _Nullable)completionHandler;

Swift

class func getLocation() async -> (RadarStatus, CLLocation?, Bool)

Parameters


                                completionHandler

An optional completion handler.


                    
                    
                    +getLocationWithDesiredAccuracy:completionHandler:

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

See

https://radar.com/documentation/sdk/ios#get-location

Declaration

Objective-C

+ (void)getLocationWithDesiredAccuracy:
            (RadarTrackingOptionsDesiredAccuracy)desiredAccuracy
                     completionHandler:
                         (RadarLocationCompletionHandler _Nullable)
                             completionHandler;

Swift

class func getLocation(desiredAccuracy: RadarTrackingOptionsDesiredAccuracy) async -> (RadarStatus, CLLocation?, Bool)

Parameters

`desiredAccuracy`	The desired accuracy.
`completionHandler`	An optional completion handler.

Tracking


                    
                    
                    +trackOnceWithCompletionHandler:

Tracks the user’s location once in the foreground.

Warning

Note that these calls are subject to rate limits.

See

https://radar.com/documentation/sdk/ios#foreground-tracking

Declaration

Objective-C

+ (void)trackOnceWithCompletionHandler:
    (RadarTrackCompletionHandler _Nullable)completionHandler;

Swift

class func trackOnce() async -> (RadarStatus, CLLocation?, [RadarEvent]?, RadarUser?)

Parameters


                                completionHandler

An optional completion handler.


                    
                    
                    +trackOnceWithDesiredAccuracy:beacons:completionHandler:

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

Warning

Note that these calls are subject to rate limits.

See

https://radar.com/documentation/sdk/ios#foreground-tracking

Declaration

Objective-C

+ (void)trackOnceWithDesiredAccuracy:
            (RadarTrackingOptionsDesiredAccuracy)desiredAccuracy
                             beacons:(BOOL)beacons
                   completionHandler:
                       (RadarTrackCompletionHandler _Nullable)completionHandler;

Swift

class func trackOnce(desiredAccuracy: RadarTrackingOptionsDesiredAccuracy, beacons: Bool) async -> (RadarStatus, CLLocation?, [RadarEvent]?, RadarUser?)

Parameters

`desiredAccuracy`	The desired accuracy.
`beacons`	A boolean indicating whether to range beacons.
`completionHandler`	An optional completion handler.


                    
                    
                    +trackOnceWithLocation:completionHandler:

Manually updates the user’s location.

Warning

Note that these calls are subject to rate limits.

See

https://radar.com/documentation/sdk/ios#foreground-tracking

Declaration

Objective-C

+ (void)trackOnceWithLocation:(CLLocation *_Nonnull)location
            completionHandler:
                (RadarTrackCompletionHandler _Nullable)completionHandler;

Swift

class func trackOnce(location: CLLocation) async -> (RadarStatus, CLLocation?, [RadarEvent]?, RadarUser?)

Parameters

`location`	A location for the user.
`completionHandler`	An optional completion handler.


                    
                    
                    +startTrackingWithOptions:

Starts tracking the user’s location in the background with configurable tracking options.

See

https://radar.com/documentation/sdk/ios#background-tracking-for-geofencing

Declaration

Objective-C

+ (void)startTrackingWithOptions:(nonnull RadarTrackingOptions *)options;

Swift

class func startTracking(trackingOptions options: RadarTrackingOptions)

Parameters


                                options

Configurable tracking options.


                    
                    
                    +mockTrackingWithOrigin:destination:mode:steps:interval:completionHandler:

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

See

https://radar.com/documentation/sdk/ios#mock-tracking-for-testing

Declaration

Objective-C

+ (void)mockTrackingWithOrigin:(CLLocation *_Nonnull)origin
                   destination:(CLLocation *_Nonnull)destination
                          mode:(RadarRouteMode)mode
                         steps:(int)steps
                      interval:(NSTimeInterval)interval
             completionHandler:
                 (RadarTrackCompletionHandler _Nullable)completionHandler;

Swift

class func mockTracking(origin: CLLocation, destination: CLLocation, mode: RadarRouteMode, steps: Int32, interval: TimeInterval) async -> (RadarStatus, CLLocation?, [RadarEvent]?, RadarUser?)

Parameters

`origin`	The origin.
`destination`	The destination.
`mode`	The travel mode.
`steps`	The number of mock location updates.
`interval`	The interval in seconds between each mock location update. A number between 1 and 60.

+stopTracking
Stops tracking the user’s location in the background.

See
https://radar.com/documentation/sdk/ios#background-tracking-for-geofencing
Declaration
Objective-C

+ (void)stopTracking;
Swift

class func stopTracking()
+isTracking
Returns a boolean indicating whether tracking has been started.

See

https://radar.com/documentation/sdk/ios#background-tracking-for-geofencing
Declaration
Objective-C

+ (BOOL)isTracking;
Swift

class func isTracking() -> Bool
Return Value

A boolean indicating whether tracking has been started.
+getTrackingOptions
Returns the current tracking options.

See

https://radar.com/documentation/sdk/tracking
Declaration
Objective-C

+ (nonnull RadarTrackingOptions *)getTrackingOptions;
Swift

class func getTrackingOptions() -> RadarTrackingOptions
Return Value

The current tracking options.

Delegation


                    
                    
                    +setDelegate:

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

See

https://radar.com/documentation/sdk/ios#listening-for-events-with-a-delegate

Declaration

Objective-C

+ (void)setDelegate:(nullable id<RadarDelegate>)delegate;

Parameters


                                delegate

A delegate for client-side delivery of events, location updates, and debug logs. If nil, the previous delegate will be cleared.

Events


                    
                    
                    +acceptEventId:verifiedPlaceId:

Accepts an event. Events can be accepted after user check-ins or other forms of verification. Event verifications will be used to improve the accuracy and confidence level of future events.

See

https://radar.com/documentation/places#verify-events

Declaration

Objective-C

+ (void)acceptEventId:(NSString *_Nonnull)eventId
      verifiedPlaceId:(NSString *_Nullable)verifiedPlaceId;

Swift

class func acceptEventId(_ eventId: String, verifiedPlaceId: String?)

Parameters

`eventId`	The ID of the event to accept.
`verifiedPlaceId`	For place entry events, the ID of the verified place. May be `nil`.


                    
                    
                    +rejectEventId:

Rejects an event. Events can be accepted after user check-ins or other forms of verification. Event verifications will be used to improve the accuracy and confidence level of future events.

See

https://radar.com/documentation/places#verify-events

Declaration

Objective-C

+ (void)rejectEventId:(NSString *_Nonnull)eventId;

Swift

class func rejectEventId(_ eventId: String)

Parameters


                                eventId

The ID of the event to reject.


                    
                    
                    +sendEvent:withMetadata:completionHandler:

Sends a custom event.

See

https://radar.com/documentation/api#send-a-custom-event

Declaration

Objective-C

+ (void)sendEvent:(nonnull NSString *)customType
         withMetadata:(NSDictionary *_Nullable)metadata
    completionHandler:(RadarSendEventCompletionHandler)completionHandler;

Swift

class func sendEvent(customType: String, metadata: [AnyHashable : Any]?) async -> (RadarStatus, CLLocation?, [RadarEvent]?, RadarUser?)

Parameters

`customType`	The user-defined type of the event.
`metadata`	The metadata associated with the event.
`completionHandler`	A completion handler.


                    
                    
                    +sendEvent:withLocation:metadata:completionHandler:

Sends a custom event with a manually provided location.

See

https://radar.com/documentation/api#send-a-custom-event

Declaration

Objective-C

+ (void)sendEvent:(nonnull NSString *)customType
         withLocation:(CLLocation *_Nullable)location
             metadata:(NSDictionary *_Nullable)metadata
    completionHandler:(RadarSendEventCompletionHandler)completionHandler;

Swift

class func sendEvent(customType: String, location: CLLocation?, metadata: [AnyHashable : Any]?) async -> (RadarStatus, CLLocation?, [RadarEvent]?, RadarUser?)

Parameters

`customType`	The user-defined type of the event.
`location`	The location of the event.
`metadata`	The metadata associated with the event.
`completionHandler`	A completion handler.

Trips

+getTripOptions
Returns the current trip options.

See

https://radar.com/documentation/trip-tracking
Declaration
Objective-C

+ (RadarTripOptions *_Nullable)getTripOptions;
Swift

class func getTripOptions() -> RadarTripOptions?
Return Value

The current trip options.


                    
                    
                    +startTripWithOptions:

Starts a trip.

See

https://radar.com/documentation/trip-tracking

Declaration

Objective-C

+ (void)startTripWithOptions:(RadarTripOptions *_Nonnull)options;

Swift

class func startTrip(options: RadarTripOptions)

Parameters


                                options

Configurable trip options.


                    
                    
                    +startTripWithOptions:completionHandler:

Starts a trip.

See

https://radar.com/documentation/trip-tracking

Declaration

Objective-C

+ (void)startTripWithOptions:(RadarTripOptions *_Nonnull)options
           completionHandler:
               (RadarTripCompletionHandler _Nullable)completionHandler;

Swift

class func startTrip(options: RadarTripOptions) async -> (RadarStatus, RadarTrip?, [RadarEvent]?)

Parameters

`options`	Configurable trip options.
`completionHandler`	An optional completion handler.


                    
                    
                    +updateTripWithOptions:status:completionHandler:

Manually updates a trip.

See

https://radar.com/documentation/trip-tracking

Declaration

Objective-C

+ (void)updateTripWithOptions:(RadarTripOptions *_Nonnull)options
                       status:(RadarTripStatus)status
            completionHandler:
                (RadarTripCompletionHandler _Nullable)completionHandler;

Swift

class func updateTrip(options: RadarTripOptions, status: RadarTripStatus) async -> (RadarStatus, RadarTrip?, [RadarEvent]?)

Parameters

`options`	Configurable trip options.
`status`	The trip status. To avoid updating status, pass RadarTripStatusUnknown.
`completionHandler`	An optional completion handler.

+completeTrip
Completes a trip.

See
https://radar.com/documentation/trip-tracking
Declaration
Objective-C

+ (void)completeTrip;
Swift

class func completeTrip()


                    
                    
                    +completeTripWithCompletionHandler:

Completes a trip.

See

https://radar.com/documentation/trip-tracking

Declaration

Objective-C

+ (void)completeTripWithCompletionHandler:
    (RadarTripCompletionHandler _Nullable)completionHandler;

Swift

class func completeTrip() async -> (RadarStatus, RadarTrip?, [RadarEvent]?)

Parameters


                                completionHandler

An optional completion handler.

+cancelTrip
Cancels a trip.

See
https://radar.com/documentation/trip-tracking
Declaration
Objective-C

+ (void)cancelTrip;
Swift

class func cancelTrip()


                    
                    
                    +cancelTripWithCompletionHandler:

Cancels a trip.

See

https://radar.com/documentation/trip-tracking

Declaration

Objective-C

+ (void)cancelTripWithCompletionHandler:
    (RadarTripCompletionHandler _Nullable)completionHandler;

Swift

class func cancelTrip() async -> (RadarStatus, RadarTrip?, [RadarEvent]?)

Parameters


                                completionHandler

An optional completion handler.

Device Context


                    
                    
                    +getContextWithCompletionHandler:

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

See

https://radar.com/documentation/api#search-geofences

Declaration

Objective-C

+ (void)getContextWithCompletionHandler:
    (RadarContextCompletionHandler _Nonnull)completionHandler;

Swift

class func getContext() async -> (RadarStatus, CLLocation?, RadarContext?)

Parameters


                                completionHandler

An optional completion handler.


                    
                    
                    +getContextForLocation:completionHandler:

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

See

https://radar.com/documentation/api#context

Declaration

Objective-C

+ (void)getContextForLocation:(CLLocation *_Nonnull)location
            completionHandler:
                (RadarContextCompletionHandler _Nonnull)completionHandler;

Swift

class func getContext(location: CLLocation) async -> (RadarStatus, CLLocation?, RadarContext?)

Parameters

`location`	The location.
`completionHandler`	An optional completion handler.

Search


                    
                    
                    +searchPlacesWithRadius:chains:categories:groups:limit:completionHandler:

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

Warning

You may specify only one of chains, categories, or groups.

See

https://radar.com/documentation/api#search-places

Declaration

Objective-C

+ (void)searchPlacesWithRadius:(int)radius
                        chains:(NSArray<NSString *> *_Nullable)chains
                    categories:(NSArray<NSString *> *_Nullable)categories
                        groups:(NSArray<NSString *> *_Nullable)groups
                         limit:(int)limit
             completionHandler:
                 (RadarSearchPlacesCompletionHandler)completionHandler;

Swift

class func searchPlaces(radius: Int32, chains: [String]?, categories: [String]?, groups: [String]?, limit: Int32) async -> (RadarStatus, CLLocation?, [RadarPlace]?)

Parameters

`radius`	The radius to search, in meters. A number between 100 and 10000.
`chains`	An array of chain slugs to filter. See https://radar.com/documentation/places/chains
`categories`	An array of categories to filter. See https://radar.com/documentation/places/categories
`groups`	An array of groups to filter. See https://radar.com/documentation/places/groups
`limit`	The max number of places to return. A number between 1 and 100.
`completionHandler`	A completion handler.


                    
                    
                    +searchPlacesWithRadius:chains:chainMetadata:categories:groups:limit:completionHandler:

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

Warning

You may specify only one of chains, categories, or groups; if chains are specified, chainMetadata can also be specified.

See

https://radar.com/documentation/api#search-places

Declaration

Objective-C

+ (void)searchPlacesWithRadius:(int)radius
                        chains:(NSArray<NSString *> *_Nullable)chains
                 chainMetadata:(NSDictionary<NSString *, NSString *> *_Nullable)
                                   chainMetadata
                    categories:(NSArray<NSString *> *_Nullable)categories
                        groups:(NSArray<NSString *> *_Nullable)groups
                         limit:(int)limit
             completionHandler:
                 (RadarSearchPlacesCompletionHandler)completionHandler;

Swift

class func searchPlaces(radius: Int32, chains: [String]?, chainMetadata: [String : String]?, categories: [String]?, groups: [String]?, limit: Int32) async -> (RadarStatus, CLLocation?, [RadarPlace]?)

Parameters

`radius`	The radius to search, in meters. A number between 100 and 10000.
`chains`	An array of chain slugs to filter. See https://radar.com/documentation/places/chains
`chainMetadata`	Optional chain metadata filters. Keys and values must be strings. See https://radar.com/documentation/places#metadata.
`categories`	An array of categories to filter. See https://radar.com/documentation/places/categories
`groups`	An array of groups to filter. See https://radar.com/documentation/places/groups
`limit`	The max number of places to return. A number between 1 and 100.
`completionHandler`	A completion handler.


                    
                    
                    +searchPlacesNear:radius:chains:categories:groups:limit:completionHandler:

Searches for places near a location, sorted by distance.

Warning

You may specify only one of chains, categories, or groups.

See

https://radar.com/documentation/api#search-places

Declaration

Objective-C

+ (void)searchPlacesNear:(nonnull CLLocation *)near
                  radius:(int)radius
                  chains:(NSArray<NSString *> *_Nullable)chains
              categories:(NSArray<NSString *> *_Nullable)categories
                  groups:(NSArray<NSString *> *_Nullable)groups
                   limit:(int)limit
       completionHandler:(RadarSearchPlacesCompletionHandler)completionHandler;

Swift

class func searchPlaces(near: CLLocation, radius: Int32, chains: [String]?, categories: [String]?, groups: [String]?, limit: Int32) async -> (RadarStatus, CLLocation?, [RadarPlace]?)

Parameters

`near`	The location to search.
`radius`	The radius to search, in meters. A number between 100 and 10000.
`chains`	An array of chain slugs to filter. See https://radar.com/documentation/places/chains
`categories`	An array of categories to filter. See https://radar.com/documentation/places/categories
`groups`	An array of groups to filter. See https://radar.com/documentation/places/groups
`limit`	The max number of places to return. A number between 1 and 100.
`completionHandler`	A completion handler.


                    
                    
                    +searchPlacesNear:radius:chains:chainMetadata:categories:groups:limit:completionHandler:

Searches for places near a location, sorted by distance.

Warning

You may specify only one of chains, categories, or groups.

See

https://radar.com/documentation/api#search-places

Declaration

Objective-C

+ (void)searchPlacesNear:(nonnull CLLocation *)near
                  radius:(int)radius
                  chains:(NSArray<NSString *> *_Nullable)chains
           chainMetadata:
               (NSDictionary<NSString *, NSString *> *_Nullable)chainMetadata
              categories:(NSArray<NSString *> *_Nullable)categories
                  groups:(NSArray<NSString *> *_Nullable)groups
                   limit:(int)limit
       completionHandler:(RadarSearchPlacesCompletionHandler)completionHandler;

Swift

class func searchPlaces(near: CLLocation, radius: Int32, chains: [String]?, chainMetadata: [String : String]?, categories: [String]?, groups: [String]?, limit: Int32) async -> (RadarStatus, CLLocation?, [RadarPlace]?)

Parameters

`near`	The location to search.
`radius`	The radius to search, in meters. A number between 100 and 10000.
`chains`	An array of chain slugs to filter. See https://radar.com/documentation/places/chains
`chainMetadata`	Optional chain metadata filters. Keys and values must be strings. See https://radar.com/documentation/places#metadata.
`categories`	An array of categories to filter. See https://radar.com/documentation/places/categories
`groups`	An array of groups to filter. See https://radar.com/documentation/places/groups
`limit`	The max number of places to return. A number between 1 and 100.
`completionHandler`	A completion handler.


                    
                    
                    +searchGeofencesWithRadius:tags:metadata:limit:completionHandler:

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

See

https://radar.com/documentation/api#search-geofences

Declaration

Objective-C

+ (void)searchGeofencesWithRadius:(int)radius
                             tags:(NSArray<NSString *> *_Nullable)tags
                         metadata:(NSDictionary *_Nullable)metadata
                            limit:(int)limit
                completionHandler:
                    (RadarSearchGeofencesCompletionHandler)completionHandler;

Swift

class func searchGeofences(radius: Int32, tags: [String]?, metadata: [AnyHashable : Any]?, limit: Int32) async -> (RadarStatus, CLLocation?, [RadarGeofence]?)

Parameters

`radius`	The radius to search, in meters. A number between 100 and 10000.
`tags`	An array of tags to filter. See https://radar.com/documentation/geofences
`metadata`	A dictionary of metadata to filter. See https://radar.com/documentation/geofences
`limit`	The max number of geofences to return. A number between 1 and 100.
`completionHandler`	A completion handler.


                    
                    
                    +searchGeofencesNear:radius:tags:metadata:limit:completionHandler:

Searches for geofences near a location, sorted by distance.

See

https://radar.com/documentation/api#search-geofences

Declaration

Objective-C

+ (void)searchGeofencesNear:(nonnull CLLocation *)near
                     radius:(int)radius
                       tags:(NSArray<NSString *> *_Nullable)tags
                   metadata:(NSDictionary *_Nullable)metadata
                      limit:(int)limit
          completionHandler:
              (RadarSearchGeofencesCompletionHandler)completionHandler;

Swift

class func searchGeofences(near: CLLocation, radius: Int32, tags: [String]?, metadata: [AnyHashable : Any]?, limit: Int32) async -> (RadarStatus, CLLocation?, [RadarGeofence]?)

Parameters

`near`	The location to search.
`radius`	The radius to search, in meters. A number between 100 and 10000.
`tags`	An array of tags to filter. See https://radar.com/documentation/geofences
`metadata`	A dictionary of metadata to filter. See https://radar.com/documentation/geofences
`limit`	The max number of geofences to return. A number between 1 and 100.
`completionHandler`	A completion handler.


                    
                    
                    +autocompleteQuery:near:layers:limit:country:completionHandler:

Autocompletes partial addresses and place names, sorted by relevance.

See

https://radar.com/documentation/api#autocomplete

Declaration

Objective-C

+ (void)autocompleteQuery:(NSString *_Nonnull)query
                     near:(CLLocation *_Nullable)near
                   layers:(NSArray<NSString *> *_Nullable)layers
                    limit:(int)limit
                  country:(NSString *_Nullable)country
        completionHandler:(RadarGeocodeCompletionHandler)completionHandler;

Swift

class func autocomplete(query: String, near: CLLocation?, layers: [String]?, limit: Int32, country: String?) async -> (RadarStatus, [RadarAddress]?)

Parameters

`query`	The partial address or place name to autocomplete.
`near`	A location for the search.
`layers`	Optional layer filters.
`limit`	The max number of addresses to return. A number between 1 and 100.
`country`	An optional country filter. A string, the unique 2-letter country code.
`completionHandler`	A completion handler.


                    
                    
                    +autocompleteQuery:near:limit:completionHandler:

Autocompletes partial addresses and place names, sorted by relevance.

See

https://radar.com/documentation/api#autocomplete

Declaration

Objective-C

+ (void)autocompleteQuery:(NSString *_Nonnull)query
                     near:(CLLocation *_Nullable)near
                    limit:(int)limit
        completionHandler:(RadarGeocodeCompletionHandler)completionHandler;

Swift

class func autocomplete(query: String, near: CLLocation?, limit: Int32) async -> (RadarStatus, [RadarAddress]?)

Parameters

`query`	The partial address or place name to autocomplete.
`near`	A location for the search.
`limit`	The max number of addresses to return. A number between 1 and 100.
`completionHandler`	A completion handler.

Geocoding


                    
                    
                    +geocodeAddress:completionHandler:

Geocodes an address, converting address to coordinates.

See

https://radar.com/documentation/api#forward-geocode

Declaration

Objective-C

+ (void)geocodeAddress:(NSString *_Nonnull)query
     completionHandler:(RadarGeocodeCompletionHandler)completionHandler;

Swift

class func geocode(address query: String) async -> (RadarStatus, [RadarAddress]?)

Parameters

`query`	The address to geocode.
`completionHandler`	A completion handler.


                    
                    
                    +reverseGeocodeWithCompletionHandler:

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

See

https://radar.com/documentation/api#reverse-geocode

Declaration

Objective-C

+ (void)reverseGeocodeWithCompletionHandler:
    (RadarGeocodeCompletionHandler)completionHandler;

Swift

class func reverseGeocode() async -> (RadarStatus, [RadarAddress]?)

Parameters


                                completionHandler

A completion handler.


                    
                    
                    +reverseGeocodeLocation:completionHandler:

Reverse geocodes a location, converting coordinates to address.

See

https://radar.com/documentation/api#reverse-geocode

Declaration

Objective-C

+ (void)reverseGeocodeLocation:(CLLocation *_Nonnull)location
             completionHandler:(RadarGeocodeCompletionHandler)completionHandler;

Swift

class func reverseGeocode(location: CLLocation) async -> (RadarStatus, [RadarAddress]?)

Parameters

`location`	The location to reverse geocode.
`completionHandler`	A completion handler.


                    
                    
                    +ipGeocodeWithCompletionHandler:

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

See

https://radar.com/documentation/api#ip-geocode

Declaration

Objective-C

+ (void)ipGeocodeWithCompletionHandler:
    (RadarIPGeocodeCompletionHandler)completionHandler;

Swift

class func ipGeocode() async -> (RadarStatus, RadarAddress?, Bool)

Parameters


                                completionHandler

A completion handler.

Distances


                    
                    
                    +getDistanceToDestination:modes:units:completionHandler:

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

See

https://radar.com/documentation/api#distance

Declaration

Objective-C

+ (void)getDistanceToDestination:(CLLocation *_Nonnull)destination
                           modes:(RadarRouteMode)modes
                           units:(RadarRouteUnits)units
               completionHandler:(RadarRouteCompletionHandler)completionHandler;

Swift

class func getDistance(destination: CLLocation, modes: RadarRouteMode, units: RadarRouteUnits) async -> (RadarStatus, RadarRoutes?)

Parameters

`destination`	The destination.
`modes`	The travel modes.
`units`	The distance units.
`completionHandler`	A completion handler.


                    
                    
                    +getDistanceFromOrigin:destination:modes:units:completionHandler:

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

See

https://radar.com/documentation/api#distance

Declaration

Objective-C

+ (void)getDistanceFromOrigin:(CLLocation *_Nonnull)origin
                  destination:(CLLocation *_Nonnull)destination
                        modes:(RadarRouteMode)modes
                        units:(RadarRouteUnits)units
            completionHandler:(RadarRouteCompletionHandler)completionHandler;

Swift

class func getDistance(origin: CLLocation, destination: CLLocation, modes: RadarRouteMode, units: RadarRouteUnits) async -> (RadarStatus, RadarRoutes?)

Parameters

`origin`	The origin.
`destination`	The destination.
`modes`	The travel modes.
`units`	The distance units.
`completionHandler`	A completion handler.


                    
                    
                    +getMatrixFromOrigins:destinations:mode:units:completionHandler:

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

See

https://radar.com/documentation/api#matrix

Declaration

Objective-C

+ (void)getMatrixFromOrigins:(NSArray<CLLocation *> *_Nonnull)origins
                destinations:(NSArray<CLLocation *> *_Nonnull)destinations
                        mode:(RadarRouteMode)mode
                       units:(RadarRouteUnits)units
           completionHandler:
               (RadarRouteMatrixCompletionHandler)completionHandler;

Swift

class func getMatrix(origins: [CLLocation], destinations: [CLLocation], mode: RadarRouteMode, units: RadarRouteUnits) async -> (RadarStatus, RadarRouteMatrix?)

Parameters

`origins`	The origins.
`destinations`	The destinations.
`mode`	The travel mode.
`units`	The distance units.
`completionHandler`	A completion handler.

Logging


                    
                    
                    +setLogLevel:

Sets the log level for debug logs.

Declaration

Objective-C

+ (void)setLogLevel:(RadarLogLevel)level;

Swift

class func setLogLevel(_ level: RadarLogLevel)

Parameters


                                level

The log level.

Utilities


                    
                    
                    +stringForStatus:

Returns a display string for a status value.

Declaration

Objective-C

+ (nonnull NSString *)stringForStatus:(RadarStatus)status;

Swift

class func stringForStatus(_ status: RadarStatus) -> String

Parameters


                                status

A status value.

Return Value

A display string for the status value.


                    
                    
                    +stringForLocationSource:

Returns a display string for a location source value.

Declaration

Objective-C

+ (nonnull NSString *)stringForLocationSource:(RadarLocationSource)source;

Swift

class func stringForLocationSource(_ source: RadarLocationSource) -> String

Parameters


                                source

A location source value.

Return Value

A display string for the location source value.


                    
                    
                    +stringForMode:

Returns a display string for a travel mode value.

Declaration

Objective-C

+ (nonnull NSString *)stringForMode:(RadarRouteMode)mode;

Swift

class func stringForMode(_ mode: RadarRouteMode) -> String

Parameters


                                mode

A travel mode value.

Return Value

A display string for the travel mode value.


                    
                    
                    +stringForTripStatus:

Returns a display string for a trip status value.

Declaration

Objective-C

+ (nonnull NSString *)stringForTripStatus:(RadarTripStatus)status;

Swift

class func stringForTripStatus(_ status: RadarTripStatus) -> String

Parameters


                                status

A trip status value.

Return Value

A display string for the trip status value.


                    
                    
                    +dictionaryForLocation:

Returns a dictionary for a location.

Declaration

Objective-C

+ (nonnull NSDictionary *)dictionaryForLocation:(nonnull CLLocation *)location;

Swift

class func dictionaryForLocation(_ location: CLLocation) -> [AnyHashable : Any]

Parameters


                                location

A location.

Return Value

A dictionary for the location.