RECOBeaconManagerDelegate Protocol Reference
| Conforms to | NSObject |
| Declared in | RECOBeaconManager.h |
Overview
The RECOBeaconManagerDelegate protocoal defines the methods used to receive RECOBeaconRegion updates from a RECOBeaconManager object.
Instance Methods
recoManager:didDetermineState:forRegion:
Tells the delegate about the state of the specified region.
- (void)recoManager:(RECOBeaconManager *)manager didDetermineState:(RECOBeaconRegionState)state forRegion:(RECOBeaconRegion *)regionParameters
- manager
The RECOBeaconManager object reporting the event.
- state
The state of the specified region. For a list of possible values, see the RECOBeaconRegionState type.
- region
The region whose state was determined.
Discussion
Tells the delegate about the state of the specified region.
The RECOBeaconManager calls this method whenever there is a boundary transition for a region. It calls this method in addition to calling the recoManager:didEnterRegion: and recoManager:didExitRegion: methods. The RECOBeaconManager also calls this method in response to a call to its requestStateForRegion: method, which runs asynchronously.
Declared In
RECOBeaconManager.hrecoManager:didEnterRegion:
Tells the delegate that the user entered the specified region.
- (void)recoManager:(RECOBeaconManager *)manager didEnterRegion:(RECOBeaconRegion *)regionParameters
- manager
The RECOBeaconManager object reporting the event.
- region
An object containing information about the region that was entered.
Discussion
Tells the delegate that the user entered the specified region.
Because regions are a shared application resource, every active RECOBeaconManager object delivers this message to its associated delegate. It does not matter which RECOBeaconManager actually registered the specified region. And if multiple RECOBeaconManagers share a delegate object, that delegate receives the message multiple times.
The region object provided may not be the same one that was registered. As a result, you should never perform pointer-level comparisons to determine equality. Instead, use the region’s identifier string to determine if your delegate should respond.
Declared In
RECOBeaconManager.hrecoManager:didExitRegion:
Tells the delegate that the user left the specified region.
- (void)recoManager:(RECOBeaconManager *)manager didExitRegion:(RECOBeaconRegion *)regionParameters
- manager
The RECOBeaconManager object reporting the event.
- region
An object containing information about the region that was entered.
Discussion
Tells the delegate that the user left the specified region.
Because regions are a shared application resource, every active RECOBeaconManager object delivers this message to its associated delegate. It does not matter which RECOBeaconManager actually registered the specified region. And if multiple RECOBeaconManagers share a delegate object, that delegate receives the message multiple times.
The region object provided may not be the same one that was registered. As a result, you should never perform pointer-level comparisons to determine equality. Instead, use the region’s identifier string to determine if your delegate should respond.
Declared In
RECOBeaconManager.hrecoManager:didRangeBeacons:inRegion:
Tells the delegate that one or more beacons are in range.
- (void)recoManager:(RECOBeaconManager *)manager didRangeBeacons:(NSArray *)beacons inRegion:(RECOBeaconRegion *)regionParameters
- manager
The RECOBeaconManager object reporting the event.
- beacons
An array of RECOBeacon objects representing the beacons currently in range. You can use the information in these objects to determine the range of each beacon and its identifying information.
- region
The region object containing the parameters that were used to locate the beacons.
Discussion
Tells the delegate that one or more beacons are in range.
The RECOBeaconManager calls this method whenever a beacon comes within range or goes out of range. The RECOBeaconManager also calls this method when the range of the beacon changes; for example, when the beacon gets closer.
The region object provided may not be the same one that was registered. As a result, you should never perform pointer-level comparisons to determine equality. Instead, use the region’s identifier string to determine if your delegate should respond.
Declared In
RECOBeaconManager.hrecoManager:didStartMonitoringForRegion:
Tells the delegate that a new region is being monitored.
- (void)recoManager:(RECOBeaconManager *)manager didStartMonitoringForRegion:(RECOBeaconRegion *)regionParameters
- manager
The RECOBeaconManager object reporting the event.
- region
The region that is being monitored.
Discussion
Tells the delegate that a new region is being monitored.
Declared In
RECOBeaconManager.hrecoManager:monitoringDidFailForRegion:withError:
Tells the delegate that a region monitoring error occurred.
- (void)recoManager:(RECOBeaconManager *)manager monitoringDidFailForRegion:(RECOBeaconRegion *)region withError:(NSError *)errorParameters
- manager
The RECOBeaconManager object reporting the event.
- region
The region for which the error occurred.
- error
An error object containing the error code that indicates why region monitoring failed.
Discussion
Tells the delegate that a region monitoring error occurred.
If an error occurs while trying to monitor a given region, the RECOBeaconManager sends this message to its delegate. Region monitoring might fail because the region itself cannot be monitored or because there was a more general failure in configuring the region monitoring service.
Although implementation of this method is optional, it is recommended that you implement it if you use region monitoring in your application.
Declared In
RECOBeaconManager.hrecoManager:rangingBeaconsDidFailForRegion:withError:
Tells the delegate that an error occurred while gathering ranging information for a set of beacons.
- (void)recoManager:(RECOBeaconManager *)manager rangingBeaconsDidFailForRegion:(RECOBeaconRegion *)region withError:(NSError *)errorParameters
- manager
The RECOBeaconManager object reporting the event.
- region
The region object that encountered the error.
- error
An error object containing the error code that indicates why ranging failed.
Discussion
Tells the delegate that an error occurred while gathering ranging information for a set of beacons.
Errors occur most often when registering a beacon region failed. If the region object itself is invalid or if it contains invalid data, the RECOBeaconManager calls this method to report the problem.
Declared In
RECOBeaconManager.h