public static final class ScanContext.Builder extends java.lang.Object implements GeneralConfigurator, SpacesConfigurator, FiltersConfigurator
Constructor and Description |
---|
Builder() |
Builder(ScanContext context) |
Modifier and Type | Method and Description |
---|---|
GeneralConfigurator |
activityCheckConfiguration(ActivityCheckConfiguration activityCheckConfiguration)
|
ScanContext.Builder |
addObservedProfile(DeviceProfile profile) |
ScanContext |
build() |
GeneralConfigurator |
cacheFileName(java.lang.String name)
Cache file name for resolved shuffled device ids from Kontakt.io Proximity REST API.
|
void |
clearAll()
Clears all currently set IBeacon and Eddystone filters;
|
GeneralConfigurator |
deviceUpdateCallbackInterval(long intervalInMillis)
The device update callback interval prevents the update from being called instantly.
|
FiltersConfigurator |
eddystoneFilter(EddystoneFilter filter)
Add single Eddystone
EddystoneFilter . |
FiltersConfigurator |
eddystoneFilters(java.util.Collection<EddystoneFilter> filters)
Add multiple Eddystone
EddystoneFilter . |
GeneralConfigurator |
eddystoneFrameTypes(java.util.Collection<EddystoneFrameType> eddystoneFrameTypes)
Sets trigger frame types.
|
SpacesConfigurator |
eddystoneNamespace(IEddystoneNamespace namespace)
Sets Eddystone namespace within which Eddystone devices are searched.
|
SpacesConfigurator |
eddystoneNamespaces(java.util.Collection<IEddystoneNamespace> namespaces)
Sets Eddystone namespaces within which Eddystone devices are searched.
|
GeneralConfigurator |
forceScanConfiguration(ForceScanConfiguration forceScanConfiguration)
Sets
ForceScanConfiguration . |
java.util.List<EddystoneFilter> |
getEddystoneFilters()
Returns currently set Eddystone filters.
|
java.util.Set<IEddystoneNamespace> |
getEddystoneNamespaces()
Returns currently set Eddystone namespaces.
|
java.util.List<IBeaconFilter> |
getIBeaconFilters()
Returns currently set iBeacon filters.
|
java.util.Set<IBeaconRegion> |
getIBeaconRegions()
Returns currently set iBeacon regions.
|
FiltersConfigurator |
iBeaconFilter(IBeaconFilter filter)
Add single
IBeaconFilter . |
FiltersConfigurator |
iBeaconFilters(java.util.Collection<IBeaconFilter> filters)
Add multiple
IBeaconFilter . |
SpacesConfigurator |
iBeaconRegion(IBeaconRegion region)
Sets IBeacon region within which IBeacon devices are searched.
|
SpacesConfigurator |
iBeaconRegions(java.util.Collection<IBeaconRegion> regions)
Sets IBeacon regions within which IBeacon devices are searched.
|
GeneralConfigurator |
monitoringEnabled(boolean enabled)
Enables or disables collecting monitoring events e.g. battery level of device.
|
GeneralConfigurator |
monitoringSyncInterval(int intervalInSeconds)
Interval between next monitoring events sync attempts in seconds.
|
ScanContext.Builder |
observedProfiles(java.util.Set<DeviceProfile> observedProfiles) |
ScanContext.Builder |
removeObservedProfile(DeviceProfile profile) |
GeneralConfigurator |
resolveShuffledInterval(int intervalInSeconds)
Interval between next shuffled beacons resolving attempts in seconds.
|
GeneralConfigurator |
rssiCalculator(RssiCalculator rssiCalculator)
Sets
RssiCalculator . |
GeneralConfigurator |
scanMode(ScanMode scanMode)
Sets
ScanMode . |
GeneralConfigurator |
scanPeriod(ScanPeriod scanPeriod)
Sets
ScanPeriod . |
GeneralConfigurator |
secureProfilePayloadResolver(PayloadResolver payloadResolver)
Sets custom payload resolver that is used internally to parse payload and resolve secure profile object from it.
|
GeneralConfigurator |
secureProfilePayloadResolvers(java.util.Collection<PayloadResolver> payloadResolvers)
Sets custom payload resolvers that are used internally to parse payloads and resolve secure profiles object.
|
public Builder()
public Builder(ScanContext context)
public GeneralConfigurator scanPeriod(ScanPeriod scanPeriod)
GeneralConfigurator
ScanPeriod
. Default: ScanPeriod.RANGING
scanPeriod
in interface GeneralConfigurator
scanPeriod
- ScanPeriodpublic GeneralConfigurator scanMode(ScanMode scanMode)
GeneralConfigurator
ScanMode
. Default: ScanMode.BALANCED
scanMode
in interface GeneralConfigurator
scanMode
- ScanModepublic GeneralConfigurator forceScanConfiguration(ForceScanConfiguration forceScanConfiguration)
GeneralConfigurator
ForceScanConfiguration
. This will always be set to DISABLED for Android N and higher (https://github.com/AltBeacon/android-beacon-library/issues/418).
ForceScanConfiguration.DISABLED
forceScanConfiguration
in interface GeneralConfigurator
forceScanConfiguration
- ForceScanConfigurationpublic GeneralConfigurator activityCheckConfiguration(ActivityCheckConfiguration activityCheckConfiguration)
GeneralConfigurator
ActivityCheckConfiguration
. Default: ActivityCheckConfiguration.DEFAULT
activityCheckConfiguration
in interface GeneralConfigurator
activityCheckConfiguration
- ActivityCheckConfiguration.public GeneralConfigurator cacheFileName(java.lang.String name)
GeneralConfigurator
InternalProximityManager
used in the same app.cacheFileName
in interface GeneralConfigurator
name
- file namepublic GeneralConfigurator monitoringEnabled(boolean enabled)
GeneralConfigurator
monitoringEnabled
in interface GeneralConfigurator
enabled
- true or falsepublic GeneralConfigurator monitoringSyncInterval(int intervalInSeconds)
GeneralConfigurator
monitoringSyncInterval
in interface GeneralConfigurator
intervalInSeconds
- interval in secondspublic GeneralConfigurator resolveShuffledInterval(int intervalInSeconds)
GeneralConfigurator
resolveShuffledInterval
in interface GeneralConfigurator
intervalInSeconds
- interval in secondspublic GeneralConfigurator deviceUpdateCallbackInterval(long intervalInMillis)
GeneralConfigurator
deviceUpdateCallbackInterval
in interface GeneralConfigurator
intervalInMillis
- Interval in milliseconds.public GeneralConfigurator rssiCalculator(RssiCalculator rssiCalculator)
GeneralConfigurator
RssiCalculator
.rssiCalculator
in interface GeneralConfigurator
rssiCalculator
- RSSI calculator instance.public GeneralConfigurator eddystoneFrameTypes(java.util.Collection<EddystoneFrameType> eddystoneFrameTypes)
GeneralConfigurator
eddystoneFrameTypes
in interface GeneralConfigurator
eddystoneFrameTypes
- eddystone format frame typespublic GeneralConfigurator secureProfilePayloadResolver(PayloadResolver payloadResolver)
GeneralConfigurator
secureProfilePayloadResolver
in interface GeneralConfigurator
payloadResolver
- the resolver implementation.public GeneralConfigurator secureProfilePayloadResolvers(java.util.Collection<PayloadResolver> payloadResolvers)
GeneralConfigurator
secureProfilePayloadResolvers
in interface GeneralConfigurator
payloadResolvers
- the resolvers collection.public SpacesConfigurator iBeaconRegion(IBeaconRegion region)
SpacesConfigurator
iBeaconRegion
in interface SpacesConfigurator
region
- the IBeacon regionpublic SpacesConfigurator iBeaconRegions(java.util.Collection<IBeaconRegion> regions)
SpacesConfigurator
iBeaconRegions
in interface SpacesConfigurator
regions
- the IBeacon regionspublic SpacesConfigurator eddystoneNamespace(IEddystoneNamespace namespace)
SpacesConfigurator
eddystoneNamespace
in interface SpacesConfigurator
namespace
- the eddystone namespacespublic SpacesConfigurator eddystoneNamespaces(java.util.Collection<IEddystoneNamespace> namespaces)
SpacesConfigurator
eddystoneNamespaces
in interface SpacesConfigurator
namespaces
- the eddystone namespacespublic java.util.Set<IBeaconRegion> getIBeaconRegions()
SpacesConfigurator
getIBeaconRegions
in interface SpacesConfigurator
public java.util.Set<IEddystoneNamespace> getEddystoneNamespaces()
SpacesConfigurator
getEddystoneNamespaces
in interface SpacesConfigurator
public FiltersConfigurator iBeaconFilter(IBeaconFilter filter)
FiltersConfigurator
iBeaconFilter
in interface FiltersConfigurator
filter
- IBeacon filter to addpublic FiltersConfigurator iBeaconFilters(java.util.Collection<IBeaconFilter> filters)
FiltersConfigurator
iBeaconFilters
in interface FiltersConfigurator
filters
- IBeacon filters to addpublic FiltersConfigurator eddystoneFilter(EddystoneFilter filter)
FiltersConfigurator
eddystoneFilter
in interface FiltersConfigurator
filter
- Eddystone UID filter to add.public FiltersConfigurator eddystoneFilters(java.util.Collection<EddystoneFilter> filters)
FiltersConfigurator
eddystoneFilters
in interface FiltersConfigurator
filters
- Eddystone UID filters to add.public java.util.List<IBeaconFilter> getIBeaconFilters()
FiltersConfigurator
getIBeaconFilters
in interface FiltersConfigurator
public java.util.List<EddystoneFilter> getEddystoneFilters()
FiltersConfigurator
getEddystoneFilters
in interface FiltersConfigurator
public void clearAll()
FiltersConfigurator
clearAll
in interface FiltersConfigurator
public ScanContext.Builder observedProfiles(java.util.Set<DeviceProfile> observedProfiles)
public ScanContext.Builder addObservedProfile(DeviceProfile profile)
public ScanContext.Builder removeObservedProfile(DeviceProfile profile)
public ScanContext build()