public class

ProximityRegion

extends Object
java.lang.Object
   ↳ com.urbanairship.location.ProximityRegion

Class Overview

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

Summary

Public Constructors
ProximityRegion(String proximityId, int major, int minor)
Constructor for creating proximity region.
Public Methods
Double getLatitude()
Gets the proximity region's latitude in degrees.
Double getLongitude()
Gets the proximity region's longitude in degrees.
int getMajor()
Gets the proximity region's major.
int getMinor()
Gets the proximity region's minor.
String getProximityId()
Gets the proximity region's proximity ID.
Integer getRssi()
Gets the proximity region's RSSI in dBm.
boolean isValid()
Validates the proximity region object.
void setCoordinates(Double latitude, Double longitude)
Sets the proximity region's latitude and longitude.
void setRssi(Integer rssi)
Sets the proximity region's received signal strength indication.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ProximityRegion (String proximityId, int major, int minor)

Constructor for creating proximity region.

Parameters
proximityId The ID of the region object.
major The major.
minor The minor.

Public Methods

public Double getLatitude ()

Gets the proximity region's latitude in degrees.

Returns
  • The latitude.

public Double getLongitude ()

Gets the proximity region's longitude in degrees.

Returns
  • The longitude.

public int getMajor ()

Gets the proximity region's major.

Returns
  • The major.

public int getMinor ()

Gets the proximity region's minor.

Returns
  • The minor.

public String getProximityId ()

Gets the proximity region's proximity ID.

Returns
  • The proximity ID.

public Integer getRssi ()

Gets the proximity region's RSSI in dBm.

Returns
  • The RSSI.

public boolean isValid ()

Validates the proximity region object.

Returns
  • True if the proximity region is valid, false otherwise.

public void setCoordinates (Double latitude, Double longitude)

Sets the proximity region's latitude and longitude.

Parameters
latitude The proximity region's latitude.
longitude The proximity region's longitude.

public void setRssi (Integer rssi)

Sets the proximity region's received signal strength indication.

Parameters
rssi The proximity region's received signal strength indication.