com.radiusnetworks.proximity

Class ProximityKitBeaconRegion

java.lang.Object

org.altbeacon.beacon.Region

com.radiusnetworks.proximity.ProximityKitBeaconRegion

All Implemented Interfaces:

Parcelable, ProximityRegion, Serializable

public class ProximityKitBeaconRegion
extends Region
implements ProximityRegion

Represents a beacon region as defined on the Proximity Kit cloud.

This provides access to a beacon's identifiers as well as any custom attributes configured via Proximity Kit.

This class is not Parcelable nor is it Serializable. While this class implements both interfaces this is from a legacy inheritance decision with a class not directly under the SDK's control. Attempting to treat this class was either Parcelable or Serializable will cause a runtime exception.

Since:

0.1.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator, Parcelable.Creator

Field Summary

Fields inherited from class org.altbeacon.beacon.Region

CREATOR, mBluetoothAddress, mIdentifiers, mUniqueId

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
ProximityKitBeaconRegion(Region region, KitBeacon beacon) Create a new Proximity Kit beacon region.

Method Summary

Modifier and Type	Method and Description
static ProximityKitBeaconRegion	bestMatch(List kitBeacons, Region region) Creates a region matching the provided beacons.
Map	getAttributes() Metadata attributes associated with this region.
String	getIdentifier() Entity identifier for this region.
List	getIdentifiers() Returns the list of identifiers represented by this region.
String	getName() Display name for this region.

Methods inherited from class org.altbeacon.beacon.Region

clone, describeContents, equals, getBluetoothAddress, getId1, getId2, getId3, getIdentifier, getUniqueId, hashCode, hasSameIdentifiers, matchesBeacon, toString, writeToParcel

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProximityKitBeaconRegion

public ProximityKitBeaconRegion(Region region,
                                KitBeacon beacon)

Create a new Proximity Kit beacon region.

Parameters:

region - Underlying raw region scanning criteria composing this region.

beacon - The associated kit defined beacon region downloaded from the Proximity Kit cloud.

Throws:

NullPointerException - When either region or beacon are null.

Method Detail

bestMatch

public static ProximityKitBeaconRegion bestMatch(List kitBeacons,
                                                 Region region)

Creates a region matching the provided beacons.

Finds the KitBeacon that is the most specific match for the passed region, and uses it to make a ProximityKitBeaconRegion. If no match is found, a ProximityKitBeaconRegion is made that is not mapped to an underlying KitBeacon from the kit.

Parameters:

kitBeacons - beacons in the kit

region - region to match

Returns:

ProximityKitBeaconRegion matching the provided kits

Throws:

NullPointerException - When either kitBeacons or region are null.

Since:

0.3.0

getIdentifiers

public List getIdentifiers()

Returns the list of identifiers represented by this region.

Identifiers of a region may be null. A null for an identifier is a wild card. This affects how matching of beacons works - a wild card will match any beacon which has any identifier in that position.

Returns:

list of Identifiers represented by this region.

getName

public String getName()

Display name for this region.

Specified by:

getName in interface ProximityRegion

Returns:

the name of this region or null if no name is set

getAttributes

public Map getAttributes()

Metadata attributes associated with this region.

An attribute is a mapping of a String key to a String value.

Warning: This breaks the immutable contract specified in ProximityRegion. This is to preserve backwards compatibility with legacy behavior. This will likely change in the next major 1.0 release. It is advisable to not mutate the returned map.

Specified by:

getAttributes in interface ProximityRegion

Returns:

the map of metadata key-value pairs for this region; if this region has no attributes an empty map is returned

getIdentifier

public String getIdentifier()

Entity identifier for this region.

This may or may not be a globally unique identifier. This interface does not specify any contract on uniqueness of this value.

Specified by:

getIdentifier in interface ProximityRegion

Returns:

the entity identifier of this region or null if one is not set

Since:

0.13.0