com.radiusnetworks.proximity

Interface ProximityRegion

All Known Implementing Classes:

ProximityKitBeaconRegion, ProximityKitGeofenceRegion

public interface ProximityRegion

General contract for proximity region objects.

Since:

0.13.0

Method Summary

Modifier and Type	Method and Description
Map	getAttributes() Metadata attributes associated with this region.
String	getIdentifier() Entity identifier for this region.
String	getName() Display name for this region.

Method Detail

getAttributes

Map getAttributes()

Metadata attributes associated with this region.

An attribute is a mapping of a String key to a String value. Attribute maps should not contain null keys or values.

Returns:

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

getIdentifier

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.

Returns:

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

getName

String getName()

Display name for this region.

Returns:

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