RadarContext

Represents the context for a location. The context includes geofences, places, and regions that are relevant to a specific location. Learn more in the Context API documentation.

Properties

[RadarGeofence]

required

An array of the geofences for the location. May be empty if the location is not in any geofences.See the Geofences documentation for more information.

RadarPlace

The place for the location. May be nil if the location is not at a place or if Places is not enabled.See the Places documentation for more information.

RadarRegion

The country of the location. May be nil if country is not available or if Regions is not enabled.See the Regions documentation for more information.

RadarRegion

The state of the location. May be nil if state is not available or if Regions is not enabled.See the Regions documentation for more information.

RadarRegion

The designated market area (DMA) of the location. May be nil if DMA is not available or if Regions is not enabled.See the Regions documentation for more information.

RadarRegion

The postal code of the location. May be nil if postal code is not available or if Regions is not enabled.See the Regions documentation for more information.

Methods

dictionaryValue

func dictionaryValue() -> [AnyHashable: Any]

- (NSDictionary *_Nonnull)dictionaryValue;

Converts the context to a dictionary representation. Returns: A dictionary representation of the context.

Nested Objects

Show RadarGeofence

Represents a geofence at the location.

String

required

The Radar ID of the geofence.

String

required

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

String

The tag of the geofence.

String

The external ID of the geofence.

[String: Any]

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

RadarGeofenceGeometry

required

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

RadarOperatingHours

The optional operating hours for the geofence.

Show RadarPlace

Represents a place at the location.

String

required

The Radar ID of the place.

String

required

The name of the place.

[String]

required

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

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.

RadarCoordinate

required

The location of the place.

String

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

[String: Any]

The metadata for the place, if part of a group. For details of metadata fields see the Places groups documentation.

RadarAddress

The address of the place.

Methods

func isChain(_ slug: String?) -> Bool

- (BOOL)isChain:(NSString *_Nullable)slug;

Returns a boolean indicating whether the place is part of the specified chain.

String

The chain slug to check.

Returns: true if the place is part of the specified chain, false otherwise.

func hasCategory(_ category: String?) -> Bool

- (BOOL)hasCategory:(NSString *_Nullable)category;

Returns a boolean indicating whether the place has the specified category.

String

The category to check.

Returns: true if the place has the specified category, false otherwise.

Show RadarRegion

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

String

required

The Radar ID of the region.

String

required

The name of the region.

String

required

The unique code for the region.

String

required

The type of the region (e.g., “country”, “state”, “dma”, “postalCode”).

String

The optional flag of the region.

Bool

required

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

Bool

required

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

Bool

required

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

Bool

required

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

Double

required

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

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.

String

required

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

String

required

The name of the chain.

String

The external ID of the chain.

[String: Any]

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

Show RadarAddress

Represents an address.

CLLocationCoordinate2D

required

The location coordinate of the address.

String

The formatted string representation of the address.

String

The name of the country of the address.

String

The unique code of the country of the address.

String

The flag of the country of the address.

String

The name of the DMA of the address.

String

The unique code of the DMA of the address.

String

The name of the state of the address.

String

The unique code of the state of the address.

String

The postal code of the address.

String

The city of the address.

String

The borough of the address.

String

The county of the address.

String

The neighborhood of the address.

String

The street number of the address.

String

The street name of the address.

String

The label of the address.

String

The label of the place.

String

The unit of the address.

String

The plus4 value for the zip of the address.

NSNumber

The distance to the search anchor in meters.

String

The layer of the address, e.g. ‘place’, ‘address’, ‘intersection’, ‘street’, ‘state’, etc.

[String: Any]

The metadata of the address.

RadarAddressConfidence

required

The confidence level of the geocoding result. Possible values: none (0), exact (1), interpolated (2), fallback (3).

RadarTimeZone

The time zone information of the address.

[String]

The categories of the address.

Show RadarCoordinate

Represents a location coordinate.

CLLocationCoordinate2D

required

The coordinate containing latitude and longitude.

Example Usage

Radar.getContext { (status, location, context) in
    if status == .success, let context = context {
        // Access geofences
        for geofence in context.geofences {
            print("In geofence: \(geofence.__description)")
        }
        
        // Check place
        if let place = context.place {
            print("At place: \(place.name)")
        }
        
        // Check regions
        if let country = context.country {
            print("Country: \(country.name)")
        }
        if let state = context.state {
            print("State: \(state.name)")
        }
    }
}

[Radar getContextWithCompletionHandler:^(RadarStatus status, CLLocation * _Nullable location, RadarContext * _Nullable context) {
    if (status == RadarStatusSuccess && context) {
        // Access geofences
        for (RadarGeofence *geofence in context.geofences) {
            NSLog(@"In geofence: %@", geofence.__description);
        }
        
        // Check place
        if (context.place) {
            NSLog(@"At place: %@", context.place.name);
        }
        
        // Check regions
        if (context.country) {
            NSLog(@"Country: %@", context.country.name);
        }
        if (context.state) {
            NSLog(@"State: %@", context.state.name);
        }
    }
}];

Core

Tracking

Events & Context

Geofences & Places

Location Data

Fraud & Verification

Extensions

Properties

Methods

dictionaryValue

Nested Objects

Methods

Example Usage

See Also

​Properties

​Methods

​dictionaryValue

​Nested Objects

​Methods

​Example Usage

​See Also

Properties

Methods

dictionaryValue

Nested Objects

Methods

Example Usage

See Also