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

RegionEvent

class RegionEvent : Event, JsonSerializable(source)

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

Types

enum Boundary : Enum<RegionEvent.Boundary>

class Builder(@Size(min = 1, max = 255) val regionId: String, var boundaryEvent: RegionEvent.Boundary)

Builder class for RegionEvent Objects.

object Companion

Properties

val boundaryEvent: RegionEvent.Boundary

The type of boundary crossing event. Will be either Boundary.ENTER or Boundary.EXIT.

open override val priority: Event.Priority

open override val type: EventType

Inherited properties

val eventId: String

Returns the UUID associated with the event.

val time: String

Returns the timestamp associated with the event.

Functions

open override fun isValid(): Boolean

Validates the Event.

open override fun toJsonValue(): JsonValue

Returns the objects represented as a JsonValue.