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

ProximityRegion

open class ProximityRegion

A ProximityRegion defines a proximity region with an identifier, major, minor and optional latitude, longitude and RSSI.

Constructors

Link copied to clipboard
constructor(@NonNull proximityId: String, @IntRange(from = 0, to = 65535) major: Int, @IntRange(from = 0, to = 65535) minor: Int)
Constructor for creating proximity region.

Properties

Link copied to clipboard
@get:Nullable
open val latitude: Double
The proximity region's latitude in degrees.
Link copied to clipboard
@get:Nullable
open val longitude: Double
The proximity region's longitude in degrees.
Link copied to clipboard
val major: Int
The proximity region's major.
Link copied to clipboard
val minor: Int
The proximity region's minor.
Link copied to clipboard
@get:NonNull
val proximityId: String
The proximity region's identifier.
Link copied to clipboard
@get:Nullable
open var rssi: Integer
The proximity region's received signal strength indication in dBm.

Functions

Link copied to clipboard
open fun isValid(): Boolean
Validates the proximity region object.
Link copied to clipboard
open fun setCoordinates(@Nullable @FloatRange(from = RegionEvent.MIN_LATITUDE, to = RegionEvent.MAX_LATITUDE) latitude: Double, @Nullable @FloatRange(from = RegionEvent.MIN_LONGITUDE, to = RegionEvent.MAX_LONGITUDE) longitude: Double)
Sets the proximity region's latitude and longitude.