VisitManager (Swirl Proximity Library)

java.lang.Object
- com.swirl.Manager
- - com.swirl.VisitManager

```
public class VisitManager
extends Manager
```
The VisitManager consumes the various Enter/Exit/Dwell events from the BeaconManager, the WifiManager, and the RegionManager and tracks enter and exit times, accumulates dwell and elapsed times by location and placement, and generates logical Visit objects and posts Visit events onto the EventBus.

An instance of this class is loaded and started by the library. You do not interact with this class directly.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`VisitManager.BeginVisitEvent` This event is posted when a visit begins.
`class`	`VisitManager.DwellVisitEvent` This event is posted periodically as a visit continues.
`class`	`VisitManager.EndVisitEvent` This event is posted when a visit ends.
`class`	`VisitManager.VisitEvent` VisitEvent is the base class for all VisitManager events.

Constructor Summary

Constructors
Constructor and Description

VisitManager()

Constructors
Constructor and Description
`VisitManager()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.ArrayList<Visit>`	`getActiveLocationVisits()` Get a list of the active (ongoing) Location Visits sorted by quality and distance (nearest and highest quality to farthest and lowest quality).
`java.util.ArrayList<Visit>`	`getActivePlacementVisits()` Get a list of the active (ongoing) Placement Visits sorted by quality and distance (nearest and highest quality to farthest and lowest quality).
`static VisitManager`	`getInstance()` Returns the last VisitManager created.
`java.util.ArrayList<Visit>`	`getVisitsForLocation(Location location)` Get a list of the active visit records for a given location.
`void`	`init(android.content.Context context, EventBus bus, java.util.concurrent.ScheduledExecutorService executor)` Called when the manager is created to provide its execution environment.
`void`	`onDwellBeacon(BeaconManager.BeaconDwellEvent event)`
`void`	`onDwellWifi(WifiManager.WifiDwellEvent event)`
`void`	`onEnterBeacon(BeaconManager.BeaconEnterEvent event)`
`void`	`onEnterExitRegions(RegionManager.RegionsChangedEvent event)`
`void`	`onEnterWifi(WifiManager.WifiEnterEvent event)`
`void`	`onExitBeacon(BeaconManager.BeaconExitEvent event)`
`void`	`onExitWifi(WifiManager.WifiExitEvent event)`
`Visit`	`recentVisit()` Return the most recently active visit.
`void`	`start()` Starts the manager.
`void`	`stop()` Stops the manager.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - VisitManager
```
public VisitManager()
```
- Method Detail
  - getInstance
```
public static VisitManager getInstance()
```
    Returns the last VisitManager created. Usually there is only one. It will return null if there is no VisitManager
    
    Returns:
    
    VisitManager
  - init
```
public void init(android.content.Context context,
                 EventBus bus,
                 java.util.concurrent.ScheduledExecutorService executor)
```
    Description copied from class: Manager
    
    Called when the manager is created to provide its execution environment.
    
    Parameters:
    
    context - The application context to use
    
    bus - The EventBus that the manager is a member of
    
    executor - The Executor to use and on which events are dispatched
  - start
```
public void start()
```
    Description copied from class: Manager
    
    Starts the manager.
  - stop
```
public void stop()
```
    Description copied from class: Manager
    
    Stops the manager.
  - recentVisit
```
public Visit recentVisit()
```
    Return the most recently active visit. This could be a current (un-ended) visit or the most recently exited visit.
    
    Returns:
    
    A visit object or null.
  - getActiveLocationVisits
```
public java.util.ArrayList<Visit> getActiveLocationVisits()
```
    Get a list of the active (ongoing) Location Visits sorted by quality and distance (nearest and highest quality to farthest and lowest quality). This list is for the Location only Visits.
    
    Visits are sorted by type Beacon, Wifi, Region and by distance from device within each type.
    
    Returns:
    
    sorted list of Visits.
  - getActivePlacementVisits
```
public java.util.ArrayList<Visit> getActivePlacementVisits()
```
    Get a list of the active (ongoing) Placement Visits sorted by quality and distance (nearest and highest quality to farthest and lowest quality). This list is for the Location only Visits.
    
    Visits are sorted by type Beacon, Wifi, Region and by distance from device within each type.
    
    Returns:
    
    sorted list of Visits.
  - getVisitsForLocation
```
public java.util.ArrayList<Visit> getVisitsForLocation(Location location)
```
    Get a list of the active visit records for a given location.
    
    Returns:
    
    list of visit records for the given location
  - onEnterExitRegions
```
public void onEnterExitRegions(RegionManager.RegionsChangedEvent event)
```
  - onEnterBeacon
```
public void onEnterBeacon(BeaconManager.BeaconEnterEvent event)
```
  - onDwellBeacon
```
public void onDwellBeacon(BeaconManager.BeaconDwellEvent event)
```
  - onExitBeacon
```
public void onExitBeacon(BeaconManager.BeaconExitEvent event)
```
  - onEnterWifi
```
public void onEnterWifi(WifiManager.WifiEnterEvent event)
```
  - onDwellWifi
```
public void onDwellWifi(WifiManager.WifiDwellEvent event)
```
  - onExitWifi
```
public void onExitWifi(WifiManager.WifiExitEvent event)
```

Class VisitManager

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VisitManager

Method Detail

getInstance

init

start

stop

recentVisit

getActiveLocationVisits

getActivePlacementVisits

getVisitsForLocation

onEnterExitRegions

onEnterBeacon

onDwellBeacon

onExitBeacon

onEnterWifi

onDwellWifi

onExitWifi