See: Description
| Class | Description |
|---|---|
| API | |
| API.Completion | |
| API.DataCompletion | |
| API.ImageCompletion | |
| Attachment |
An attachment is a namespace/type and data object that can be
associated with a signal.
|
| Beacon |
A Beacon object defines a type of Signal that is based on the device's proximity to a Bluetooth
beacon, as opposed to a geographic location or wifi network.
|
| BeaconAdvertisement |
A BeaconAdvertisement is an object which represents a Bluetooth Beacon advertisement in a normalized way
for consumption by the rest of the library.
|
| BeaconManager |
The BeaconManager manages the creation, resolution and state of Beacon objects.
|
| BeaconScanner |
The BeaconScanner is a manager which is responsible for interfacing with the devices Bluetooth
hardware to scan for beacon devices and to parse any advertisements found and to create
valid BeaconAdvertisement objects an broadcast them onto the EventBust for consumption by
other managers.
|
| Completion | |
| Config |
Created by Tom on 2/2/17.
|
| Config.Beacon | |
| Config.BeaconConfiguration | |
| Config.BeaconHandler | |
| Config.Firmware | |
| Config.Floorplan | |
| Config.ImageMarker |
An ImageMarker indicates an area of interest on an image, usually as a red circle annotation
on the image.
|
| Config.Location | |
| Config.Partner | |
| Config.User | |
| Content |
A Content object represents targeted content received from the platform in response to a
proximity signal: beacon, wifi network or geo-location change.
|
| ContentActivity |
The ContentActivity class is the default activity class for displayed content in the Swirl.
|
| ContentManager |
The ContentManager requests Content from the platform (through the API) in response to
events generated by the VisitManager.
|
| ContentView |
The ContentView is class which encapsulates a webView for interstitial Swirl content.
|
| Error |
Created by Tom on 3/19/17.
|
| Error.ErrorAccess | |
| Error.ErrorCancelled | |
| Error.ErrorDisabled | |
| Error.ErrorFiltered | |
| Error.ErrorNotConnectable | |
| Error.ErrorNotConnected | |
| Error.ErrorNotFound | |
| Error.ErrorParameters | |
| Error.ErrorRange | |
| Error.ErrorTimeout | |
| Error.ErrorUnknown | |
| EventBus |
The EventBus is the main communication backbone of the library.
|
| Fcm |
Fcm houses the Firebase Cloud Messaging (FCM) services
|
| Fcm.Service | |
| Gcm |
Class containing all of the needed classes for Google Cloud Messaging support
|
| Gcm.Listener |
Service used for receiving GCM messages.
|
| Gcm.Receiver | |
| HandlerExecutor |
HandlerExecutor class adds Executor interfaces to Handlers
|
| Location |
A Location represents a physical street, city, state address or real world location.
|
| MainLoop |
MainLoop class provides accessors for Main Looper, Handler, Executor
|
| Manager |
Manager is the base class for all of the managers in the Swirl library.
|
| NearbyManager |
The NearbyManager uses the Nearby APIs to scan for beacons registered using the google beacon platform.
|
| Peripheral |
Object for discovering, reading, writing to a bluetooth peripheral
|
| Placement |
A Placement is a logical area within a Location.
|
| Region |
A Region represents a latitude and longitude and a radius defining a circular area with an additional
optional set of points representing a polygon refinement of that circular area.
|
| RegionManager |
The RegionManager manages a working set of Region objects and determines based on receiving
Location updates which regions are entered, which are exited and broadcasts that information
onto the EventBus.
|
| SafeRunnable |
Created by Tom on 8/3/16.
|
| Settings |
Settings
|
| Signal |
Signal is the abstract base class for signal objects: beacon, wifi network, region.
|
| SObject |
SObject is the base class for all Swirl platform objects.
|
| Swirl |
The Swirl class is the main entry point into the Swirl Proximity Library for delivery of proximity and content
events to your app.
|
| Swirl.BackgroundEvent |
Event sent when the application goes into the background.
|
| Swirl.DeviceChanged |
A subclass of Receiver for device related events.
|
| Swirl.ErrorEvent |
Event sent when Swirl reports an error
|
| Swirl.ForegroundEvent |
Event sent when the application comes into the foreground.
|
| Swirl.LocationChanged |
A subclass of Receiver for location related events.
|
| Swirl.Receiver |
Base class for all BroadcastReceivers.
|
| Swirl.Service |
This service class presents a STICKY service which runs in the background after the application
has been terminated or has no visible activities in the foreground.
|
| Swirl.StartedEvent |
Event sent when Swirl started without error.
|
| Swirl.StatusChangedEvent |
Event sent when Swirl status changes.
|
| SwirlListener |
SwirlListener is a convenience class created to facilitate intercepting events on the eventBus.
|
| Util | |
| Visit |
A Visit object encapsulates information about places that the user has been.
|
| VisitManager |
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.
|
| WifiInfo |
A WifiInfo represents a wifi network access point and represents a Signal object of TYPE_WIFI.
|
| WifiManager |
The WifiManager monitors the state of wifi networks and is notified by the operating system when the
user changes his wifi connection.
|
| Annotation Type | Description |
|---|---|
| EventBus.Subscribe |