BISRegion Class Reference

Inherits from NSObject
Declared in BISRegion.h
BISRegion.m

Overview

Represents a particular physical region. A BISRegion encapsulates information about a physical place including the establishment name, latitude, longitude, and any other information we have available. This class is immutable.

  beaconId

The id of the beacon

@property (nonatomic, strong, readonly) NSString *beaconId

Declared In

BISRegion.h

  city

The city of the region

@property (nonatomic, strong, readonly) NSString *city

Declared In

BISRegion.h

  country

The country of the region

@property (nonatomic, strong, readonly) NSString *country

Declared In

BISRegion.h

  establishment

The name of the establishment where the region is located

@property (nonatomic, strong, readonly) NSString *establishment

Declared In

BISRegion.h

  establishmentType

The type of establishment where the region is located

@property (nonatomic, strong, readonly) NSString *establishmentType

Declared In

BISRegion.h

  latitude

The latitude of the region

@property (nonatomic, readonly) double latitude

Declared In

BISRegion.h

  longitude

The longitude of the region

@property (nonatomic, readonly) double longitude

Declared In

BISRegion.h

  state

The state/province of the region

@property (nonatomic, strong, readonly) NSString *state

Declared In

BISRegion.h

  street

The street address of the region

@property (nonatomic, strong, readonly) NSString *street

Declared In

BISRegion.h

  timeZone

The time zone of the region

@property (nonatomic, strong, readonly) NSTimeZone *timeZone

Declared In

BISRegion.h

  touchpoint

The area where the beacon is placed inside the establishment

@property (nonatomic, strong, readonly) NSString *touchpoint

Declared In

BISRegion.h

  touchpointType

An NSArray of NSStrings that classify the region’s touchpoint ordered with increasing granularity

@property (nonatomic, strong, readonly) NSArray<NSString*> *touchpointType

Declared In

BISRegion.h

  verticalPosition

The floor of the region

@property (nonatomic, strong, readonly) NSString *verticalPosition

Declared In

BISRegion.h

  zip

The zip/postal code of the region

@property (nonatomic, strong, readonly) NSString *zip

Declared In

BISRegion.h

– distanceToBISRegion:withDistanceUnit:

Returns the distance between two regions’ latitude and longitude measured in the specified units

- (double)distanceToBISRegion:(BISRegion *)region withDistanceUnit:(BISDistanceUnit)unit

Parameters

region

The region to be compared against

unit

The unit of measurement for the distance calculation set through the BISDistanceUnit enum

Declared In

BISRegion.h

– distanceToCLLocation:withDistanceUnit:

Returns the distance between a BISRegion instance and a CLLocation object in the specified units

- (double)distanceToCLLocation:(CLLocation *)location withDistanceUnit:(BISDistanceUnit)unit

Parameters

location

The location to be compared against

unit

The unit of measurement for the distance calculation set through the BISDistanceUnit enum

Declared In

BISRegion.h

– capsules:

Get the capsules that exist for this region

- (void)capsules:(void ( ^ ) ( NSArray<BISCapsule*> *capsules , NSError *__nullable error ))completion

Parameters

completion

Returns an array of BISCapsules or an error

Declared In

BISRegion.h