Skip navigation links
Proximity Kit Android 0.14.0
A B C D E F G I K L M O P R S T U V 

A

ACTION_REGION_ENTER - Static variable in class com.radiusnetworks.proximity.RegionEvent
Broadcast Action: Sent when the device has entered a monitored region.
ACTION_REGION_EXIT - Static variable in class com.radiusnetworks.proximity.RegionEvent
Broadcast Action: Sent when the device has exited a monitored region.
ACTION_REGION_STATE_DETERMINED - Static variable in class com.radiusnetworks.proximity.RegionEvent
Broadcast Action: Sent on state updates for a monitored region.
Advertisement - Class in com.radiusnetworks.transmission
This class provides APIs to broadcast as a beacon
Advertisement.BeaconLayout - Class in com.radiusnetworks.transmission
Beacon layout enum
Advertisement.Builder - Class in com.radiusnetworks.transmission
Builder class for Advertisement.
ALLOW_UNSUPPORTED_GOOGLE_PLAY - Static variable in class com.radiusnetworks.proximity.KitConfig
Flag allowing an unsupported version of Google Play to be used.
allowsCellularData() - Method in class com.radiusnetworks.proximity.KitConfig
Lookup if usage of cellular data is allowed for network communications.
allowsUnsupportedGooglePlay() - Method in class com.radiusnetworks.proximity.KitConfig
Lookup if geofences are allowed to use an unsupported version of Google Play.
AlreadyInitializedException - Exception in com.radiusnetworks.util
An AlreadyInitializedException may be thrown when an object has been created and another instance cannot conceivably be created again.
AlreadyInitializedException(String) - Constructor for exception com.radiusnetworks.util.AlreadyInitializedException
Constructs a new AlreadyInitializedException with the specified detail message.
AlreadyInitializedException(String, Throwable) - Constructor for exception com.radiusnetworks.util.AlreadyInitializedException
Constructs a new AlreadyInitializedException with the specified detail message and cause.
ALTBEACON - Static variable in class com.radiusnetworks.transmission.Advertisement.BeaconLayout
 
analyticsUrl - Variable in class com.radiusnetworks.proximity.licensing.Configuration
Deprecated.
As of 0.13.0, no replacement.
asGeofences() - Method in class com.radiusnetworks.proximity.model.KitMap
 

B

BeaconManager - Class in com.radiusnetworks.proximity.beacon
Deprecated.
Not for public use. As of 0.13.0, no replacement.
bestMatch(List, Region) - Static method in class com.radiusnetworks.proximity.ProximityKitBeaconRegion
Creates a region matching the provided beacons.
bestMatchingKitBeacon(List, Region) - Static method in class com.radiusnetworks.proximity.model.KitBeacon
 
bestMatchingKitBeacon(List, Beacon) - Static method in class com.radiusnetworks.proximity.model.KitBeacon
 
build() - Method in class com.radiusnetworks.transmission.Advertisement.Builder
Build the Advertisement object.
Builder() - Constructor for class com.radiusnetworks.transmission.Advertisement.Builder
 

C

clearClient() - Static method in class com.radiusnetworks.proximity.beacon.BeaconManager
Deprecated.
Not for public use. As of 0.13.0, no replacement.
clearPartnerId() - Method in class com.radiusnetworks.proximity.licensing.LicenseManager
Deprecated.
As of 0.13.0, no replacement.
clearPartnerIdentifier() - Method in class com.radiusnetworks.proximity.ProximityKitManager
Deprecated.
com.radiusnetworks.proximity - package com.radiusnetworks.proximity
 
com.radiusnetworks.proximity.beacon - package com.radiusnetworks.proximity.beacon
 
com.radiusnetworks.proximity.geofence - package com.radiusnetworks.proximity.geofence
 
com.radiusnetworks.proximity.licensing - package com.radiusnetworks.proximity.licensing
 
com.radiusnetworks.proximity.model - package com.radiusnetworks.proximity.model
 
com.radiusnetworks.transmission - package com.radiusnetworks.transmission
 
com.radiusnetworks.util - package com.radiusnetworks.util
 
CONFIG_ANALYTICS_URL - Static variable in class com.radiusnetworks.proximity.KitConfig
URL to app specific kit endpoint on the analytics server.
CONFIG_API_TOKEN - Static variable in class com.radiusnetworks.proximity.KitConfig
Required. App secret API token used to authenticated with Proximity Kit.
CONFIG_API_URL - Static variable in class com.radiusnetworks.proximity.KitConfig
Required. URL to app specific kit endpoint on the Proximity Kit server.
CONFIG_CELLULAR_DATA - Static variable in class com.radiusnetworks.proximity.KitConfig
Flag allowing the use of cellular connections for data sync and usage statistics uploads.
CONFIG_PARTNER_ID - Static variable in class com.radiusnetworks.proximity.KitConfig
The partner identifier string for analytics.
CONFIG_SYNC_INTERVAL - Static variable in class com.radiusnetworks.proximity.KitConfig
Length of time, in milliseconds, between syncs with the Proximity Kit server.
Configuration - Class in com.radiusnetworks.proximity.licensing
Deprecated.
As of 0.13.0, no replacement.
Configuration(Context) - Constructor for class com.radiusnetworks.proximity.licensing.Configuration
Deprecated.
Configuration(Context, Configuration, String, String) - Constructor for class com.radiusnetworks.proximity.licensing.Configuration
Deprecated.
Configuration(Context, KitConfig) - Constructor for class com.radiusnetworks.proximity.licensing.Configuration
Deprecated.
As of 0.13.0, no replacement.
context - Variable in class com.radiusnetworks.proximity.ProximityKitManager
Deprecated.
Not for public use - no replacement. As of 0.13.0 this field could possibly be retained only as a private implementation detail.

D

dataNotifier - Variable in class com.radiusnetworks.proximity.beacon.BeaconManager
Deprecated.
Not for public use. As of 0.13.0, no replacement.
debugOn() - Static method in class com.radiusnetworks.proximity.ProximityKitManager
Turns debugging on for geofences and beacons.
DEFAULT_SYNC_INTERVAL - Static variable in class com.radiusnetworks.proximity.KitConfig
Default sync interval in milliseconds.
deviceId - Variable in class com.radiusnetworks.proximity.licensing.Configuration
Deprecated.
As of 0.13.0, no replacement.
didDetermineStateForGeofence(int, ProximityKitGeofenceRegion) - Method in interface com.radiusnetworks.proximity.ProximityKitGeofenceNotifier
Provides major state events for a geofence region.
didDetermineStateForRegion(int, ProximityKitBeaconRegion) - Method in interface com.radiusnetworks.proximity.ProximityKitMonitorNotifier
Provides major state events for a beacon region.
didEnterGeofence(ProximityKitGeofenceRegion) - Method in interface com.radiusnetworks.proximity.ProximityKitGeofenceNotifier
Called when the Android device is inside the defined geofence region.
didEnterRegion(ProximityKitBeaconRegion) - Method in interface com.radiusnetworks.proximity.ProximityKitMonitorNotifier
Called when at least one beacon matching the region criteria is visible.
didExitGeofence(ProximityKitGeofenceRegion) - Method in interface com.radiusnetworks.proximity.ProximityKitGeofenceNotifier
Called when the Android device transitions to outside the defined geofence region.
didExitRegion(ProximityKitBeaconRegion) - Method in interface com.radiusnetworks.proximity.ProximityKitMonitorNotifier
Called when no beacons matching the region criteria are visible.
didFailSync(Exception) - Method in interface com.radiusnetworks.proximity.ProximityKitSyncNotifier
Called after a failed sync of the registered kit with the cloud.
didRangeBeaconsInRegion(Collection, ProximityKitBeaconRegion) - Method in interface com.radiusnetworks.proximity.ProximityKitRangeNotifier
Provides details for currently observed beacons within a region configured for ranging.
didSync() - Method in interface com.radiusnetworks.proximity.ProximityKitSyncNotifier
Called after a successful sync of the registered the kit with the cloud.
disableGeofences() - Method in class com.radiusnetworks.proximity.ProximityKitManager
Explicitly disable geofence support.

E

EDDYSTONE_UID - Static variable in class com.radiusnetworks.transmission.Advertisement.BeaconLayout
 
EDDYSTONE_URL - Static variable in class com.radiusnetworks.transmission.Advertisement.BeaconLayout
 
enableGeofences() - Method in class com.radiusnetworks.proximity.ProximityKitManager
Explicitly enable geofence support.
exists() - Method in class com.radiusnetworks.proximity.licensing.PropertiesFile
Deprecated.
As of 0.13.0, no replacement.

F

fromIntent(Intent) - Static method in class com.radiusnetworks.proximity.RegionEvent
Creates a new RegionEvent instance from the provided intent.
fromJson(JSONObject) - Static method in class com.radiusnetworks.proximity.model.Kit
Creates a new Kit from the provided json.
fromJson(JSONObject) - Static method in class com.radiusnetworks.proximity.model.KitBeacon
 
fromJson(JSONObject) - Static method in class com.radiusnetworks.proximity.model.KitMap
Creates a new KitMap from the provided json.
fromJson(JSONObject) - Static method in class com.radiusnetworks.proximity.model.KitOverlay
Create an overlay from the provided JSON.

G

GeofenceService - Class in com.radiusnetworks.proximity.geofence
This class receives geofence transition events from Location Services, in the form of an Intent containing the transition type and geofence id(s) that triggered the event.
GeofenceService() - Constructor for class com.radiusnetworks.proximity.geofence.GeofenceService
 
getAccountId() - Method in class com.radiusnetworks.proximity.licensing.LicenseManager
Deprecated.
As of 0.13.0, no replacement.
getAnalyticsURL() - Method in class com.radiusnetworks.proximity.KitConfig
Lookup the analytics url registered for the Proximity Kit.
getAnalyticsURL() - Method in class com.radiusnetworks.proximity.model.Kit
 
getApiToken() - Method in class com.radiusnetworks.proximity.KitConfig
Lookup the registered Proximity Kit API token.
getApiUrl() - Method in class com.radiusnetworks.proximity.KitConfig
Lookup the registered Proximity Kit API resource URL.
getAttributes() - Method in class com.radiusnetworks.proximity.model.KitBeacon
 
getAttributes() - Method in class com.radiusnetworks.proximity.model.KitOverlay
 
getAttributes() - Method in class com.radiusnetworks.proximity.ProximityKitBeacon
Meta data attributes defined for the beacon on the Proximity Kit server.
getAttributes() - Method in class com.radiusnetworks.proximity.ProximityKitBeaconRegion
Metadata attributes associated with this region.
getAttributes() - Method in class com.radiusnetworks.proximity.ProximityKitGeofenceRegion
Set of custom attributes configured for this geofence on Proximity Kit.
getAttributes() - Method in interface com.radiusnetworks.proximity.ProximityRegion
Metadata attributes associated with this region.
getBatteryLevel() - Method in class com.radiusnetworks.proximity.ProximityKitBeacon
Advertised remaining battery level, as a percentage, for the beacon.
getBeaconAdapter() - Method in class com.radiusnetworks.proximity.ProximityKitManager
Deprecated.
Not for public use. As of 0.13.0, no replacement.
getBeaconManager() - Method in class com.radiusnetworks.proximity.ProximityKitManager
Deprecated.
Not for public use. As of 0.13.0, no replacement.
getBeacons() - Method in class com.radiusnetworks.proximity.model.Kit
 
getConfiguration() - Method in class com.radiusnetworks.proximity.licensing.LicenseManager
Deprecated.
As of 0.13.0, no replacement.
getDataNotifier() - Method in class com.radiusnetworks.proximity.beacon.BeaconManager
Deprecated.
Not for public use. As of 0.13.0, no replacement.
getDeviceId() - Method in class com.radiusnetworks.proximity.licensing.Configuration
Deprecated.
As of 0.13.0, no replacement.
getDeviceId() - Method in class com.radiusnetworks.proximity.licensing.LicenseManager
Deprecated.
As of 0.13.0, no replacement.
getGeofences() - Method in class com.radiusnetworks.proximity.model.Kit
List of geofences region defined in this kit.
getIdentifier() - Method in class com.radiusnetworks.proximity.model.KitBeacon
 
getIdentifier() - Method in class com.radiusnetworks.proximity.model.KitOverlay
Entity identifier for this overlay.
getIdentifier() - Method in class com.radiusnetworks.proximity.ProximityKitBeaconRegion
Entity identifier for this region.
getIdentifier() - Method in class com.radiusnetworks.proximity.ProximityKitGeofenceRegion
Entity identifier for this geofence region.
getIdentifier() - Method in interface com.radiusnetworks.proximity.ProximityRegion
Entity identifier for this region.
getIdentifiers() - Method in class com.radiusnetworks.proximity.ProximityKitBeaconRegion
Returns the list of identifiers represented by this region.
getInputStream() - Method in class com.radiusnetworks.proximity.licensing.PropertiesFile
Deprecated.
As of 0.13.0, no replacement.
getInstance(Context, KitConfig) - Static method in class com.radiusnetworks.proximity.ProximityKitManager
Creates an instance of ProximityKitManager.
getInstanceForApplication(Context) - Static method in class com.radiusnetworks.proximity.beacon.BeaconManager
Deprecated.
Not for public use. As of 0.13.0, no replacement.
getInstanceForApplication(Context) - Static method in class com.radiusnetworks.proximity.ProximityKitManager
Deprecated.
getKey() - Method in exception com.radiusnetworks.util.MissingKeyException
Missing key which caused this exception.
getKey() - Method in exception com.radiusnetworks.util.MissingValueException
Key missing a value which caused this exception.
getKit() - Method in class com.radiusnetworks.proximity.ProximityKitManager
Current instance of the Kit setup on the Proximity Kit cloud servers.
getKitId() - Method in class com.radiusnetworks.proximity.KitConfig
The Proximity Kit identifier extracted from the API resource URL.
getKitUrl() - Method in class com.radiusnetworks.proximity.licensing.Configuration
Deprecated.
As of 0.13.0, no replacement.
getLatitude() - Method in class com.radiusnetworks.proximity.model.KitBeacon
 
getLatitude() - Method in class com.radiusnetworks.proximity.model.KitOverlay
 
getLatitude() - Method in class com.radiusnetworks.proximity.ProximityKitGeofenceRegion
Getter for accessing this geofence's latitude.
getLicenseKey() - Method in class com.radiusnetworks.proximity.licensing.Configuration
Deprecated.
As of 0.13.0, no replacement.
getLicenseManager() - Method in class com.radiusnetworks.proximity.beacon.BeaconManager
Deprecated.
Not for public use. As of 0.13.0, no replacement.
getLongitude() - Method in class com.radiusnetworks.proximity.model.KitBeacon
 
getLongitude() - Method in class com.radiusnetworks.proximity.model.KitOverlay
 
getLongitude() - Method in class com.radiusnetworks.proximity.ProximityKitGeofenceRegion
Getter for accessing this geofence's longitude.
getMajor() - Method in class com.radiusnetworks.proximity.model.KitBeacon
 
getMap() - Method in class com.radiusnetworks.proximity.model.Kit
 
getMaxRegionsBeforeRollup() - Method in class com.radiusnetworks.proximity.ProximityKitManager
Deprecated.
As of release 0.5.0. This setting no longer does anything, as regions for monitoring and ranging may now be explicitly configured on the ProximityKit server. If you are using this roll up feature, please switch to configuring your ranging and monitoring regions explicitly on the server. Gets the maximum number of regions that may be individually configured in ProximityKit before the regions will start being automatically combined. This method has been deprecated and the setting no longer has any effect.
getMinor() - Method in class com.radiusnetworks.proximity.model.KitBeacon
 
getMonitorNotifier() - Method in class com.radiusnetworks.proximity.beacon.BeaconManager
Deprecated.
Not for public use. As of 0.13.0 no replacement.
getName() - Method in class com.radiusnetworks.proximity.model.KitBeacon
 
getName() - Method in class com.radiusnetworks.proximity.model.KitOverlay
 
getName() - Method in class com.radiusnetworks.proximity.ProximityKitBeacon
Name of the beacon as configured on the Proximity Kit server
getName() - Method in class com.radiusnetworks.proximity.ProximityKitBeaconRegion
Display name for this region.
getName() - Method in class com.radiusnetworks.proximity.ProximityKitGeofenceRegion
Getter for accessing this geofence's name.
getName() - Method in interface com.radiusnetworks.proximity.ProximityRegion
Display name for this region.
getOverlays() - Method in class com.radiusnetworks.proximity.model.Kit
 
getOverlays() - Method in class com.radiusnetworks.proximity.model.KitMap
Deprecated.
As of 0.13.0, replaced by KitMap.asGeofences().
getPartnerId() - Method in class com.radiusnetworks.proximity.KitConfig
Lookup the partner identifier used for grouping usage statistics.
getPartnerId() - Method in class com.radiusnetworks.proximity.licensing.Configuration
Deprecated.
As of 0.13.0, no replacement.
getProximityKitGeofenceNotifier() - Method in class com.radiusnetworks.proximity.ProximityKitManager
Getter for the currently configured Geofence notification callback handler.
getProximityKitMonitorNotifier() - Method in class com.radiusnetworks.proximity.ProximityKitManager
 
getProximityKitRangeNotifier() - Method in class com.radiusnetworks.proximity.ProximityKitManager
 
getProximityKitSyncNotifier() - Method in class com.radiusnetworks.proximity.ProximityKitManager
 
getProximityUuid() - Method in class com.radiusnetworks.proximity.model.KitBeacon
 
getRadius() - Method in class com.radiusnetworks.proximity.model.KitOverlay
 
getRadius() - Method in class com.radiusnetworks.proximity.ProximityKitGeofenceRegion
Getter for accessing this geofence's configured radius.
getRegionState() - Method in class com.radiusnetworks.proximity.RegionEvent
Returns the state of triggering region when the event was broadcast.
getRequestId() - Method in class com.radiusnetworks.proximity.ProximityKitGeofenceRegion
Custom ID representation of this geofence to identify it in a map.
getServerCheckCount() - Method in class com.radiusnetworks.proximity.licensing.LicenseManager
Deprecated.
Not for public use. As of 0.12.0 no replacement.
getStatusToken() - Method in class com.radiusnetworks.proximity.model.Kit
 
getStatusURL() - Method in class com.radiusnetworks.proximity.model.Kit
 
getSyncInterval() - Method in class com.radiusnetworks.proximity.KitConfig
Lookup the cloud server data sync interval in milliseconds.
getTeamId() - Method in class com.radiusnetworks.proximity.model.Kit
 
getTriggeringRegion() - Method in class com.radiusnetworks.proximity.RegionEvent
The ProximityRegion which triggered the event to be broadcast.
GooglePlayServicesException - Exception in com.radiusnetworks.proximity.geofence
Exception raised when Google Play services is required but is not linked.
GooglePlayServicesException() - Constructor for exception com.radiusnetworks.proximity.geofence.GooglePlayServicesException
Constructs a new missing google play service exception with null as its detail message.
GooglePlayServicesException(String) - Constructor for exception com.radiusnetworks.proximity.geofence.GooglePlayServicesException
Constructs a new runtime exception with the specified detail message.
GooglePlayServicesException(String, Throwable) - Constructor for exception com.radiusnetworks.proximity.geofence.GooglePlayServicesException
Constructs a new runtime exception with the specified detail message and cause.
GooglePlayServicesException(Throwable) - Constructor for exception com.radiusnetworks.proximity.geofence.GooglePlayServicesException
Constructs a new runtime exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

I

IBEACON - Static variable in class com.radiusnetworks.transmission.Advertisement.BeaconLayout
 
INSIDE - Static variable in interface com.radiusnetworks.proximity.ProximityKitGeofenceNotifier
Deprecated.
As of 0.13.0, replaced by RegionEvent.INSIDE.
INSIDE - Static variable in interface com.radiusnetworks.proximity.ProximityKitMonitorNotifier
Deprecated.
As of 0.13.0, replaced by RegionEvent.INSIDE.
INSIDE - Static variable in class com.radiusnetworks.proximity.RegionEvent
Indicates the Android device is inside the defined region.
isCellularDataAllowed() - Method in class com.radiusnetworks.proximity.KitConfig
Lookup if usage of cellular data is allowed for network communications.
isMonitoringEnabled() - Method in class com.radiusnetworks.proximity.model.KitBeacon
 
isRangingEnabled() - Method in class com.radiusnetworks.proximity.model.KitBeacon
 
isUnsupportedGooglePlayAllowed() - Method in class com.radiusnetworks.proximity.KitConfig
Lookup if geofences are allowed to use an unsupported version of Google Play.

K

Kit - Class in com.radiusnetworks.proximity.model
A kit created on the ProximityKit server.
KitBeacon - Class in com.radiusnetworks.proximity.model
A Beacon created on on the ProximityKit server
KitBeacon() - Constructor for class com.radiusnetworks.proximity.model.KitBeacon
 
KitConfig - Class in com.radiusnetworks.proximity
Configuration settings for a Proximity Kit.
KitConfig(Map) - Constructor for class com.radiusnetworks.proximity.KitConfig
Create a Proximity Kit configuration using the provided Map.
KitMap - Class in com.radiusnetworks.proximity.model
A geofence map created on the ProximityKit server
KitMap() - Constructor for class com.radiusnetworks.proximity.model.KitMap
 
KitOverlay - Class in com.radiusnetworks.proximity.model
An overlay (geofence) created on the ProximityKit server
KitOverlay() - Constructor for class com.radiusnetworks.proximity.model.KitOverlay
Deprecated.
Not for public use - no replacement. As of 0.12.0 this method could possibly be retained only as a private method.
kitUrl - Variable in class com.radiusnetworks.proximity.licensing.Configuration
Deprecated.
As of 0.13.0, no replacement.

L

licenseChanged(Context) - Method in class com.radiusnetworks.proximity.beacon.BeaconManager
Deprecated.
Not for public use. As of 0.13.0, no replacement.
licenseKey - Variable in class com.radiusnetworks.proximity.licensing.Configuration
Deprecated.
As of 0.13.0, no replacement.
LicenseManager - Class in com.radiusnetworks.proximity.licensing
Deprecated.
As of 0.13.0, no replacement.
LicenseManager(Context) - Constructor for class com.radiusnetworks.proximity.licensing.LicenseManager
Deprecated.
As of 0.13.0, no replacement.
LicenseManager(Context, Configuration, String, Date) - Constructor for class com.radiusnetworks.proximity.licensing.LicenseManager
Deprecated.
Not for public use. As of 0.12.0 no replacement.
LicensingException - Exception in com.radiusnetworks.proximity.licensing
Deprecated.
As of 0.13.0, no replacement.
LicensingException(String, Throwable) - Constructor for exception com.radiusnetworks.proximity.licensing.LicensingException
Deprecated.
As of 0.13.0, no replacement.
LicensingException(String) - Constructor for exception com.radiusnetworks.proximity.licensing.LicensingException
Deprecated.
As of 0.13.0, no replacement.

M

MIN_SYNC_INTERVAL - Static variable in class com.radiusnetworks.proximity.KitConfig
Minimum sync interval in milliseconds.
MissingKeyException - Exception in com.radiusnetworks.util
A MissingKeyException may be thrown when a method is invoked with a map argument which does not contain an expected or required key.
MissingKeyException(String) - Constructor for exception com.radiusnetworks.util.MissingKeyException
Constructs a new MissingKeyException with the specified missing key.
MissingKeyException(String, Throwable) - Constructor for exception com.radiusnetworks.util.MissingKeyException
Constructs a new MissingValueException with the specified missing key and cause.
MissingKeyException(String, String) - Constructor for exception com.radiusnetworks.util.MissingKeyException
Constructs a new MissingValueException with the specified detail message and missing key.
MissingKeyException(String, String, Throwable) - Constructor for exception com.radiusnetworks.util.MissingKeyException
Constructs a new MissingValueException with the specified detail message, missing key, and cause.
MissingValueException - Exception in com.radiusnetworks.util
A MissingValueException may be thrown when a method is invoked with a map argument which is missing a value for an expected key.
MissingValueException(String) - Constructor for exception com.radiusnetworks.util.MissingValueException
Constructs a new MissingValueException with the specified key which is missing a value.
MissingValueException(String, Throwable) - Constructor for exception com.radiusnetworks.util.MissingValueException
Constructs a new MissingValueException with the specified key, which is missing a value, and cause.
MissingValueException(String, String) - Constructor for exception com.radiusnetworks.util.MissingValueException
Constructs a new MissingValueException with the specified detail message and key which is missing a value.
MissingValueException(String, String, Throwable) - Constructor for exception com.radiusnetworks.util.MissingValueException
Constructs a new MissingValueException with the specified detail message, key which is missing a value, and cause.

O

onHandleIntent(Intent) - Method in class com.radiusnetworks.proximity.geofence.GeofenceService
 
OUTSIDE - Static variable in interface com.radiusnetworks.proximity.ProximityKitGeofenceNotifier
Deprecated.
As of 0.13.0, replaced by RegionEvent.OUTSIDE.
OUTSIDE - Static variable in interface com.radiusnetworks.proximity.ProximityKitMonitorNotifier
Deprecated.
As of 0.13.0, replaced by RegionEvent.OUTSIDE.
OUTSIDE - Static variable in class com.radiusnetworks.proximity.RegionEvent
Indicates the Android device is outside the defined region.

P

partnerId - Variable in class com.radiusnetworks.proximity.licensing.Configuration
Deprecated.
As of 0.13.0, no replacement.
PROPERTIES_FILE_NAME - Static variable in class com.radiusnetworks.proximity.licensing.PropertiesFile
Deprecated.
As of 0.13.0, no replacement.
PropertiesFile - Class in com.radiusnetworks.proximity.licensing
Deprecated.
As of 0.13.0, no replacement.
PropertiesFile() - Constructor for class com.radiusnetworks.proximity.licensing.PropertiesFile
Deprecated.
 
ProximityKitBeacon - Class in com.radiusnetworks.proximity
 
ProximityKitBeacon(Beacon, KitBeacon) - Constructor for class com.radiusnetworks.proximity.ProximityKitBeacon
Create a new Proximity Kit beacon

Not for public use.

ProximityKitBeaconRegion - Class in com.radiusnetworks.proximity
Represents a beacon region as defined on the Proximity Kit cloud.
ProximityKitBeaconRegion(Region, KitBeacon) - Constructor for class com.radiusnetworks.proximity.ProximityKitBeaconRegion
Create a new Proximity Kit beacon region.
ProximityKitGeofenceNotifier - Interface in com.radiusnetworks.proximity
Defines events for major updates about geofence regions.
ProximityKitGeofenceRegion - Class in com.radiusnetworks.proximity
Represents a geofence region as defined on the Proximity Kit cloud.
ProximityKitManager - Class in com.radiusnetworks.proximity
This is the main class for interacting with the Proximity Kit SDK.
ProximityKitManager(Context) - Constructor for class com.radiusnetworks.proximity.ProximityKitManager
Deprecated.
Not for public use. As of 0.10.0, replaced by ProximityKitManager.getInstance(Context, KitConfig)
ProximityKitMonitorNotifier - Interface in com.radiusnetworks.proximity
Defines events for major updates about beacon region visibility.
ProximityKitRangeNotifier - Interface in com.radiusnetworks.proximity
Defines timely beacon observation events for configured regions.
ProximityKitStateException - Exception in com.radiusnetworks.proximity
 
ProximityKitStateException(String) - Constructor for exception com.radiusnetworks.proximity.ProximityKitStateException
 
ProximityKitSyncException - Exception in com.radiusnetworks.proximity
 
ProximityKitSyncException(String) - Constructor for exception com.radiusnetworks.proximity.ProximityKitSyncException
 
ProximityKitSyncException(Exception) - Constructor for exception com.radiusnetworks.proximity.ProximityKitSyncException
 
ProximityKitSyncNotifier - Interface in com.radiusnetworks.proximity
Defines important Proximity Kit cloud communication event notifications.
ProximityRegion - Interface in com.radiusnetworks.proximity
General contract for proximity region objects.

R

reconfigure(Context) - Method in class com.radiusnetworks.proximity.licensing.LicenseManager
Deprecated.
reconfigure(String, String) - Method in class com.radiusnetworks.proximity.licensing.LicenseManager
Deprecated.
reconfigure(Configuration) - Method in class com.radiusnetworks.proximity.licensing.LicenseManager
Deprecated.
As of 0.13.0, no replacement.
regionEquals(ProximityKitGeofenceRegion) - Method in class com.radiusnetworks.proximity.ProximityKitGeofenceRegion
Returns whether the supplied ProximityKitGeofenceRegion is equivalent to this one
RegionEvent - Class in com.radiusnetworks.proximity
Represents a major ProximityRegion event.
RegionEvent.MonitorActions - Interface in com.radiusnetworks.proximity
Set of all region monitoring broadcast actions.
RegionEvent.RegionState - Interface in com.radiusnetworks.proximity
State of a ProximityRegion.
REQUIRED_KEYS - Static variable in class com.radiusnetworks.proximity.KitConfig
Immutable list of configuration keys required to be set.
resetLicenseCheck() - Method in class com.radiusnetworks.proximity.licensing.LicenseManager
Deprecated.
Not for public use. As of 0.12.0 no replacement. This method no longer does anything.
restart() - Method in class com.radiusnetworks.proximity.ProximityKitManager
Deprecated.
As of 0.10.0, no replacement. To simply restart the manager use ProximityKitManager.stop() and ProximityKitManager.start(). To use a new configuration create a new manager using ProximityKitManager.getInstance(Context, KitConfig).

S

setAdvertiseMode(int) - Method in class com.radiusnetworks.transmission.Advertisement.Builder
Set advertise mode to control the advertising power and latency.
setDataNotifier(BeaconDataNotifier) - Method in class com.radiusnetworks.proximity.beacon.BeaconManager
Deprecated.
Not for public use. As of 0.13.0, no replacement.
setIdentifiers(List) - Method in class com.radiusnetworks.transmission.Advertisement.Builder
Set ID strings for advertisement.
setKit(Kit) - Method in class com.radiusnetworks.proximity.ProximityKitManager
Deprecated.
As of 0.13.0, no replacement.
setLayout(Advertisement.BeaconLayout) - Method in class com.radiusnetworks.transmission.Advertisement.Builder
Set beacon layout.
setMaxRegionsBeforeRollup(int) - Method in class com.radiusnetworks.proximity.ProximityKitManager
Deprecated.
As of release 0.5.0. This setting no longer does anything, as regions for monitoring and ranging may now be explicitly configured on the ProximityKit server. If you are using this roll up feature, please switch to configuring your ranging and monitoring regions explicitly on the server. Sets the maximum number of regions that may be individually configured in ProximityKit before the regions will start being automatically combined. By default, each beacon or region in the ProximityKit server results in one monitoring and ranging region. In cases of large numbers of individual beacons configured on the server, these beacons will be combined into a smaller number of matching regions for monitoring and ranging purposes.

By default, this value is -1, which means that no rollup will occur.

This method has been deprecated and the setting no longer has any effect.

setPartnerId(String) - Method in class com.radiusnetworks.proximity.licensing.Configuration
Deprecated.
As of 0.13.0, no replacement.
setPartnerId(String) - Method in class com.radiusnetworks.proximity.licensing.LicenseManager
Deprecated.
As of 0.13.0, no replacement.
setPartnerIdentifier(String) - Method in class com.radiusnetworks.proximity.ProximityKitManager
Deprecated.
setProximityKitGeofenceNotifier(ProximityKitGeofenceNotifier) - Method in class com.radiusnetworks.proximity.ProximityKitManager
Register the geofence notification callback handler.
setProximityKitMonitorNotifier(ProximityKitMonitorNotifier) - Method in class com.radiusnetworks.proximity.ProximityKitManager
 
setProximityKitRangeNotifier(ProximityKitRangeNotifier) - Method in class com.radiusnetworks.proximity.ProximityKitManager
 
setProximityKitSyncNotifier(ProximityKitSyncNotifier) - Method in class com.radiusnetworks.proximity.ProximityKitManager
 
setSyncInterval(long) - Method in class com.radiusnetworks.proximity.ProximityKitManager
Sets the length of time, in milliseconds, between syncs with the Proximity Kit server.
setTxPower(int) - Method in class com.radiusnetworks.transmission.Advertisement.Builder
Set the calibrated measured Tx power of the Beacon in RSSI This value is baked into an Beacon when it is manufactured, and it is transmitted with each packet to aid in the mDistance estimate
setTxPowerLevel(int) - Method in class com.radiusnetworks.transmission.Advertisement.Builder
Set advertise TX power level to control the transmission power level for the advertising.
start() - Method in class com.radiusnetworks.proximity.ProximityKitManager
Start syncing with the cloud and monitoring for various regions.
startAdvertising(Context) - Method in class com.radiusnetworks.transmission.Advertisement
Begins broadcasting beacon advertisement.
stop() - Method in class com.radiusnetworks.proximity.ProximityKitManager
Stop all Proximity Kit activities.
stopAdvertising() - Method in class com.radiusnetworks.transmission.Advertisement
Stops advertising as a beacon
sync() - Method in class com.radiusnetworks.proximity.ProximityKitManager
Force a kit sync with the Proximity Kit cloud.
syncIfNeeded() - Method in class com.radiusnetworks.proximity.ProximityKitManager
Deprecated.
Not for public use - no replacement. As of 0.13.0 this method could possibly be retained only as a private method.

T

to_region() - Method in class com.radiusnetworks.proximity.model.KitBeacon
Deprecated.
As of release 0.5.0. This method should not be used as it is part of the internal implementation and will be dropped in a future release. If you need to convert a KitBeacon to a Region, you may construct a new region using the identifiers from the KitBeacon.
toGeofence() - Method in class com.radiusnetworks.proximity.model.KitOverlay
 
toString() - Method in class com.radiusnetworks.proximity.model.KitBeacon
 
toString() - Method in class com.radiusnetworks.proximity.ProximityKitGeofenceRegion
Returns the string representation of this geofence region.
toString() - Method in class com.radiusnetworks.proximity.RegionEvent
Returns a string representation of a RegionEvent.

U

UNKNOWN - Static variable in class com.radiusnetworks.proximity.RegionEvent
Indicates an event not generated from a region action.

V

validateLicense() - Method in class com.radiusnetworks.proximity.licensing.LicenseManager
Deprecated.
Not for public use. As of 0.12.0 no replacement. This method no longer does anything.
valueOf(String) - Static method in class com.radiusnetworks.transmission.Advertisement.BeaconLayout
 
values() - Static method in class com.radiusnetworks.transmission.Advertisement.BeaconLayout
 
A B C D E F G I K L M O P R S T U V 
Skip navigation links
Proximity Kit Android 0.14.0