ESTNearableManagerDelegate

@protocol ESTNearableManagerDelegate <NSObject>

The ESTNearableManagerDelegate protocol defines the delegate methods used to receive nearable ranging and monitoring events from an <ESTNearableManager> object.

  • Tells the delegate that one or more nearables are in range.

    Declaration

    Objective-C

    - (void)nearableManager:(nonnull ESTNearableManager *)manager
          didRangeNearables:(nonnull NSArray<ESTNearable *> *)nearables
                   withType:(ESTNearableType)type;

    Swift

    optional func nearableManager(_ manager: ESTNearableManager, didRangeNearables nearables: [ESTNearable], with type: ESTNearableType)

    Parameters

    manager

    The nearable manager object reporting the event.

    nearables

    An array of <ESTNearable> objects representing the nearables currently in range. You can use the information in these objects to determine the range of each nearables and its identifying information.

    type

    The nearable type that was used to range the nearables.

  • Tells the delegate that nearable with particular identifier is in range.

    Declaration

    Objective-C

    - (void)nearableManager:(nonnull ESTNearableManager *)manager
           didRangeNearable:(nonnull ESTNearable *)nearable;

    Swift

    optional func nearableManager(_ manager: ESTNearableManager, didRangeNearable nearable: ESTNearable)

    Parameters

    manager

    The nearable manager object reporting the event.

    nearable

    An <ESTNearable> object representing the nearable currently in range. You can use the information in these objects to determine the range of nearable and its identifying information.

  • Tells the delegate that nearable ranging error occurred.

    Declaration

    Objective-C

    - (void)nearableManager:(nonnull ESTNearableManager *)manager
        rangingFailedWithError:(nonnull NSError *)error;

    Swift

    optional func nearableManager(_ manager: ESTNearableManager, rangingFailedWithError error: Error)

    Parameters

    manager

    The nearable manager object reporting the event.

    error

    An error object describing why monitoring failed.

  • Tells the delegate that the user entered region of specified nearable type.

    Declaration

    Objective-C

    - (void)nearableManager:(nonnull ESTNearableManager *)manager
         didEnterTypeRegion:(ESTNearableType)type;

    Swift

    optional func nearableManager(_ manager: ESTNearableManager, didEnterTypeRegion type: ESTNearableType)

    Parameters

    manager

    The nearable manager object reporting the event.

    type

    The nearable type region that was entered.

  • Tells the delegate that the user left the region of specified nearable type.

    Declaration

    Objective-C

    - (void)nearableManager:(nonnull ESTNearableManager *)manager
          didExitTypeRegion:(ESTNearableType)type;

    Swift

    optional func nearableManager(_ manager: ESTNearableManager, didExitTypeRegion type: ESTNearableType)

    Parameters

    manager

    The nearable manager object reporting the event.

    type

    The nearable type region that was exited.

  • Tells the delegate that the user entered region of specified nearable identifier.

    Declaration

    Objective-C

    - (void)nearableManager:(nonnull ESTNearableManager *)manager
        didEnterIdentifierRegion:(nonnull NSString *)identifier;

    Swift

    optional func nearableManager(_ manager: ESTNearableManager, didEnterIdentifierRegion identifier: String)

    Parameters

    manager

    The nearable manager object reporting the event.

    identifier

    The nearable identifier region that was entered.

  • Tells the delegate that the user left the region of specified nearable identifier.

    Declaration

    Objective-C

    - (void)nearableManager:(nonnull ESTNearableManager *)manager
        didExitIdentifierRegion:(nonnull NSString *)identifier;

    Swift

    optional func nearableManager(_ manager: ESTNearableManager, didExitIdentifierRegion identifier: String)

    Parameters

    manager

    The nearable manager object reporting the event.

    identifier

    The nearable identifier region that was exited.

  • Tells the delegate that nearable monitoring error occurred.

    Declaration

    Objective-C

    - (void)nearableManager:(nonnull ESTNearableManager *)manager
        monitoringFailedWithError:(nonnull NSError *)error;

    Swift

    optional func nearableManager(_ manager: ESTNearableManager, monitoringFailedWithError error: Error)

    Parameters

    manager

    The beacon manager object reporting the event.

    error

    An error object describing why monitoring failed.