com.swirl

Class Visit

java.lang.Object

com.swirl.Visit

public class Visit
extends java.lang.Object

A Visit object encapsulates information about places that the user has been. Visit objects are created by the library and delivered by the VisitManager to its listeners after it receives relevant signal events from other managers running within the system.

The visit includes the location where the visit occurred and information about the arrival and departure times as relevant. You do not create visit objects directly, nor should you subclass a Visit. You receive these objects by receiving event callbacks from the VisitManager.

Visit objects contain as much information about the visit as possible but may not always include both the arrival and departure times. For example, when the user arrives at a location, the system may send an event with only an arrival time. When the user departs a location, the event can contain both the arrival time (if your app was monitoring visits prior to the user’s arrival) and the departure time.

Constructor Summary

Constructors

Constructor and Description
Visit(Location locaton, Visit relatedVisit)

Method Summary

Modifier and Type	Method and Description
protected int	enter()
protected int	exit()
long	getArrivalTime() Returns the number of milliseconds since epoch start representing the time the Location was entered.
long	getDepartureTime() Returns the number of milliseconds since epoch start representing the time the Location was exited.
long	getDwellTime() Returns the number of milliseconds the mobile device was within the Location.
long	getElapsedTime() Returns the number of milliseconds the mobile device was within the Location as wall or elapsed time.
long	getFirstEnterTime()
long	getIntervalSinceDeparture() Returns the number of milliseconds since the Location associated with this Visit was exited.
Location	getLocation() Get the Location object tied to this Visit.
Visit	getParent() Get the parent Visit.
boolean	isFirstEnter() Determine if this is the first enter to a location
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Visit

public Visit(Location locaton,
             Visit relatedVisit)

Method Detail

enter

protected int enter()

exit

protected int exit()

getParent

public Visit getParent()

Get the parent Visit. If this Visit object is tied to Placement visit, then the parent visit represents a common Visit object for the Location.

Returns:

parent Visit

getLocation

public Location getLocation()

Get the Location object tied to this Visit.

Returns:

getIntervalSinceDeparture

public long getIntervalSinceDeparture()

Returns the number of milliseconds since the Location associated with this Visit was exited.

Returns:

milliseconds since exit

getDepartureTime

public long getDepartureTime()

Returns the number of milliseconds since epoch start representing the time the Location was exited.

Returns:

time of exit

getArrivalTime

public long getArrivalTime()

Returns the number of milliseconds since epoch start representing the time the Location was entered.

Returns:

time of enter

getElapsedTime

public long getElapsedTime()

Returns the number of milliseconds the mobile device was within the Location as wall or elapsed time. Time here measured from first enter to lastexit.

Returns:

elapsed time

getDwellTime

public long getDwellTime()

Returns the number of milliseconds the mobile device was within the Location. This time is accrued across multiple enters and exits.

Returns:

number of milliseconds inside the Location

isFirstEnter

public boolean isFirstEnter()

Determine if this is the first enter to a location

Returns:

Returns TRUE if the visit is begun and this is the first 'enter' recorded

getFirstEnterTime

public long getFirstEnterTime()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object