com.factual.engine.api.mobile_state

Class FactualPlaceVisit

java.lang.Object

com.factual.engine.api.mobile_state.FactualPlaceVisit

public class FactualPlaceVisit
extends java.lang.Object

Reports place information about a user, including when they arrived at the place and whether the user is at home and/or work.

Field Summary

Fields

Modifier and Type	Field and Description
static <any>	CREATOR

Constructor Summary

Constructors

Constructor and Description
FactualPlaceVisit(Location ingressLocation, java.util.List<FactualPlace> attachedPlaces, Geographies geographies, boolean isHome, boolean isWork) Constructs a FactualPlaceVisit object.

Method Summary

Modifier and Type	Method and Description
int	describeContents()
java.util.List<FactualPlace>	getAttachedPlaces() Returns a list of places the user is at.
Geographies	getGeographies() Returns the geographies the user is at.
Location	getIngressLocation() Returns the location when the user started visiting the place.
boolean	isHome() Returns true if the user is at home.
boolean	isWork() Returns true if the user is at work.
JSONObject	toJson() Returns a json representation of the FactualPlaceVisit.
void	writeToParcel(Parcel out, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static <any> CREATOR

Constructor Detail

FactualPlaceVisit

public FactualPlaceVisit(Location ingressLocation,
                         java.util.List<FactualPlace> attachedPlaces,
                         Geographies geographies,
                         boolean isHome,
                         boolean isWork)

Constructs a FactualPlaceVisit object.

Parameters:

ingressLocation - The location when the user started visiting the place.

attachedPlaces - A list of places the user is at.

geographies - The geographies the user is at.

isHome - True if the user is at home.

isWork - True if the user is at work.

Method Detail

getIngressLocation

public Location getIngressLocation()

Returns the location when the user started visiting the place.

Returns:

The location when the user started visiting the place.

getAttachedPlaces

public java.util.List<FactualPlace> getAttachedPlaces()

Returns a list of places the user is at.

Returns:

A list of places the user is at.

getGeographies

public Geographies getGeographies()

Returns the geographies the user is at.

Returns:

The geographies the user is at.

isHome

public boolean isHome()

Returns true if the user is at home.

Returns:

True if the user is at home.

isWork

public boolean isWork()

Returns true if the user is at work.

Returns:

True if the user is at work.

toJson

public JSONObject toJson()
                  throws JSONException

Returns a json representation of the FactualPlaceVisit.

Returns:

A json representation of the FactualPlaceVisit.

Throws:

JSONException - If an error occurs creating the json.

describeContents

public int describeContents()

writeToParcel

public void writeToParcel(Parcel out,
                          int flags)