com.localytics.android

Class Region

java.lang.Object

com.localytics.android.Region

All Implemented Interfaces:

android.os.Parcelable

Direct Known Subclasses:

CircularRegion

public abstract class Region
extends java.lang.Object
implements android.os.Parcelable

The base class for CircularRegion

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Region.Event Events that can occur for a Region (enter and exit)

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	attributes
protected boolean	enterAnalyticsEnabled
protected boolean	exitAnalyticsEnabled
protected double	latitude
protected static java.lang.String	LOCATION_PROVIDER
protected double	longitude
protected java.lang.String	name
protected long	placeId
protected int	schemaVersion
protected java.lang.String	type
protected java.lang.String	uniqueId

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
Region()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.util.Map<java.lang.String,java.lang.String>	getAttributes() Get the attributes associated with this region.
double	getLatitude() Get the latitude.
double	getLongitude() Get the longitude.
java.lang.String	getName() Get the region name.
android.location.Location	getOriginLocation() Get the origin of this region as an android Location object.
protected long	getPlaceId() Get the region place ID
protected int	getSchemaVersion()
java.lang.String	getType() Get the region type.
java.lang.String	getUniqueId() Get the region unique ID
int	hashCode()
protected boolean	isEnterAnalyticsEnabled()
protected boolean	isExitAnalyticsEnabled()
protected java.util.Map<java.lang.String,java.lang.String>	readStringMap(android.os.Parcel in)
protected void	setEnterAnalyticsEnabled(boolean enterAnalyticsEnabled)
protected void	setExitAnalyticsEnabled(boolean exitAnalyticsEnabled)
protected void	setLatitude(double latitude)
protected void	setLongitude(double longitude)
protected void	setName(java.lang.String name)
protected void	setSchemaVersion(int schemaVersion)
protected void	writeStringMap(android.os.Parcel dest, java.util.Map<java.lang.String,java.lang.String> map)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Field Detail

LOCATION_PROVIDER

protected static final java.lang.String LOCATION_PROVIDER

See Also:

Constant Field Values

placeId

protected long placeId

uniqueId

protected java.lang.String uniqueId

latitude

protected double latitude

longitude

protected double longitude

name

protected java.lang.String name

type

protected java.lang.String type

enterAnalyticsEnabled

protected boolean enterAnalyticsEnabled

exitAnalyticsEnabled

protected boolean exitAnalyticsEnabled

schemaVersion

protected int schemaVersion

attributes

protected java.util.Map<java.lang.String,java.lang.String> attributes

Constructor Detail

Region

public Region()

Method Detail

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getPlaceId

protected long getPlaceId()

Get the region place ID

Returns:

the region place ID

getUniqueId

public java.lang.String getUniqueId()

Get the region unique ID

Returns:

the region unique ID.

getLatitude

public double getLatitude()

Get the latitude.

Returns:

the region latitude.

setLatitude

protected void setLatitude(double latitude)

getLongitude

public double getLongitude()

Get the longitude.

Returns:

the region longitude.

setLongitude

protected void setLongitude(double longitude)

getName

public java.lang.String getName()

Get the region name.

Returns:

the region name.

setName

protected void setName(java.lang.String name)

getType

public java.lang.String getType()

Get the region type.

Returns:

the region type.

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

Get the attributes associated with this region.

Returns:

the attributes associated with the region.

getOriginLocation

@NonNull
public android.location.Location getOriginLocation()

Get the origin of this region as an android Location object.

Returns:

the Location associated with the origin of this region.

isEnterAnalyticsEnabled

protected boolean isEnterAnalyticsEnabled()

isExitAnalyticsEnabled

protected boolean isExitAnalyticsEnabled()

setEnterAnalyticsEnabled

protected void setEnterAnalyticsEnabled(boolean enterAnalyticsEnabled)

setExitAnalyticsEnabled

protected void setExitAnalyticsEnabled(boolean exitAnalyticsEnabled)

getSchemaVersion

protected int getSchemaVersion()

setSchemaVersion

protected void setSchemaVersion(int schemaVersion)

readStringMap

@NonNull
protected java.util.Map<java.lang.String,java.lang.String> readStringMap(@NonNull
                                                                                  android.os.Parcel in)

writeStringMap

protected void writeStringMap(@NonNull
                              android.os.Parcel dest,
                              @NonNull
                              java.util.Map<java.lang.String,java.lang.String> map)