com.radiusnetworks.proximity

Class RegionEvent

java.lang.Object

com.radiusnetworks.proximity.RegionEvent

public class RegionEvent
extends Object

Represents a major ProximityRegion event.

Represents a proximity related event for a monitored region (either a beacon or geofence). The events can be:

• A transition event generated when entering or exiting a region
• A major state update event generated when:
  • Initially monitoring a region providing the current known state
  • Transitioning over a region boundary (entering or exiting)
  • A monitoring request update - such as after a kit sync

Since:

0.13.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RegionEvent.MonitorActions Set of all region monitoring broadcast actions.
static interface	RegionEvent.RegionState State of a ProximityRegion.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_REGION_ENTER Broadcast Action: Sent when the device has entered a monitored region.
static String	ACTION_REGION_EXIT Broadcast Action: Sent when the device has exited a monitored region.
static String	ACTION_REGION_STATE_DETERMINED Broadcast Action: Sent on state updates for a monitored region.
static int	INSIDE Indicates the Android device is inside the defined region.
static int	OUTSIDE Indicates the Android device is outside the defined region.
static int	UNKNOWN Indicates an event not generated from a region action.

Method Summary

Modifier and Type	Method and Description
static RegionEvent	fromIntent(Intent intent) Creates a new RegionEvent instance from the provided intent.
int	getRegionState() Returns the state of triggering region when the event was broadcast.
ProximityRegion	getTriggeringRegion() The ProximityRegion which triggered the event to be broadcast.
String	toString() Returns a string representation of a RegionEvent.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

INSIDE

public static final int INSIDE

Indicates the Android device is inside the defined region.

See Also:

RegionEvent.RegionState, Constant Field Values

OUTSIDE

public static final int OUTSIDE

Indicates the Android device is outside the defined region.

See Also:

RegionEvent.RegionState, Constant Field Values

UNKNOWN

public static final int UNKNOWN

Indicates an event not generated from a region action.

See Also:

RegionEvent.RegionState, Constant Field Values

ACTION_REGION_ENTER

public static final String ACTION_REGION_ENTER

Broadcast Action: Sent when the device has entered a monitored region.

This event represents a region state transition from OUTSIDE to INSIDE.

See Also:

RegionEvent.MonitorActions, RegionEvent.fromIntent(Intent), Constant Field Values

ACTION_REGION_EXIT

public static final String ACTION_REGION_EXIT

Broadcast Action: Sent when the device has exited a monitored region.

This event represents a region state transition from INSIDE to OUTSIDE.

See Also:

RegionEvent.MonitorActions, RegionEvent.fromIntent(Intent), Constant Field Values

ACTION_REGION_STATE_DETERMINED

public static final String ACTION_REGION_STATE_DETERMINED

Broadcast Action: Sent on state updates for a monitored region.

This action is guaranteed to be sent alongside of ACTION_REGION_ENTER and ACTION_REGION_EXIT on region state transitions. It may also be sent after other major events, such as initial monitoring or kit sync, which do not represent a region transition. The state of RegionEvent instances generated from this event will contain the most recent region state at the time the action was broadcast.

See Also:

RegionEvent.MonitorActions, RegionEvent.fromIntent(Intent), Constant Field Values

Method Detail

fromIntent

public static RegionEvent fromIntent(Intent intent)

Creates a new RegionEvent instance from the provided intent.

Parameters:

intent - the intent containing the region event data

Returns:

a new RegionEvent instance

Throws:

NullPointerException - when intent is null

getRegionState

public int getRegionState()

Returns the state of triggering region when the event was broadcast.

Returns:

UNKNOWN if the intent passed to fromIntent(Intent) was not generated for a region event; otherwise either INSIDE or OUTSIDE

See Also:

RegionEvent.RegionState

getTriggeringRegion

public ProximityRegion getTriggeringRegion()

The ProximityRegion which triggered the event to be broadcast.

Returns:

an immutable instance of the ProximityRegion broadcast in the intent; in the case where the intent passed to fromIntent(Intent) was not generated for a region event all fields in the returned event will either be null or empty collections

toString

public String toString()

Returns a string representation of a RegionEvent.

Overrides:

toString in class Object

Returns:

a string representation of this RegionEvent