GeneralConfigurator (Kontakt.io - Android SDK (4.0.2))

All Known Implementing Classes:

ScanContext.Builder
```
public interface GeneralConfigurator
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`GeneralConfigurator`	`activityCheckConfiguration(ActivityCheckConfiguration activityCheckConfiguration)` Sets `ActivityCheckConfiguration`.
`GeneralConfigurator`	`cacheFileName(java.lang.String name)` Cache file name for resolved shuffled device ids from Kontakt.io Proximity REST API.
`GeneralConfigurator`	`deviceUpdateCallbackInterval(long intervalInMillis)` The device update callback interval prevents the update from being called instantly.
`GeneralConfigurator`	`eddystoneFrameTypes(java.util.Collection<EddystoneFrameType> eddystoneFrameTypes)` Sets trigger frame types.
`GeneralConfigurator`	`forceScanConfiguration(ForceScanConfiguration forceScanConfiguration)` Sets `ForceScanConfiguration`.
`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.
`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.

- Method Detail
  - scanPeriod
```
GeneralConfigurator scanPeriod(ScanPeriod scanPeriod)
```
    Sets ScanPeriod. Default: ScanPeriod.RANGING
    
    Parameters:
    
    scanPeriod - ScanPeriod
    
    Returns:
    
    GeneralConfigurator builder
  - scanMode
```
GeneralConfigurator scanMode(ScanMode scanMode)
```
    Sets ScanMode. Default: ScanMode.BALANCED
    
    Parameters:
    
    scanMode - ScanMode
    
    Returns:
    
    GeneralConfigurator builder
  - forceScanConfiguration
```
GeneralConfigurator forceScanConfiguration(ForceScanConfiguration forceScanConfiguration)
```
    Sets ForceScanConfiguration. This will always be set to DISABLED for Android N and higher (https://github.com/AltBeacon/android-beacon-library/issues/418).
    Default: ForceScanConfiguration.DISABLED
    
    Parameters:
    
    forceScanConfiguration - ForceScanConfiguration
    
    Returns:
    
    GeneralConfigurator builder
  - activityCheckConfiguration
```
GeneralConfigurator activityCheckConfiguration(ActivityCheckConfiguration activityCheckConfiguration)
```
    Sets ActivityCheckConfiguration. Default: ActivityCheckConfiguration.DEFAULT
    
    Parameters:
    
    activityCheckConfiguration - ActivityCheckConfiguration.
    
    Returns:
    
    GeneralConfigurator builder.
  - cacheFileName
```
GeneralConfigurator cacheFileName(java.lang.String name)
```
    Cache file name for resolved shuffled device ids from Kontakt.io Proximity REST API. Cache file name must be unique for safe serialization between different InternalProximityManager used in the same app.
    
    Parameters:
    
    name - file name
    
    Returns:
    
    GeneralConfigurator builder
  - monitoringEnabled
```
GeneralConfigurator monitoringEnabled(boolean enabled)
```
    Enables or disables collecting monitoring events e.g. battery level of device. Default: ENABLED.
    
    Parameters:
    
    enabled - true or false
    
    Returns:
    
    GeneralConfigurator builder
  - monitoringSyncInterval
```
GeneralConfigurator monitoringSyncInterval(int intervalInSeconds)
```
    Interval between next monitoring events sync attempts in seconds. Must be greater than 0. Default: 10 seconds.
    
    Parameters:
    
    intervalInSeconds - interval in seconds
    
    Returns:
    
    GeneralConfigurator builder
  - resolveShuffledInterval
```
GeneralConfigurator resolveShuffledInterval(int intervalInSeconds)
```
    Interval between next shuffled beacons resolving attempts in seconds. Must be greater than 0. Default: 3 seconds.
    
    Parameters:
    
    intervalInSeconds - interval in seconds
    
    Returns:
    
    GeneralConfigurator builder
  - deviceUpdateCallbackInterval
```
GeneralConfigurator deviceUpdateCallbackInterval(long intervalInMillis)
```
    The device update callback interval prevents the update from being called instantly.
    Once the Android device enters a space with many BLE devices the update event starts to be called with instantly growing number of updated BLE devices.
    This may cause interruptions when interacting with UI. The device update callback interval option causes the update callback to be invoked no more often than given interval. Default: 3000 milliseconds.
    
    Parameters:
    
    intervalInMillis - Interval in milliseconds.
    
    Returns:
    
    GeneralConfigurator builder
  - rssiCalculator
```
GeneralConfigurator rssiCalculator(RssiCalculator rssiCalculator)
```
    Sets RssiCalculator.
    
    Parameters:
    
    rssiCalculator - RSSI calculator instance.
    
    Returns:
    
    GeneralConfigurator builder
  - eddystoneFrameTypes
```
GeneralConfigurator eddystoneFrameTypes(java.util.Collection<EddystoneFrameType> eddystoneFrameTypes)
```
    Sets trigger frame types. The trigger frame types specify with which frame types received at least the Eddystone device should be notified.
    If not set Eddystone device will be notified as soon as any frame will be scanned (UID, URL or TLM).
    
    Parameters:
    
    eddystoneFrameTypes - eddystone format frame types
    
    Returns:
    
    GeneralConfigurator builder
  - secureProfilePayloadResolver
```
GeneralConfigurator secureProfilePayloadResolver(PayloadResolver payloadResolver)
```
    Sets custom payload resolver that is used internally to parse payload and resolve secure profile object from it. Resolving algorithm is provided by user's implementation.
    
    Parameters:
    
    payloadResolver - the resolver implementation.
    
    Returns:
    
    GeneralConfigurator builder.
  - secureProfilePayloadResolvers
```
GeneralConfigurator secureProfilePayloadResolvers(java.util.Collection<PayloadResolver> payloadResolvers)
```
    Sets custom payload resolvers that are used internally to parse payloads and resolve secure profiles object. Resolving algorithms are provided by user's implementation.
    
    Parameters:
    
    payloadResolvers - the resolvers collection.
    
    Returns:
    
    GeneralConfigurator builder.

Interface GeneralConfigurator

Method Summary

Method Detail

scanPeriod

scanMode

forceScanConfiguration

activityCheckConfiguration

cacheFileName

monitoringEnabled

monitoringSyncInterval

resolveShuffledInterval

deviceUpdateCallbackInterval

rssiCalculator

eddystoneFrameTypes

secureProfilePayloadResolver

secureProfilePayloadResolvers