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

Link copied to clipboard
@Retention(value = RetentionPolicy.SOURCE)
annotation class Boundary
Link copied to clipboard
open class Builder
Builder class for RegionEvent Objects.

Properties

Link copied to clipboard
val BOUNDARY_EVENT_ENTER: Int = 1
Enter boundary event.
Link copied to clipboard
val BOUNDARY_EVENT_EXIT: Int = 2
Exit boundary event.
Link copied to clipboard
val boundaryEvent: Int
The type of boundary crossing event.
Link copied to clipboard
val MAX_CHARACTER_LENGTH: Int = 255
The maximum length for any region event string.
Link copied to clipboard
val MAX_LATITUDE: Double = 90.0
The maximum latitude for a region in degrees.
Link copied to clipboard
val MAX_LONGITUDE: Double = 180.0
The maximum longitude for a region in degrees.
Link copied to clipboard
val MIN_LATITUDE: Double = -90.0
The minimum latitude for a region in degrees.
Link copied to clipboard
val MIN_LONGITUDE: Double = -180.0
The minimum longitude for a region in degrees.
Link copied to clipboard
@NonNull
val REGION_ID: String = "region_id"
The region ID key.
Link copied to clipboard
val regionId: String
The ID of the region.

Inherited properties

Link copied to clipboard
Link copied to clipboard
val HIGH_PRIORITY: Int = 2
High priority event.
Link copied to clipboard
val LOW_PRIORITY: Int = 0
Low priority event.
Link copied to clipboard
val NORMAL_PRIORITY: Int = 1
Normal priority event.
Link copied to clipboard
protected val timeMilliseconds: Long

Functions

Link copied to clipboard
open fun getPriority(): Int
The event's send priority.
Link copied to clipboard
open fun isValid(): Boolean
Validates the Event.
Link copied to clipboard
@NonNull
open fun newBuilder(): RegionEvent.Builder
Builder factory method.
Link copied to clipboard
@NonNull
open fun toJsonValue(): JsonValue
Returns the objects represented as a JsonValue.

Inherited functions

Link copied to clipboard
@Nullable
protected open fun getCarrier(): String
Returns the current carrier.
Link copied to clipboard
@NonNull
open fun getConnectionSubType(): String
Returns the connection subtype.
Link copied to clipboard
@NonNull
open fun getConnectionType(): String
Returns the connection type.
Link copied to clipboard
@NonNull
open fun getTime(): String
Returns the timestamp associated with the event.
Link copied to clipboard
protected open fun getTimezone(): Long
Returns the current time zone.
Link copied to clipboard
protected open fun isDaylightSavingsTime(): Boolean
Indicates whether it is currently daylight savings time.