java.lang.Object | ||
↳ | com.urbanairship.analytics.Event | |
↳ | com.urbanairship.location.RegionEvent |
A RegionEvent defines a region with an identifier, major and minor and optional proximityRegion and/or circularRegion.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
@interface | RegionEvent.Boundary |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | BOUNDARY_EVENT_ENTER | Enter boundary event. | |||||||||
int | BOUNDARY_EVENT_EXIT | Exit boundary event. | |||||||||
int | MAX_CHARACTER_LENGTH | The maximum length for any region event string. | |||||||||
double | MAX_LATITUDE | The maximum latitude for a region in degrees. | |||||||||
double | MAX_LONGITUDE | The maximum longitude for a region in degrees. | |||||||||
double | MIN_LATITUDE | The minimum latitude for a region in degrees. | |||||||||
double | MIN_LONGITUDE | The minimum longitude for a region in degrees. | |||||||||
String | TYPE | The event type. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
RegionEvent(String regionId, String source, int boundaryEvent)
Constructor for creating a region event.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
final String |
getType()
The event type.
| ||||||||||
boolean |
isValid()
Validates the Event.
| ||||||||||
void |
setCircularRegion(CircularRegion circularRegion)
Circular region setter.
| ||||||||||
void |
setProximityRegion(ProximityRegion proximityRegion)
Proximity region setter.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
final JSONObject |
getEventData()
Create the event data.
| ||||||||||
int |
getPriority()
The event's send priority.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
Enter boundary event.
Exit boundary event.
The maximum length for any region event string.
The maximum latitude for a region in degrees.
The maximum longitude for a region in degrees.
The minimum latitude for a region in degrees.
The minimum longitude for a region in degrees.
Constructor for creating a region event.
regionId | The ID of the region object. |
---|---|
source | The source of the region definition. |
boundaryEvent | The type of boundary crossing event. |
Validates the Event.
Circular region setter.
circularRegion | The optional circular region. |
---|
Proximity region setter.
proximityRegion | The optional proximity region. |
---|
The event's send priority.