EPXProximityZone


@interface EPXProximityZone : NSObject

Represents a logical zone. Is represented by range from a beacon and its tag. Can be spanned by one or more beacons. Beacon identification is tag-based (see https://github.com/Estimote/iOS-Proximity-SDK/blob/master/README.md for more info).

  • Range where the action should be reported.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic) EPXProximityRange *_Nonnull range;

    Swift

    var range: ProximityRange { get }
  • tag

    Tag assigned in Cloud to that zone.

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSString *_Nonnull tag;

    Swift

    var tag: String { get }
  • Register block to be called when user enters proximity of Estimote devices with matching tag. Beacon identification is tag-based (see https://github.com/Estimote/iOS-SDK/blob/sdk_5/README.md for more info).

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) void (^)
        (EPXProximityZoneContext *_Nonnull) onEnter;

    Swift

    var onEnter: ((ProximityZoneContext) -> Void)? { get set }
  • Block to be called when user exits proximity of Estimote devices with matching tag. Beacon identification is tag-based (see https://github.com/Estimote/iOS-SDK/blob/sdk_5/README.md for more info).

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) void (^)
        (EPXProximityZoneContext *_Nonnull) onExit;

    Swift

    var onExit: ((ProximityZoneContext) -> Void)? { get set }
  • Block to be called each time a new beacon is detected in user’s range and each time a beacon disappears from user’s range.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) void (^)
        (NSSet<EPXProximityZoneContext *> *_Nonnull) onContextChange;

    Swift

    var onContextChange: ((Set<ProximityZoneContext>) -> Void)? { get set }
  • Init is unavailable.

    Declaration

    Objective-C

    - (nonnull instancetype)init;
  • New is unavailable.

    Declaration

    Objective-C

    + (nonnull instancetype) new;
  • Designated initilizer.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTag:(nonnull NSString *)tag
                                  range:(nonnull EPXProximityRange *)range;

    Swift

    init(tag: String, range: ProximityRange)

    Parameters

    tag

    Tag name assigned to the zone.

    range

    Range where the action should be reported.