ESTNearableManager

Deprecated

Deprecated since 4.31.0.


@interface ESTNearableManager : NSObject

The ESTNearableManager class defines the interface for ranging and monitoring nearables.

Nearable monitoring related methods

  • Starts monitoring for nearable with specified identifier.

    Events are delivered to the <[ESTNearableManagerDelegate nearableManager:didEnterIdentifierRegion:]> and <[ESTNearableManagerDelegate nearableManager:didExitIdentifierRegion:]> methods of your <delegate>. If there is an error, the nearable manager calls the <[ESTNearableManagerDelegate nearableManager:monitoringFailedWithError:]> method of your delegate instead.

    See

    nearableManager:stopMonitoringForIdentifier:

    Declaration

    Objective-C

    - (void)startMonitoringForIdentifier:(nonnull NSString *)identifier;

    Swift

    func startMonitoring(forIdentifier identifier: String)

    Parameters

    identifier

    Nearable unique identifier that you want to monitor for. This parameter must not be nil.

  • Stops monitoring for nearable with specified identifier.

    If object with specified identifier is not currently being monitored, this method has no effect.

    See

    nearableManager:startMonitoringForIdentifier:

    Declaration

    Objective-C

    - (void)stopMonitoringForIdentifier:(nonnull NSString *)identifier;

    Swift

    func stopMonitoring(forIdentifier identifier: String)

    Parameters

    identifier

    The object’s identifier currently being monitored. This parameter must not be nil.

  • Starts monitoring for nearables with specified type.

    Events are delivered to the <[ESTNearableManagerDelegate nearableManager:didEnterTypeRegion:]> and <[ESTNearableManagerDelegate nearableManager:didExitTypeRegion:]> methods of your <delegate>. If there is an error, the nearable manager calls the <[ESTNearableManagerDelegate nearableManager:monitoringFailedWithError:]> method of your delegate instead.

    See

    nearableManager:stopMonitoringForIdentifier:

    Declaration

    Objective-C

    - (void)startMonitoringForType:(ESTNearableType)type;

    Swift

    func startMonitoring(for type: ESTNearableType)

    Parameters

    type

    Nearable type that you want to monitor for. This parameter must not be nil.

  • Stops monitoring for nearables with specified type.

    If objects with specified type are not currently being monitored, this method has no effect.

    See

    nearableManager:startMonitoringForType:

    Declaration

    Objective-C

    - (void)stopMonitoringForType:(ESTNearableType)type;

    Swift

    func stopMonitoring(for type: ESTNearableType)

    Parameters

    type

    The nearable type currently being monitored. This parameter must not be nil.

  • Stops monitoring for all types and identifiers that were monitored.

    If there is nothing currently being monitored, this method has no effect.

    See

    nearableManager:stopMonitoringForIdentifier:

    See

    nearableManager:stopMonitoringForType:

    Declaration

    Objective-C

    - (void)stopMonitoring;

    Swift

    func stopMonitoring()

Nearable ranging related methods

  • Starts the delivery of notifications for nearables with specified identifier.

    Once registered, the nearable manager reports any encountered nearable to its delegate by calling the <[ESTNearableManagerDelegate nearableManager:didRangeNearable:]> method. If there is an error registering the specified nearable type, the nearable manager calls its delegate’s <[ESTNearableManagerDelegate nearableManager:rangingFailedWithError:]> method and provides the appropriate error information.

    See

    stopRangingForType:

    Declaration

    Objective-C

    - (void)startRangingForIdentifier:(nonnull NSString *)identifier;

    Swift

    func startRanging(forIdentifier identifier: String)

    Parameters

    identifier

    The identifier of nearables. This parameter must not be nil

  • Stops the delivery of notifications for the specified nearable identifier.

    See

    nearableManager:startRangingForType:

    Declaration

    Objective-C

    - (void)stopRangingForIdentifier:(nonnull NSString *)identifier;

    Swift

    func stopRanging(forIdentifier identifier: String)

    Parameters

    identifier

    The identifier of nearables. This parameter must not be nil

  • Starts the delivery of notifications for nearables with specified type.

    Once registered, the nearable manager reports any encountered nearable to its delegate by calling the <[ESTNearableManagerDelegate nearableManager:didRangeNearables:withType:]> method. If there is an error registering the specified nearable type, the nearable manager calls its delegate’s <[ESTNearableManagerDelegate nearableManager:rangingFailedWithError:]> method and provides the appropriate error information.

    See

    stopRangingForType:

    Declaration

    Objective-C

    - (void)startRangingForType:(ESTNearableType)type;

    Swift

    func startRanging(for type: ESTNearableType)

    Parameters

    type

    The type of nearables. This parameter must not be nil

  • Stops the delivery of notifications for the specified nearable type.

    See

    startRangingForType:

    Declaration

    Objective-C

    - (void)stopRangingForType:(ESTNearableType)type;

    Swift

    func stopRanging(for type: ESTNearableType)

    Parameters

    type

    The type of nearables. This parameter must not be nil

  • Stops ranging all types and identifiers that were ranged.

    If there is nothing currently being ranged, this method has no effect.

    See

    stopRangingForIdentifier:

    See

    stopRangingForType:

    Declaration

    Objective-C

    - (void)stopRanging;

    Swift

    func stopRanging()