urbanairship-core/com.urbanairship.analytics.location/RegionEvent

RegionEvent

open class RegionEvent : Event, JsonSerializable

A RegionEvent defines a region with an identifier, major and minor and optional proximityRegion and/or circularRegion.

Types

@Retention(value = RetentionPolicy.SOURCE)

annotation class Boundary

open class Builder

Builder class for RegionEvent Objects.

Properties

BOUNDARY_EVENT_ENTER

val BOUNDARY_EVENT_ENTER: Int = 1

Enter boundary event.

BOUNDARY_EVENT_EXIT

val BOUNDARY_EVENT_EXIT: Int = 2

Exit boundary event.

val boundaryEvent: Int

The type of boundary crossing event.

MAX_CHARACTER_LENGTH

val MAX_CHARACTER_LENGTH: Int = 255

The maximum length for any region event string.

val MAX_LATITUDE: Double = 90.0

The maximum latitude for a region in degrees.

val MAX_LONGITUDE: Double = 180.0

The maximum longitude for a region in degrees.

val MIN_LATITUDE: Double = -90.0

The minimum latitude for a region in degrees.

val MIN_LONGITUDE: Double = -180.0

The minimum longitude for a region in degrees.

val REGION_ID: String = "region_id"

The region ID key.

val regionId: String

The ID of the region.

Inherited properties

val eventId: String

val HIGH_PRIORITY: Int = 2

High priority event.

val LOW_PRIORITY: Int = 0

Low priority event.

NORMAL_PRIORITY

val NORMAL_PRIORITY: Int = 1

Normal priority event.

Functions

open fun getPriority(): Int

The event's send priority.

open fun isValid(): Boolean

Validates the Event.

open fun newBuilder(): RegionEvent.Builder

Builder factory method.

open fun toJsonValue(): JsonValue

Returns the objects represented as a JsonValue.

Inherited functions

getConnectionSubType

open fun getConnectionSubType(): String

Returns the connection subtype.

getConnectionType

open fun getConnectionType(): String

Returns the connection type.

open fun getTime(): String

Returns the timestamp associated with the event.