com.swirl

Class SwirlListener

java.lang.Object

com.swirl.SwirlListener

public class SwirlListener
extends java.lang.Object

SwirlListener is a convenience class created to facilitate intercepting events on the eventBus. Instead of implementing methods annotated with @Subscribe and a single Event object parameter, all of the common events are presented as methods that can be overridden.

Constructor Summary

Constructors

Constructor and Description
SwirlListener()

Method Summary

Modifier and Type	Method and Description
void	onBeaconDwell(BeaconManager.BeaconDwellEvent event)
void	onBeaconEnter(BeaconManager.BeaconEnterEvent event)
void	onBeaconExit(BeaconManager.BeaconExitEvent event)
void	onBeaconNearest(BeaconManager.BeaconNearestEvent event)
void	onBeaconResolve(BeaconManager.BeaconResolveEvent event)
void	onBeginVisit(VisitManager.BeginVisitEvent event)
protected void	onBeginVisit(VisitManager manager, Visit visit) Called when a Visit to a new Location and Placement is beginning.
protected void	onChangeNearestBeacon(BeaconManager manager, Beacon beacon) Called when the mobile device changed the beacon it is closest to.
protected void	onDwellBeacon(BeaconManager manager, Beacon beacon) Called when the mobile device is still within range of the beacon.
void	onDwellVisit(VisitManager.DwellVisitEvent event)
protected void	onDwellVisit(VisitManager manager, Visit visit) Called periodically as a user remains in a current Location and Placement.
void	onEndVisit(VisitManager.EndVisitEvent event)
protected void	onEndVisit(VisitManager manager, Visit visit) Called when a Visit to a new Location and Placement has ended.
protected void	onEnterBeacon(BeaconManager manager, Beacon beacon) Called when the mobile device is within range of the beacon.
protected void	onEnterWifi(WifiManager manager, WifiInfo wifi) Called when an access point enter is detected for the connected wifi network.
protected void	onError(int error) Called when Swirl reports an error
void	onError(Swirl.ErrorEvent event)
protected void	onExitBeacon(BeaconManager manager, Beacon beacon) Called when the mobile device left the range of the beacon.
protected void	onExitWifi(WifiManager manager, WifiInfo wifi) Called when an access point exit is detected for the connected wifi network.
void	onLocationChange(Device.LocationChangedEvent event)
protected void	onLocationChange(android.location.Location location) Called when Swirl detects a location change event
void	onNearbyMessage(NearbyManager.NearbyMessage event)
protected void	onNearbyMessage(NearbyManager manager, java.lang.String namespace, java.lang.String type, byte[] content, int rssi) Call whenever the NearbyManager posts a nearby related message.
void	onReceiveContentCustom(ContentManager.ReceiveContentCustomEvent event)
protected void	onReceiveContentCustom(ContentManager manager, Content content, Completion completion) Called when content of type Custom is received.
void	onReceiveContentURL(ContentManager.ReceiveContentURLEvent event)
protected void	onReceiveContentURL(ContentManager manager, Content content) Called when content of type URL is received.
void	onReceiveContentView(ContentManager.ReceiveContentViewEvent event)
protected void	onReceiveContentView(ContentManager manager, Content content) Called when content of type Swirl is received.
void	onRegionsChanged(RegionManager.RegionsChangedEvent event)
protected void	onRegionsChanged(RegionManager manager, java.util.Set<Region> entered, java.util.Set<Region> exited) Called whenever the set of entered and/or exited regions changes.
protected void	onResolveBeacon(BeaconManager manager, Beacon beacon) Called when the detected beacon is resolved by the server.
protected void	onStarted() Called when Swirl is started without error
void	onStarted(Swirl.StartedEvent event)
protected void	onStatusChange(int status) Called when Swirl status changes.
void	onStatusChange(Swirl.StatusChangedEvent event)
void	onWifiEnter(WifiManager.WifiEnterEvent event)
void	onWifiEnter(WifiManager.WifiExitEvent event)

Methods inherited from class java.lang.Object

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

Constructor Detail

SwirlListener

public SwirlListener()

Method Detail

onLocationChange

public void onLocationChange(Device.LocationChangedEvent event)

onNearbyMessage

public void onNearbyMessage(NearbyManager.NearbyMessage event)

onBeaconResolve

public void onBeaconResolve(BeaconManager.BeaconResolveEvent event)

onBeaconEnter

public void onBeaconEnter(BeaconManager.BeaconEnterEvent event)

onBeaconDwell

public void onBeaconDwell(BeaconManager.BeaconDwellEvent event)

onBeaconExit

public void onBeaconExit(BeaconManager.BeaconExitEvent event)

onBeaconNearest

public void onBeaconNearest(BeaconManager.BeaconNearestEvent event)

onWifiEnter

public void onWifiEnter(WifiManager.WifiEnterEvent event)

onWifiEnter

public void onWifiEnter(WifiManager.WifiExitEvent event)

onRegionsChanged

public void onRegionsChanged(RegionManager.RegionsChangedEvent event)

onBeginVisit

public void onBeginVisit(VisitManager.BeginVisitEvent event)

onDwellVisit

public void onDwellVisit(VisitManager.DwellVisitEvent event)

onEndVisit

public void onEndVisit(VisitManager.EndVisitEvent event)

onReceiveContentURL

public void onReceiveContentURL(ContentManager.ReceiveContentURLEvent event)

onReceiveContentView

public void onReceiveContentView(ContentManager.ReceiveContentViewEvent event)

onReceiveContentCustom

public void onReceiveContentCustom(ContentManager.ReceiveContentCustomEvent event)

onStatusChange

public void onStatusChange(Swirl.StatusChangedEvent event)

onError

public void onError(Swirl.ErrorEvent event)

onStarted

public void onStarted(Swirl.StartedEvent event)

onStatusChange

protected void onStatusChange(int status)

Called when Swirl status changes.

Parameters:

status -

onStarted

protected void onStarted()

Called when Swirl is started without error

onError

protected void onError(int error)

Called when Swirl reports an error

Parameters:

error - (the error or 0 to indicate no error)

onLocationChange

protected void onLocationChange(android.location.Location location)

Called when Swirl detects a location change event

Parameters:

location - The os location object representing the latest detected position

onResolveBeacon

protected void onResolveBeacon(BeaconManager manager,
                               Beacon beacon)

Called when the detected beacon is resolved by the server.

Parameters:

manager - The BeaconManager reporting the event

beacon - The beacon that has been entered

onEnterBeacon

protected void onEnterBeacon(BeaconManager manager,
                             Beacon beacon)

Called when the mobile device is within range of the beacon.

Parameters:

manager - The BeaconManager reporting the event

beacon - The beacon that has been entered

onChangeNearestBeacon

protected void onChangeNearestBeacon(BeaconManager manager,
                                     Beacon beacon)

Called when the mobile device changed the beacon it is closest to.

Parameters:

manager - The BeaconManager reporting the event

beacon - The beacon that is now the nearest beacon

onDwellBeacon

protected void onDwellBeacon(BeaconManager manager,
                             Beacon beacon)

Called when the mobile device is still within range of the beacon. Called periodically.

Parameters:

manager - The BeaconManager reporting the event

beacon - The beacon that the mobile device is within range of

onExitBeacon

protected void onExitBeacon(BeaconManager manager,
                            Beacon beacon)

Called when the mobile device left the range of the beacon.

Parameters:

manager - The BeaconManager reporting the event

beacon - The beacon that was exited

onEnterWifi

protected void onEnterWifi(WifiManager manager,
                           WifiInfo wifi)

Called when an access point enter is detected for the connected wifi network.

Parameters:

manager - The WifiManager reporting the event

wifi - The WifiInfo object representing the entered access point

onExitWifi

protected void onExitWifi(WifiManager manager,
                          WifiInfo wifi)

Called when an access point exit is detected for the connected wifi network.

Parameters:

manager - The WifiManager reporting the event

wifi - the WifiInfo object representing the exited access point

onRegionsChanged

protected void onRegionsChanged(RegionManager manager,
                                java.util.Set<Region> entered,
                                java.util.Set<Region> exited)

Called whenever the set of entered and/or exited regions changes.

Parameters:

manager - The RegionManager

entered - A set of Regions representing the regions that have been entered

exited - A set of Regions representing the regions that have been exited

onNearbyMessage

protected void onNearbyMessage(NearbyManager manager,
                               java.lang.String namespace,
                               java.lang.String type,
                               byte[] content,
                               int rssi)

Call whenever the NearbyManager posts a nearby related message.

Parameters:

manager - The NearbyManager

namespace - The project or public attachment namespace

type - The attachement type

content - The byte array which is the message content

rssi - The signal strength if available, or -1 if not available

onBeginVisit

protected void onBeginVisit(VisitManager manager,
                            Visit visit)

Called when a Visit to a new Location and Placement is beginning.

Parameters:

manager - VisitManager

visit - Visit object which contains information on start, end and accumulated and elapsed dwell time

onDwellVisit

protected void onDwellVisit(VisitManager manager,
                            Visit visit)

Called periodically as a user remains in a current Location and Placement.

Parameters:

manager - VisitManager

visit - Visit object which contains information on start, end and accumulated and elapsed dwell time

onEndVisit

protected void onEndVisit(VisitManager manager,
                          Visit visit)

Called when a Visit to a new Location and Placement has ended.

Parameters:

manager - VisitManager

visit - Visit object which contains information on start, end and accumulated and elapsed dwell time

onReceiveContentURL

protected void onReceiveContentURL(ContentManager manager,
                                   Content content)

Called when content of type URL is received.

Parameters:

manager - ContentManager

content - The content that was just received.

onReceiveContentView

protected void onReceiveContentView(ContentManager manager,
                                    Content content)

Called when content of type Swirl is received.

Parameters:

manager - ContentManager

content - The content that was just received.

onReceiveContentCustom

protected void onReceiveContentCustom(ContentManager manager,
                                      Content content,
                                      Completion completion)

Called when content of type Custom is received.

Parameters:

manager - ContentManager

content - The content that was just received.

completion - Call completion when custom content is ready