KitConfig (Proximity Kit Android 0.13.0)

java.lang.Object
- com.radiusnetworks.proximity.KitConfig

```
public final class KitConfig
extends Object
```
Configuration settings for a Proximity Kit.
This represents all of the necessary, and some optional, settings necessary to run a Proximity Kit. This is used by a ProximityKitManager to determine how to sync with the cloud server and transmit usage statistics.

Since:

0.10.0

See Also:

ProximityKitManager

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALLOW_UNSUPPORTED_GOOGLE_PLAY` Flag allowing an unsupported version of Google Play to be used.
`static String`	`CONFIG_ANALYTICS_URL` URL to app specific kit endpoint on the analytics server.
`static String`	`CONFIG_API_TOKEN` Required. App secret API token used to authenticated with Proximity Kit.
`static String`	`CONFIG_API_URL` Required. URL to app specific kit endpoint on the Proximity Kit server.
`static String`	`CONFIG_CELLULAR_DATA` Flag allowing the use of cellular connections for data sync and usage statistics uploads.
`static String`	`CONFIG_PARTNER_ID` The partner identifier string for analytics.
`static String`	`CONFIG_SYNC_INTERVAL` Length of time, in milliseconds, between syncs with the Proximity Kit server.
`static long`	`DEFAULT_SYNC_INTERVAL` Default sync interval in milliseconds.
`static long`	`MIN_SYNC_INTERVAL` Minimum sync interval in milliseconds.
`static List`	`REQUIRED_KEYS` Immutable list of configuration keys required to be set.

Constructor Summary

Constructors
Constructor and Description

KitConfig(Map config)
Create a Proximity Kit configuration using the provided Map.

Constructors
Constructor and Description
`KitConfig(Map config)` Create a Proximity Kit configuration using the provided `Map`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`allowsCellularData()` Lookup if usage of cellular data is allowed for network communications.
`boolean`	`allowsUnsupportedGooglePlay()` Lookup if geofences are allowed to use an unsupported version of Google Play.
`String`	`getAnalyticsURL()` Lookup the analytics url registered for the Proximity Kit.
`String`	`getApiToken()` Lookup the registered Proximity Kit API token.
`String`	`getApiUrl()` Lookup the registered Proximity Kit API resource URL.
`String`	`getKitId()` The Proximity Kit identifier extracted from the API resource URL.
`String`	`getPartnerId()` Lookup the partner identifier used for grouping usage statistics.
`long`	`getSyncInterval()` Lookup the cloud server data sync interval in milliseconds.
`boolean`	`isCellularDataAllowed()` Lookup if usage of cellular data is allowed for network communications.
`boolean`	`isUnsupportedGooglePlayAllowed()` Lookup if geofences are allowed to use an unsupported version of Google Play.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CONFIG_ANALYTICS_URL
```
public static final String CONFIG_ANALYTICS_URL
```
    URL to app specific kit endpoint on the analytics server.
    This key is optional. Omitting this key will prevent analytics data from being sent to the Radius Networks servers.
    
    See Also:
    
    Constant Field Values
  - CONFIG_API_TOKEN
```
public static final String CONFIG_API_TOKEN
```
    Required. App secret API token used to authenticated with Proximity Kit.
    
    See Also:
    
    Constant Field Values
  - CONFIG_API_URL
```
public static final String CONFIG_API_URL
```
    Required. URL to app specific kit endpoint on the Proximity Kit server.
    
    See Also:
    
    Constant Field Values
  - CONFIG_CELLULAR_DATA
```
public static final String CONFIG_CELLULAR_DATA
```
    Flag allowing the use of cellular connections for data sync and usage statistics uploads.
    Default is true. Note: both null and the empty string are consider absence of values, resulting in this being set to true. Any other value is considered false.
    
    See Also:
    
    Constant Field Values
  - CONFIG_PARTNER_ID
```
public static final String CONFIG_PARTNER_ID
```
    The partner identifier string for analytics.
    Limited to 255 characters. Default value null.
    
    See Also:
    
    Constant Field Values
  - CONFIG_SYNC_INTERVAL
```
public static final String CONFIG_SYNC_INTERVAL
```
    Length of time, in milliseconds, between syncs with the Proximity Kit server.
    For most apps setting this to a value between one and twenty four hours is sufficient. We suggest tuning this based on how frequently a kit is updated. If the kit is rarely updated then set this to a high value like every 24-hours or more.
    In the event that a region is added or updated on the server, the app must sync in order to receive this new information. However, syncing does tax battery life as well as consume network bandwidth, so we do not recommend setting this to a low value.
    During initial development, where kit data may change frequently, it may be desirable to set this sync interval to a low value. However, we caution you to remember to reset it to a higher value for the production app.
    Minimum value is 300000L ms. Default value is 3600000L ms.
    If this is not set in the configuration, is set to null, or is the empty string then the default value is used.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SYNC_INTERVAL
```
public static final long DEFAULT_SYNC_INTERVAL
```
    Default sync interval in milliseconds.
    
    See Also:
    
    Constant Field Values
  - MIN_SYNC_INTERVAL
```
public static final long MIN_SYNC_INTERVAL
```
    Minimum sync interval in milliseconds.
    We strongly advise against setting the sync interval to this value. Such a low value is primarily made available for debugging and initial app development purposes. This will cause significant battery drain and greatly increase network usage.
    This value is not recommended for production app usage.
    
    See Also:
    
    Constant Field Values
  - ALLOW_UNSUPPORTED_GOOGLE_PLAY
```
public static final String ALLOW_UNSUPPORTED_GOOGLE_PLAY
```
    Flag allowing an unsupported version of Google Play to be used.
    When enabling geofences the Proximity Kit manager checks the version of Google Play used by the app. If the version is not supported an exception is thrown. By enabling this flag a warning is logged instead of throwing the exception. The resulting geofence implementation will attempt to use the unsupported Google Play version.
    Warning: As this allows untested versions of Google Play apps may crash at runtime.
    Default value false.
    
    Since:
    
    0.12.0
    
    See Also:
    
    Constant Field Values
  - REQUIRED_KEYS
```
public static final List REQUIRED_KEYS
```
    Immutable list of configuration keys required to be set.
    Contains:
    - CONFIG_API_TOKEN
    - CONFIG_API_URL
- Constructor Detail
  - KitConfig
```
public KitConfig(Map config)
```
    Create a Proximity Kit configuration using the provided Map.
    The provided config must contain values for all required keys. Any additional keys are optional. For any optional key omitted from the map the documented default values will be used.
    
    Parameters:
    
    config - Settings for connecting with a Proximity Kit. Keys are accessed via the above CONFIG_* constants. Values, except for null, are converted to strings using String.valueOf(Object).
    
    Throws:
    
    MissingKeyException - If config does not contain one or more required keys.
    
    MissingValueException - If config contains null or an empty string for a required key value.
    
    NullPointerException - If config is null.
    
    NumberFormatException - If the value set for KitConfig.CONFIG_SYNC_INTERVAL cannot be parsed into a long.
- Method Detail
  - allowsCellularData
```
public boolean allowsCellularData()
```
    Lookup if usage of cellular data is allowed for network communications.
    Default is true.
    
    Returns:
    
    true if cellular data connections are allowed for network communication; false otherwise.
    
    See Also:
    
    KitConfig.isCellularDataAllowed()
  - allowsUnsupportedGooglePlay
```
public boolean allowsUnsupportedGooglePlay()
```
    Lookup if geofences are allowed to use an unsupported version of Google Play.
    Default is false.
    
    Returns:
    
    true if unsupported Google Play versions are allowed; false otherwise.
    
    Since:
    
    0.12.0
    
    See Also:
    
    KitConfig.isUnsupportedGooglePlayAllowed()
  - getAnalyticsURL
```
public String getAnalyticsURL()
```
    Lookup the analytics url registered for the Proximity Kit.
    
    Returns:
    
    The registered analytics url. Will not be null or an empty string.
  - getApiToken
```
public String getApiToken()
```
    Lookup the registered Proximity Kit API token.
    
    Returns:
    
    The registered API token to use to access the Proximity Kit server. Will not be null or an empty string.
    
    See Also:
    
    KitConfig.getApiUrl()
  - getApiUrl
```
public String getApiUrl()
```
    Lookup the registered Proximity Kit API resource URL.
    
    Returns:
    
    The registered API resource URL associated with the Proximity Kit. Will not be null or an empty string.
    
    See Also:
    
    KitConfig.getApiToken()
  - getKitId
```
public String getKitId()
```
    The Proximity Kit identifier extracted from the API resource URL.
    
    Returns:
    
    The identifier for this Proximity Kit as referenced by the API resource URL. May be null or an empty string if the API resource URL was malformed.
    
    See Also:
    
    KitConfig.getApiUrl()
  - getPartnerId
```
public String getPartnerId()
```
    Lookup the partner identifier used for grouping usage statistics.
    
    Returns:
    
    The registered partner identifier used to group analytics. May be null if no identifier was registered.
  - getSyncInterval
```
public long getSyncInterval()
```
    Lookup the cloud server data sync interval in milliseconds.
    
    Returns:
    
    The registered interval, in milliseconds, for syncing data with the cloud servers. If no interval was registered will return the default value of 3600000L. This value will never be less than 300000L.
  - isCellularDataAllowed
```
public boolean isCellularDataAllowed()
```
    Lookup if usage of cellular data is allowed for network communications.
    Default is true. This is an alias for KitConfig.allowsCellularData() to work with beans / common reflection rules.
    
    Returns:
    
    true if cellular data connections are allowed for network communication; false otherwise.
    
    See Also:
    
    KitConfig.allowsCellularData()
  - isUnsupportedGooglePlayAllowed
```
public boolean isUnsupportedGooglePlayAllowed()
```
    Lookup if geofences are allowed to use an unsupported version of Google Play.
    Default is false.
    
    Returns:
    
    true if unsupported Google Play versions are allowed; false otherwise.
    
    Since:
    
    0.12.0
    
    See Also:
    
    KitConfig.allowsUnsupportedGooglePlay()

Class KitConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONFIG_ANALYTICS_URL

CONFIG_API_TOKEN

CONFIG_API_URL

CONFIG_CELLULAR_DATA

CONFIG_PARTNER_ID

CONFIG_SYNC_INTERVAL

DEFAULT_SYNC_INTERVAL

MIN_SYNC_INTERVAL

ALLOW_UNSUPPORTED_GOOGLE_PLAY

REQUIRED_KEYS

Constructor Detail

KitConfig

Method Detail

allowsCellularData

allowsUnsupportedGooglePlay

getAnalyticsURL

getApiToken

getApiUrl

getKitId

getPartnerId

getSyncInterval

isCellularDataAllowed

isUnsupportedGooglePlayAllowed