com.radiusnetworks.proximity

Class ProximityKitBeaconRegion

java.lang.Object

org.altbeacon.beacon.Region

com.radiusnetworks.proximity.ProximityKitBeaconRegion

All Implemented Interfaces:

Parcelable

public class ProximityKitBeaconRegion
extends Region

Since:

0.1.0

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()
List	getIdentifiers() Returns the list of identifiers represented by this region.
String	getName()

Methods inherited from class org.altbeacon.beacon.Region

clone, describeContents, equals, getBluetoothAddress, getId1, getId2, getId3, getIdentifier, getUniqueId, hashCode, 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()

getAttributes

public Map getAttributes()