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

Builder

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

Builder class for RegionEvent Objects.

Parameters

regionId

The ID of the region.

boundaryEvent

The type of boundary crossing event.

Constructors

constructor(@Size(min = 1, max = 255) regionId: String, boundaryEvent: RegionEvent.Boundary)

Properties

var boundaryEvent: RegionEvent.Boundary

var circularRegion: CircularRegion?

A circular region with a radius, latitude and longitude.

proximityRegion

var proximityRegion: ProximityRegion?

A proximity region with an identifier, major and minor.

val regionId: String

var source: String?

Source of the region definition.

Functions

fun build(): RegionEvent

Builds the region event.

setBoundaryEvent

fun setBoundaryEvent(boundaryEvent: RegionEvent.Boundary): RegionEvent.Builder

Region boundary event setter.

setCircularRegion

fun setCircularRegion(circularRegion: CircularRegion?): RegionEvent.Builder

Circular region setter.

setProximityRegion

fun setProximityRegion(proximityRegion: ProximityRegion?): RegionEvent.Builder

Proximity region setter.

fun setSource(@Size(min = 1, max = 255) source: String): RegionEvent.Builder

Region event source setter.