Page Summary
-
BeaconFence allows for creating fences that detect nearby beacons with associated attachments.
-
Fences indicating a changing state, such as found or lost, are momentarily true for about 5 seconds before reverting to false.
-
The
foundmethod creates a fence that is true when a beacon of a specified type is detected. -
The
lostmethod creates a fence that is true when a beacon of a specified type is no longer detected. -
The
nearmethod creates a fence that is true when a beacon of a specified type is found and not lost.
Use this class to create beacon fences.
The fences in this class support detecting nearby beacons that are associated with attachments, which are a triple of namespace, type, and content.
Note: Values that indicate a changing state are momentarily TRUE
for about 5 seconds, then automatically revert to FALSE
.
Public Method Summary
| static AwarenessFence | |
| static AwarenessFence | |
| static AwarenessFence | |
| static AwarenessFence | |
| static AwarenessFence | |
| static AwarenessFence |
Inherited Method Summary
Public Methods
public static AwarenessFence found ( Collection < BeaconState.TypeFilter > beaconTypes)
This fence is momentarily TRUE
(about 5 seconds) when a beacon with the specified types is found.
To use this API, your app must declare the android.permission.ACCESS_FINE_LOCATION
permission in AndroidManifest.xml,
and the user must provide consent at runtime.
Parameters
BeaconState.TypeFilter
non-empty beacon types listing to scan for.Returns
Throws
public static AwarenessFence found ( TypeFilter... beaconTypes)
This fence is momentarily TRUE
(about 5 seconds) when a beacon with the specified types is found.
To use this API, your app must declare the android.permission.ACCESS_FINE_LOCATION
permission in AndroidManifest.xml,
and the user must provide consent at runtime.
Parameters
BeaconState.TypeFilter
non-empty beacon types listing to scan for.Returns
Throws
public static AwarenessFence lost ( TypeFilter... beaconTypes)
This fence is momentarily TRUE
(about 5 seconds) when a beacon with the specified types is lost.
To use this API, your app must declare the android.permission.ACCESS_FINE_LOCATION
permission in AndroidManifest.xml,
and the user must provide consent at runtime.
Parameters
BeaconState.TypeFilter
non-empty beacon types listing to scan for.Returns
Throws
public static AwarenessFence lost ( Collection < BeaconState.TypeFilter > beaconTypes)
This fence is momentarily TRUE
(about 5 seconds) when a beacon with the specified types is lost.
To use this API, your app must declare the android.permission.ACCESS_FINE_LOCATION
permission in AndroidManifest.xml,
and the user must provide consent at runtime.
Parameters
BeaconState.TypeFilter
non-empty beacon types listing to scan for.Returns
Throws
public static AwarenessFence near ( TypeFilter... beaconTypes)
This fence evaluates to TRUE
if any of the specified types is found but not lost.
To use this API, your app must declare the android.permission.ACCESS_FINE_LOCATION
permission in AndroidManifest.xml,
and the user must provide consent at runtime.
Parameters
BeaconState.TypeFilter
non-empty beacon types listing to scan for.Returns
Throws
public static AwarenessFence near ( Collection < BeaconState.TypeFilter > beaconTypes)
This fence evaluates to TRUE
if any of the specified types is found but not lost.
To use this API, your app must declare the android.permission.ACCESS_FINE_LOCATION
permission in AndroidManifest.xml,
and the user must provide consent at runtime.
Parameters
BeaconState.TypeFilter
non-empty beacon types listing to scan for.