NAProximityPreferences (newaer-sdk-proximity API)

java.lang.Object
- com.newaer.sdk.proximity.NAProximityPreferences

public class NAProximityPreferences
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`DEFAULT_BLE_SCAN_TIME`
`static int`	`DEFAULT_BTS_SCAN_TIME`
`static long`	`DEFAULT_SCAN_INTERVAL`
`protected Context`	`mContext`
`static String`	`REMOTE_SCAN`
`static String`	`SCAN_INTERVAL`
`protected static CountDownLatch`	`sLatch`

Constructor Summary

Constructors
Constructor and Description

NAProximityPreferences(Context context)

Constructors
Constructor and Description
`NAProximityPreferences(Context context)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cacheDisabledScans(Collection<NAScanType> enabledScans)`
`void`	`clear()`
`static void`	`destroy(Context context)`
`static NAProximityPreferences`	`get()`
`String`	`getAppKey()`
`boolean`	`getAppKeyStatus()` Determines whether the platform is enabled/disabled.
`long`	`getAppKeyStatusTimestamp()`
`String`	`getAreaServerUrl()`
`long`	`getBtleScanTime()` in millis
`int`	`getBtSScanTime()`
`Set<NAScanType>`	`getCachedScans()` clears the cached scans after retrieval
`String`	`getFriendlyName()`
`byte[]`	`getInfo()`
`String`	`getNewAerId()`
`String`	`getPackage()`
`Set<NAScanType>`	`getPersistentScantypes()`
`boolean`	`getPrivateAdvertise()`
`long`	`getScanInterval()` in millis
`String`	`getServerUrl()`
`UUID`	`getServiceUUID()`
`String`	`getUserAgent()`
`static void`	`init(Context context)`
`void`	`initUserAgentString()`
`boolean`	`isEnabled(NAScanType type)`
`protected void`	`onDestroy(Context context)`
`void`	`registerChangeListener(SharedPreferences.OnSharedPreferenceChangeListener listener)` From the docs: Caution: The preference manager does not currently store a strong reference to the listener.
`static void`	`resetLatch()`
`void`	`setAppKey(String appKey)`
`void`	`setAppKeyStatus(boolean appKeyStatus)`
`void`	`setAppKeyStatusTimestamp(long appKeyStatusTimestamp)`
`void`	`setBtleScanTime(long scanTimeMillis)`
`void`	`setBtSScanTime(int scanTimeSeconds)`
`void`	`setDefaultEnabledTypes(List<NAScanType> defaultEnabledTypes)`
`void`	`setEnabled(NAScanType type, boolean enabled)`
`void`	`setFriendlyName(String friendlyName)`
`void`	`setInfo(byte[] info)`
`static void`	`setInstance(NAProximityPreferences instance)`
`void`	`setNewAerId(String newAerId)`
`void`	`setPackageName(String packageName)`
`void`	`setPrivateAdvertise(boolean advertise)`
`void`	`setRemoteScan(boolean scan)`
`void`	`setScanInterval(long scanInterval)` in millis
`void`	`setScantypesAsPersistent(NAScanType... types)`
`boolean`	`shouldRemoteScan()`
`void`	`unregisterChangeListener(SharedPreferences.OnSharedPreferenceChangeListener listener)`
`static void`	`waitForFinish()`

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

Field Detail

SCAN_INTERVAL

public static final String SCAN_INTERVAL

See Also:: Constant Field Values

REMOTE_SCAN
```
public static final String REMOTE_SCAN
```
See Also:

Constant Field Values

DEFAULT_SCAN_INTERVAL

public static final long DEFAULT_SCAN_INTERVAL

DEFAULT_BLE_SCAN_TIME

public static final long DEFAULT_BLE_SCAN_TIME

DEFAULT_BTS_SCAN_TIME
```
public static final int DEFAULT_BTS_SCAN_TIME
```
See Also:

Constant Field Values

sLatch
```
protected static CountDownLatch sLatch
```

mContext
```
protected final Context mContext
```

Constructor Detail

NAProximityPreferences

public NAProximityPreferences(Context context)

Method Detail

clear
```
public void clear()
```

setInstance

public static void setInstance(NAProximityPreferences instance)

init

public static void init(Context context)

onDestroy

protected void onDestroy(Context context)

get

public static NAProximityPreferences get()

setScanInterval

public void setScanInterval(long scanInterval)

in millis

getScanInterval
```
public long getScanInterval()
```
in millis

setInfo
```
public void setInfo(byte[] info)
```

getInfo
```
public byte[] getInfo()
```

getFriendlyName
```
public String getFriendlyName()
```

setFriendlyName

public void setFriendlyName(String friendlyName)

setEnabled

public void setEnabled(NAScanType type,
                       boolean enabled)

isEnabled

public boolean isEnabled(NAScanType type)

cacheDisabledScans

public void cacheDisabledScans(Collection<NAScanType> enabledScans)

getCachedScans
```
public Set<NAScanType> getCachedScans()
```
clears the cached scans after retrieval

setScantypesAsPersistent

public void setScantypesAsPersistent(NAScanType... types)

getPersistentScantypes

public Set<NAScanType> getPersistentScantypes()

getNewAerId
```
public String getNewAerId()
```

setNewAerId

public void setNewAerId(String newAerId)

setAppKey
```
public void setAppKey(String appKey)
```

setPackageName

public void setPackageName(String packageName)

getAppKey
```
public String getAppKey()
```

getPackage
```
public String getPackage()
```

getPrivateAdvertise
```
public boolean getPrivateAdvertise()
```

setPrivateAdvertise

public void setPrivateAdvertise(boolean advertise)

shouldRemoteScan
```
public boolean shouldRemoteScan()
```

setRemoteScan

public void setRemoteScan(boolean scan)

registerChangeListener
```
public void registerChangeListener(SharedPreferences.OnSharedPreferenceChangeListener listener)
```
From the docs:
Caution: The preference manager does not currently store a strong reference to the listener. You must store a strong reference to the listener, or it will be susceptible to garbage collection. We recommend you keep a reference to the listener in the instance data of an object that will exist as long as you need the listener.

unregisterChangeListener

public void unregisterChangeListener(SharedPreferences.OnSharedPreferenceChangeListener listener)

setDefaultEnabledTypes

public void setDefaultEnabledTypes(List<NAScanType> defaultEnabledTypes)

setBtSScanTime

public void setBtSScanTime(int scanTimeSeconds)

getBtSScanTime
```
public int getBtSScanTime()
```

setBtleScanTime

public void setBtleScanTime(long scanTimeMillis)

getBtleScanTime
```
public long getBtleScanTime()
```
in millis

getServiceUUID
```
public UUID getServiceUUID()
```

getUserAgent
```
public String getUserAgent()
```

initUserAgentString
```
public void initUserAgentString()
```

getAppKeyStatus
```
public boolean getAppKeyStatus()
```
Determines whether the platform is enabled/disabled.

Returns:

boolean key status

getAppKeyStatusTimestamp

public long getAppKeyStatusTimestamp()

setAppKeyStatus

public void setAppKeyStatus(boolean appKeyStatus)

setAppKeyStatusTimestamp

public void setAppKeyStatusTimestamp(long appKeyStatusTimestamp)

getServerUrl
```
public String getServerUrl()
```

getAreaServerUrl
```
public String getAreaServerUrl()
```

resetLatch
```
public static void resetLatch()
```

waitForFinish

public static void waitForFinish()
                          throws InterruptedException

Throws:: InterruptedException

destroy

public static void destroy(Context context)

Class NAProximityPreferences

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SCAN_INTERVAL

REMOTE_SCAN

DEFAULT_SCAN_INTERVAL

DEFAULT_BLE_SCAN_TIME

DEFAULT_BTS_SCAN_TIME

sLatch

mContext

Constructor Detail

NAProximityPreferences

Method Detail

clear

setInstance

init

onDestroy

get

setScanInterval

getScanInterval

setInfo

getInfo

getFriendlyName

setFriendlyName

setEnabled

isEnabled

cacheDisabledScans

getCachedScans

setScantypesAsPersistent

getPersistentScantypes

getNewAerId

setNewAerId

setAppKey

setPackageName

getAppKey

getPackage

getPrivateAdvertise

setPrivateAdvertise

shouldRemoteScan

setRemoteScan

registerChangeListener

unregisterChangeListener

setDefaultEnabledTypes

setBtSScanTime

getBtSScanTime

setBtleScanTime

getBtleScanTime

getServiceUUID

getUserAgent

initUserAgentString

getAppKeyStatus

getAppKeyStatusTimestamp

setAppKeyStatus

setAppKeyStatusTimestamp

getServerUrl

getAreaServerUrl

resetLatch

waitForFinish

destroy