Index (Swirl Proximity Library)

A B C D E F G H I J K L M N O P R S T U V W X Y

A

abortConfiguration() - Method in class com.swirl.Config.Beacon: Discards any pending changes and resets the beacon to current settings.
ACTION_DISMISS_NOTIFICATION - Static variable in class com.swirl.Content: Action for Dismiss notification Intents.
ACTION_OPEN_NOTIFICATION - Static variable in class com.swirl.Content: Action for open notification Intents.
addEddystoneNamespace(String) - Method in class com.swirl.NearbyManager: Add a given Eddystone 10-digit UID to the list of monitored namespaces
addListener(Object, Executor) - Method in class com.swirl.EventBus: Adds a listener to the bus provided it is not already a listener in which case this action does nothing.
addListener(Object) - Method in class com.swirl.Swirl: Add a listener to the internal listener bus.
addListener(Object, Executor) - Method in class com.swirl.Swirl: Add a listener to the internal listener bus, specifying an executor.
addNamespaceType(String, String) - Method in class com.swirl.NearbyManager: Add a given message namespace and type to the list of monitored messages
AES_BLOCK_SIZE - Static variable in class com.swirl.Util
AES_decrypt(byte[], byte[]) - Static method in class com.swirl.Util
AES_decrypt(byte[], byte[], byte[]) - Static method in class com.swirl.Util
AES_decrypt(byte[], byte[], byte[], boolean) - Static method in class com.swirl.Util
AES_encrypt(byte[], byte[]) - Static method in class com.swirl.Util
ANDROID_MATCH_MODE - Static variable in class com.swirl.Settings
ANDROID_MATCH_NUM - Static variable in class com.swirl.Settings
ANDROID_MAX_FILTERS - Static variable in class com.swirl.Settings
ANDROID_REPORT_DELAY - Static variable in class com.swirl.Settings
ANDROID_SCAN_MODE - Static variable in class com.swirl.Settings
API - Class in com.swirl
API.Completion - Class in com.swirl
API.DataCompletion - Class in com.swirl
API.ImageCompletion - Class in com.swirl
API_ACCESS_CODE - Static variable in class com.swirl.Settings
API_ENABLED - Static variable in class com.swirl.Settings
API_HOST - Static variable in class com.swirl.Settings
API_INCLUDE_LATLONG - Static variable in class com.swirl.Settings
API_KEY - Static variable in class com.swirl.Settings
API_PING_ENABLED - Static variable in class com.swirl.Settings
API_PING_WINDOW - Static variable in class com.swirl.Settings
API_SECRET - Static variable in class com.swirl.Settings
appendQueryParametersFromJSON(Uri.Builder, JSONObject) - Static method in class com.swirl.Util
Attachment - Class in com.swirl: An attachment is a namespace/type and data object that can be associated with a signal.
Attachment(JSONObject) - Constructor for class com.swirl.Attachment
authenticate(API.Completion) - Method in class com.swirl.API

B

BACKGROUND_JOB_ID - Static variable in class com.swirl.Settings
BACKGROUND_TIMEOUT - Static variable in class com.swirl.Settings
BackgroundEvent() - Constructor for class com.swirl.Swirl.BackgroundEvent
beacon(String, String, int, API.Completion) - Method in class com.swirl.API
Beacon - Class in com.swirl: 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.
beacon - Variable in class com.swirl.BeaconManager.BeaconEvent
Beacon(Config.Location, JSONObject) - Constructor for class com.swirl.Config.Beacon
BEACON_ACTIVE_INTERVAL - Static variable in class com.swirl.Settings
BEACON_CHECK_INTERVAL - Static variable in class com.swirl.Settings
BEACON_CHECK_PROXIMITY - Static variable in class com.swirl.Settings
BEACON_EXPIRATION - Static variable in class com.swirl.Settings
BEACON_FILTER - Static variable in class com.swirl.Settings
BEACON_MAX_SAMPLE_AGE - Static variable in class com.swirl.Settings
BEACON_MIN_SAMPLES - Static variable in class com.swirl.Settings
BEACON_NAMESPACES_ALWAYS - Static variable in class com.swirl.Settings
BEACON_NAMESPACES_REGION - Static variable in class com.swirl.Settings
BEACON_OPT_SAMPLE_AGE - Static variable in class com.swirl.Settings
BEACON_POWER_MODE - Static variable in class com.swirl.Settings
BEACON_RESOLVE_EDDYSTONE_EID - Static variable in class com.swirl.Settings
BEACON_RESOLVE_EDDYSTONE_UID - Static variable in class com.swirl.Settings
BEACON_RESOLVE_IBEACON - Static variable in class com.swirl.Settings
BEACON_REST_INTERVAL - Static variable in class com.swirl.Settings
BEACON_REST_INTERVAL_ACTIVE - Static variable in class com.swirl.Settings
BEACON_REST_INTERVAL_LOW - Static variable in class com.swirl.Settings
BEACON_SCAN_GENERIC - Static variable in class com.swirl.Settings
BEACON_SCAN_INTERVAL - Static variable in class com.swirl.Settings
BEACON_SCAN_INTERVAL_ACTIVE - Static variable in class com.swirl.Settings
BEACON_SCAN_INTERVAL_LOW - Static variable in class com.swirl.Settings
BEACON_SCAN_MODE - Static variable in class com.swirl.Settings
BEACON_SCAN_REGION - Static variable in class com.swirl.Settings
BEACON_SERVICES_ALWAYS - Static variable in class com.swirl.Settings
BEACON_SERVICES_CONFIG - Static variable in class com.swirl.Settings
BEACON_SERVICES_REGION - Static variable in class com.swirl.Settings
BEACON_THRESHOLD - Static variable in class com.swirl.Settings
BEACON_THRESHOLD_ADJUSTMENT - Static variable in class com.swirl.Settings
BEACON_TYPE_EID - Static variable in class com.swirl.BeaconAdvertisement
BEACON_TYPE_IBEACON - Static variable in class com.swirl.BeaconAdvertisement
BEACON_TYPE_UID - Static variable in class com.swirl.BeaconAdvertisement
BEACON_TYPE_UNSPECIFIED - Static variable in class com.swirl.BeaconAdvertisement
BEACON_UUIDS_ALWAYS - Static variable in class com.swirl.Settings
BEACON_UUIDS_REGION - Static variable in class com.swirl.Settings
BEACON_WAKEUP_INTERVAL - Static variable in class com.swirl.Settings
BeaconAdvertisement - Class in com.swirl: A BeaconAdvertisement is an object which represents a Bluetooth Beacon advertisement in a normalized way for consumption by the rest of the library.
BeaconConfiguration(JSONObject) - Constructor for class com.swirl.Config.BeaconConfiguration
BeaconDiscoverEvent(Beacon) - Constructor for class com.swirl.BeaconManager.BeaconDiscoverEvent
BeaconDwellEvent(Beacon) - Constructor for class com.swirl.BeaconManager.BeaconDwellEvent
BeaconEnterEvent(Beacon) - Constructor for class com.swirl.BeaconManager.BeaconEnterEvent
BeaconEvent(Beacon) - Constructor for class com.swirl.BeaconManager.BeaconEvent
BeaconExitEvent(Beacon) - Constructor for class com.swirl.BeaconManager.BeaconExitEvent
BeaconHandler() - Constructor for class com.swirl.Config.BeaconHandler
beaconHandlerForManufacturer(String) - Static method in class com.swirl.Config
BeaconManager - Class in com.swirl: The BeaconManager manages the creation, resolution and state of Beacon objects.
BeaconManager() - Constructor for class com.swirl.BeaconManager
BeaconManager.BeaconDiscoverEvent - Class in com.swirl: This event is generated when a beacon is discovered
BeaconManager.BeaconDwellEvent - Class in com.swirl: This event is generated periodically as the mobile device remains within a beacon.
BeaconManager.BeaconEnterEvent - Class in com.swirl: This event is generated when a beacon is entered.
BeaconManager.BeaconEvent - Class in com.swirl: BeaconEvent is the base class for all events generated by the BeaconManager.
BeaconManager.BeaconExitEvent - Class in com.swirl: This event is generated when a beacon is exited.
BeaconManager.BeaconNearestEvent - Class in com.swirl: This event is generated when the nearest beacon changes.
BeaconManager.BeaconResolveEvent - Class in com.swirl: This event is generated when a beacon is resolved
BeaconNearestEvent(Beacon) - Constructor for class com.swirl.BeaconManager.BeaconNearestEvent
BeaconResolveEvent(Beacon) - Constructor for class com.swirl.BeaconManager.BeaconResolveEvent
BeaconScanner - Class in com.swirl: 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.
BeaconScanner() - Constructor for class com.swirl.BeaconScanner
beginConfiguration() - Method in class com.swirl.Config.Beacon: Begin a set of beacon configuration operations.
BeginVisitEvent(Visit) - Constructor for class com.swirl.VisitManager.BeginVisitEvent
bodyForCreateBeacon(Beacon) - Method in class com.swirl.Config.BeaconHandler
BTUUID(String) - Static method in class com.swirl.Peripheral

C

checkApiVersions() - Static method in class com.swirl.Swirl
clearCharacteristics() - Method in class com.swirl.Peripheral
clearLocationLock(API.Completion) - Method in class com.swirl.API
code - Variable in class com.swirl.Error
com.swirl - package com.swirl: Swirl Proximity Library (com.swirl) The Swirl Proximity framework gives your application the ability to receive proximity and location events based on the devices current location.
commit() - Static method in class com.swirl.Settings
commitConfiguration(boolean, Completion) - Method in class com.swirl.Config.Beacon: Flushes pending configuration changes to the server and calls the completion when all changes have been completed or an error occurs.
complete() - Method in class com.swirl.Completion
complete(int) - Method in class com.swirl.Completion
complete(int, Object) - Method in class com.swirl.Completion
Completion() - Constructor for class com.swirl.API.Completion
completion(int, String) - Method in class com.swirl.API.Completion
completion(int, JSONObject) - Method in class com.swirl.API.Completion
Completion - Class in com.swirl
Completion(int, Object, Executor) - Constructor for class com.swirl.Completion
Completion(int, Object) - Constructor for class com.swirl.Completion
Completion(Object) - Constructor for class com.swirl.Completion
Completion(Executor) - Constructor for class com.swirl.Completion
Completion() - Constructor for class com.swirl.Completion
completion(int, Object) - Method in class com.swirl.Completion
completion(int) - Method in class com.swirl.Completion
completion() - Method in class com.swirl.Completion
completion - Variable in class com.swirl.ContentManager.ReceiveContentCustomEvent
Config - Class in com.swirl: Created by Tom on 2/2/17.
Config() - Constructor for class com.swirl.Config
Config.Beacon - Class in com.swirl
Config.BeaconConfiguration - Class in com.swirl
Config.BeaconHandler - Class in com.swirl
Config.Firmware - Class in com.swirl
Config.Floorplan - Class in com.swirl
Config.ImageMarker - Class in com.swirl: An ImageMarker indicates an area of interest on an image, usually as a red circle annotation on the image.
Config.Location - Class in com.swirl
Config.Partner - Class in com.swirl
Config.User - Class in com.swirl
CONFIG_ENABLED - Static variable in class com.swirl.Settings
connect(long, Executor, Completion) - Method in class com.swirl.Peripheral
connectDiscoverAndReadCharacteristics(boolean, boolean, long, Executor, Completion) - Method in class com.swirl.Peripheral
connectForConfiguration(Beacon, long, Completion) - Static method in class com.swirl.Config
containsLocation(Location) - Method in class com.swirl.Region: Determine if a Location is contained within the Region.
content(Uri.Builder, JSONObject, API.Completion) - Method in class com.swirl.API
content(String, Location, long, long, long, API.Completion) - Method in class com.swirl.API
Content - Class in com.swirl: A Content object represents targeted content received from the platform in response to a proximity signal: beacon, wifi network or geo-location change.
Content(Context, JSONObject, Visit, boolean) - Constructor for class com.swirl.Content
Content(Context, Intent, boolean) - Constructor for class com.swirl.Content
content - Variable in class com.swirl.ContentActivity
content - Variable in class com.swirl.ContentManager.ContentEvent
content - Variable in class com.swirl.NearbyManager.NearbyMessage
CONTENT_ACTIONBAR_COLOR - Static variable in class com.swirl.Settings
CONTENT_ACTIONBAR_TEXT_COLOR - Static variable in class com.swirl.Settings
CONTENT_CODE - Static variable in class com.swirl.Settings
CONTENT_DELAY - Static variable in class com.swirl.Settings
CONTENT_LOAD_DELAY - Static variable in class com.swirl.Settings
CONTENT_SPINNER_TIMEOUT - Static variable in class com.swirl.Settings
CONTENT_STATUSBAR_COLOR - Static variable in class com.swirl.Settings
CONTENT_STATUSBAR_THEME - Static variable in class com.swirl.Settings
CONTENT_TIMEOUT - Static variable in class com.swirl.Settings
CONTENT_TYPE_CUSTOM - Static variable in class com.swirl.Content: Content with this type can generate notifications, but otherwise is just passed through to the application.
CONTENT_TYPE_SWIRL - Static variable in class com.swirl.Content: Content with this type is presented as an interstitial web view.
CONTENT_TYPE_SWIRL_URL - Static variable in class com.swirl.Content: Content with this type is present as an interstitial web view
CONTENT_TYPE_URL - Static variable in class com.swirl.Content: Content with this type is used for deep-links back into the application or other applications.
ContentActivity - Class in com.swirl: The ContentActivity class is the default activity class for displayed content in the Swirl.
ContentActivity() - Constructor for class com.swirl.ContentActivity
ContentEvent(Content) - Constructor for class com.swirl.ContentManager.ContentEvent
contentHistory - Variable in class com.swirl.ContentActivity
ContentManager - Class in com.swirl: The ContentManager requests Content from the platform (through the API) in response to events generated by the VisitManager.
ContentManager(Context) - Constructor for class com.swirl.ContentManager
ContentManager.ContentEvent - Class in com.swirl: ContentEvent is the base class for all content events.
ContentManager.ReceiveContentCustomEvent - Class in com.swirl: This event is sent when content of type Custom is received.
ContentManager.ReceiveContentURLEvent - Class in com.swirl: This event is sent when content of type URL is received.
ContentManager.ReceiveContentViewEvent - Class in com.swirl: This event is sent when content of type Swirl is received.
contentView - Variable in class com.swirl.ContentActivity
contentView - Variable in class com.swirl.ContentManager
ContentView - Class in com.swirl: The ContentView is class which encapsulates a webView for interstitial Swirl content.
ContentView(Context) - Constructor for class com.swirl.ContentView
context - Variable in class com.swirl.ContentManager
copy() - Method in class com.swirl.Region
CRC32(byte[], int) - Static method in class com.swirl.Util
createBeacon(Beacon, Placement, Completion) - Method in class com.swirl.Config.Location

D

data - Variable in class com.swirl.Config.Firmware
DataCompletion() - Constructor for class com.swirl.API.DataCompletion
dataRequest(String, JSONObject, API.DataCompletion) - Method in class com.swirl.API
dateString(Date, String, Locale, TimeZone) - Static method in class com.swirl.Util
dateString(Date, String) - Static method in class com.swirl.Util
DAYS(long) - Static method in class com.swirl.Util
dbm1 - Variable in class com.swirl.BeaconAdvertisement: A dB at 1m as reported by the beacon device (if reported).
description(BluetoothGattCharacteristic) - Static method in class com.swirl.Peripheral
detected - Variable in class com.swirl.BeaconAdvertisement: A millisecond timestamp based on System.currentTimeMillis().
device - Variable in class com.swirl.BeaconAdvertisement: The Beacon mac address as reported by the operation system.
DeviceChanged() - Constructor for class com.swirl.Swirl.DeviceChanged
disconnect(Completion) - Method in class com.swirl.Peripheral
disconnectAndWait(long, Completion) - Method in class com.swirl.Peripheral
discover(boolean, boolean, long, Completion) - Method in class com.swirl.Peripheral
discoverAndReadCharacteristics(boolean, boolean, long, Completion) - Method in class com.swirl.Peripheral
distanceFromLocation(Location) - Method in class com.swirl.Region: Compute the distance to this Region.
download(Peripheral, Completion) - Method in class com.swirl.Config.Firmware

E

EDDYSTONE_UUID - Static variable in class com.swirl.BeaconAdvertisement: A Bluetooth standard UUID representing a TI Firmware upgrade service
EMPTY_JSON - Static variable in class com.swirl.Util
enter() - Method in class com.swirl.Visit
entered - Variable in class com.swirl.RegionManager.RegionsChangedEvent
ENTERED_RSSI - Static variable in class com.swirl.Beacon: This value is for an RSSI that forces a placement/zone entry.
equals(Object) - Method in class com.swirl.BeaconAdvertisement
equals(Object) - Method in class com.swirl.Content
equals(Object) - Method in class com.swirl.Error
equals(Object) - Method in class com.swirl.SObject
Error - Class in com.swirl: Created by Tom on 3/19/17.
Error(int, String) - Constructor for class com.swirl.Error
Error(int) - Constructor for class com.swirl.Error
Error() - Constructor for class com.swirl.Error
Error.ErrorAccess - Class in com.swirl
Error.ErrorCancelled - Class in com.swirl
Error.ErrorDisabled - Class in com.swirl
Error.ErrorFiltered - Class in com.swirl
Error.ErrorNotConnectable - Class in com.swirl
Error.ErrorNotConnected - Class in com.swirl
Error.ErrorNotFound - Class in com.swirl
Error.ErrorParameters - Class in com.swirl
Error.ErrorRange - Class in com.swirl
Error.ErrorTimeout - Class in com.swirl
Error.ErrorUnknown - Class in com.swirl
ERROR_ACCESS - Static variable in class com.swirl.Error
ERROR_BUSY - Static variable in class com.swirl.Error
ERROR_CANCELLED - Static variable in class com.swirl.Error
ERROR_DISABLED - Static variable in class com.swirl.API
ERROR_DISABLED - Static variable in class com.swirl.Error
ERROR_FILTERED - Static variable in class com.swirl.Error
ERROR_GATT_CONNECTION_CONGESTED - Static variable in class com.swirl.Peripheral
ERROR_GATT_ERROR - Static variable in class com.swirl.Peripheral
ERROR_GATT_FAILURE - Static variable in class com.swirl.Peripheral
ERROR_GATT_INSUFFICIENT_AUTHENTICATION - Static variable in class com.swirl.Peripheral
ERROR_GATT_INSUFFICIENT_AUTHORIZATION - Static variable in class com.swirl.Peripheral
ERROR_GATT_INSUFFICIENT_ENCRYPTION - Static variable in class com.swirl.Peripheral
ERROR_GATT_INVALID - Static variable in class com.swirl.Error
ERROR_GATT_INVALID_ATTRIBUTE_LENGTH - Static variable in class com.swirl.Peripheral
ERROR_GATT_INVALID_OFFSET - Static variable in class com.swirl.Peripheral
ERROR_GATT_READ_NOT_PERMITTED - Static variable in class com.swirl.Peripheral
ERROR_GATT_REQUEST_NOT_SUPPORTED - Static variable in class com.swirl.Peripheral
ERROR_GATT_VERIFY - Static variable in class com.swirl.Error
ERROR_GATT_WRITE_NOT_PERMITTED - Static variable in class com.swirl.Peripheral
ERROR_LOAD_CANCELLED - Static variable in class com.swirl.ContentView
ERROR_MANUFACTURER - Static variable in class com.swirl.Error
ERROR_MODEL - Static variable in class com.swirl.Error
ERROR_NOT_CONNECTED - Static variable in class com.swirl.Peripheral
ERROR_NOT_FOUND - Static variable in class com.swirl.Error
ERROR_PARAMETERS - Static variable in class com.swirl.API
ERROR_PARAMETERS - Static variable in class com.swirl.Error
ERROR_PENDING - Static variable in class com.swirl.Error
ERROR_RANGE - Static variable in class com.swirl.Error
ERROR_TIMEOUT - Static variable in class com.swirl.API
ERROR_TIMEOUT - Static variable in class com.swirl.Error
ERROR_UNKNOWN - Static variable in class com.swirl.API
ERROR_UNKNOWN - Static variable in class com.swirl.Error
ErrorAccess() - Constructor for class com.swirl.Error.ErrorAccess
ErrorCancelled() - Constructor for class com.swirl.Error.ErrorCancelled
ErrorDisabled() - Constructor for class com.swirl.Error.ErrorDisabled
ErrorEvent(int) - Constructor for class com.swirl.Swirl.ErrorEvent
ErrorFiltered() - Constructor for class com.swirl.Error.ErrorFiltered
ErrorNotConnectable() - Constructor for class com.swirl.Error.ErrorNotConnectable
ErrorNotConnected() - Constructor for class com.swirl.Error.ErrorNotConnected
ErrorNotFound() - Constructor for class com.swirl.Error.ErrorNotFound
ErrorParameters() - Constructor for class com.swirl.Error.ErrorParameters
ErrorRange() - Constructor for class com.swirl.Error.ErrorRange
ErrorTimeout() - Constructor for class com.swirl.Error.ErrorTimeout
ErrorUnknown() - Constructor for class com.swirl.Error.ErrorUnknown
EVENT_IMPRESSION_1 - Static variable in class com.swirl.ContentManager: These events are for user-defined reporting
EVENT_IMPRESSION_10 - Static variable in class com.swirl.ContentManager
EVENT_IMPRESSION_2 - Static variable in class com.swirl.ContentManager
EVENT_IMPRESSION_3 - Static variable in class com.swirl.ContentManager
EVENT_IMPRESSION_4 - Static variable in class com.swirl.ContentManager
EVENT_IMPRESSION_5 - Static variable in class com.swirl.ContentManager
EVENT_IMPRESSION_6 - Static variable in class com.swirl.ContentManager
EVENT_IMPRESSION_7 - Static variable in class com.swirl.ContentManager
EVENT_IMPRESSION_8 - Static variable in class com.swirl.ContentManager
EVENT_IMPRESSION_9 - Static variable in class com.swirl.ContentManager
EVENT_IMPRESSION_OFFER_REDEEMED - Static variable in class com.swirl.ContentManager: This event is added to the log stream when an offer is redeeemed.
EVENT_IMPRESSION_REJECTED - Static variable in class com.swirl.ContentManager: This event is added to the log stream when an impression is rejected via the override shouldShowContent.
EVENT_IMPRESSION_SAVED - Static variable in class com.swirl.ContentManager: This event is added to the log stream when an impression is saved.
EVENT_IMPRESSION_SHARED - Static variable in class com.swirl.ContentManager: This event is added to the log stream when an impression is shared.
EVENT_IMPRESSION_TAP_AREA - Static variable in class com.swirl.ContentManager: This event is added to the log stream when a tap area is hit
EVENT_IMPRESSION_TIMEOUT - Static variable in class com.swirl.ContentManager: This event is added to the log stream when a presentation is rejected by the application due to being too old (stale).
EVENT_IMPRESSION_TOUCHED - Static variable in class com.swirl.ContentManager: This event is added to the log stream whena n impression is touched.
EVENT_IMPRESSION_VIEWED - Static variable in class com.swirl.ContentManager: This event is added to the log stream when an impressions is viewed.
EVENT_IMPRESSION_VIEWED_MINIMIZED - Static variable in class com.swirl.ContentManager: This event is added to the log stream when an impressions is viewed using alternate layout
EVENT_IMPRESSION_WALLET_REDEEMED - Static variable in class com.swirl.ContentManager: This event is added to the log stream when a wallet item is redeeemed
EVENT_NOTIFICATION_ABSENT - Static variable in class com.swirl.ContentManager: This event is added to the log stream when content does not contain a notification.
EVENT_NOTIFICATION_DISABLE - Static variable in class com.swirl.ContentManager: This event is added to the log stream when notifications are disabled.
EVENT_NOTIFICATION_DISMISS - Static variable in class com.swirl.ContentManager: This event is added to the log stream when a notification is dismissed.
EVENT_NOTIFICATION_OPEN - Static variable in class com.swirl.ContentManager: This event is added to the log stream when a notification is opened.
EVENT_NOTIFICATION_SENT - Static variable in class com.swirl.ContentManager: This event is added to the log stream when a notification is sent without any of the othe qualifications.
EVENT_NOTIFICATION_SENT_BLOCKED - Static variable in class com.swirl.ContentManager: This event is added to the log stream when a notification is present, but the user has blocked notifications.
EVENT_NOTIFICATION_SENT_NOSOUND - Static variable in class com.swirl.ContentManager: This event is added to the log stream when a notification is present, but the user has disallowed sound (or vibration) for notifications.
EVENT_NOTIFICATION_TIMEOUT - Static variable in class com.swirl.ContentManager: This event is added to the log stream when a notification is rejected by the application due to being too old (stale).
EVENT_NOTIFICATON_REJECTED - Static variable in class com.swirl.ContentManager: This event is added to the log stream when a notification is rejected by the application via the shouldShowNotification override.
EventBus - Class in com.swirl: The EventBus is the main communication backbone of the library.
EventBus() - Constructor for class com.swirl.EventBus
EventBus.Subscribe - Annotation Type in com.swirl
execute(Runnable) - Method in class com.swirl.HandlerExecutor
execute(Runnable, long) - Method in class com.swirl.HandlerExecutor
exit() - Method in class com.swirl.Visit
exited - Variable in class com.swirl.RegionManager.RegionsChangedEvent
extra - Variable in class com.swirl.BeaconAdvertisement: Any associated telemetry or out-of-band data send in other packets.
EXTRA_CONTENT - Static variable in class com.swirl.Content: Extra for notification Intents that contains a JSON String of the raw content.
EXTRA_IMPRESSION - Static variable in class com.swirl.Content: Extra for representing the impression id.

F

Fcm - Class in com.swirl: Fcm houses the Firebase Cloud Messaging (FCM) services
Fcm() - Constructor for class com.swirl.Fcm
Fcm.Service - Class in com.swirl
findBeacon(String, String) - Method in class com.swirl.BeaconManager
findBeacon(String, String, long, Executor, Completion) - Method in class com.swirl.BeaconManager
findBeaconByIdentifier(String) - Method in class com.swirl.Config.Location: find a beacon with a particular identifier
findBeaconBySerial(String) - Method in class com.swirl.Config.Location: find a beacon with a particular serial/mac
findListener(Class) - Method in class com.swirl.EventBus: Find a listener on the bus of a given class.
findListener(Class) - Method in class com.swirl.Swirl: Find the first registered listener of a given class.
finish() - Method in class com.swirl.ContentActivity
Firmware(JSONObject) - Constructor for class com.swirl.Config.Firmware
firmwareVersion(Beacon) - Method in class com.swirl.Config.BeaconHandler
FLAG_ALL_DEVICES - Static variable in class com.swirl.BeaconManager
FLAG_REGISTERED_DEVICE - Static variable in class com.swirl.BeaconManager
FLAG_UNREGISTERED_DEVICE - Static variable in class com.swirl.BeaconManager: Called to return the current list of recently sighted, active beacon devices
Floorplan(Config.Location, JSONObject) - Constructor for class com.swirl.Config.Floorplan
flush(boolean) - Method in class com.swirl.API
flushEvents() - Method in class com.swirl.API
ForegroundEvent() - Constructor for class com.swirl.Swirl.ForegroundEvent
format(double, int) - Static method in class com.swirl.Util
formatter(String, Locale, TimeZone) - Static method in class com.swirl.Util
fromBytes(byte[], int, long, String) - Static method in class com.swirl.BeaconAdvertisement: Construct a BeaconAdvertisement from an array of bytes.
fromScanRecord(ScanRecord, int, long, String) - Static method in class com.swirl.BeaconAdvertisement: Constructs a BeaconAdvertisement from a scanRecord

G

gattForBeacon(Config.Beacon, String, JSONObject) - Method in class com.swirl.Config.BeaconHandler
Gcm - Class in com.swirl: Class containing all of the needed classes for Google Cloud Messaging support
Gcm() - Constructor for class com.swirl.Gcm
Gcm.Listener - Class in com.swirl: Service used for receiving GCM messages.
Gcm.Receiver - Class in com.swirl
get(String) - Method in class com.swirl.Region
getAccessCode() - Method in class com.swirl.Config.Partner
getActiveBeacons() - Method in class com.swirl.BeaconManager: Called to return the current list of recently sighted, active beacons
getActiveDevices() - Method in class com.swirl.BeaconManager: Called to return the current list of recently sighted, active beacon devices
getActiveDevices(long, int, int) - Method in class com.swirl.BeaconManager
getActiveLocationVisits() - Method in class com.swirl.VisitManager: Get a list of the active (ongoing) Location Visits sorted by quality and distance (nearest and highest quality to farthest and lowest quality).
getActivePlacementVisits() - Method in class com.swirl.VisitManager: Get a list of the active (ongoing) Placement Visits sorted by quality and distance (nearest and highest quality to farthest and lowest quality).
getAddress() - Method in class com.swirl.Beacon
getAddress() - Method in class com.swirl.Location: Get the full Address JSON with street, city, state, zip, etc.
getAddress() - Method in class com.swirl.Peripheral
getAddressDescription() - Method in class com.swirl.Config.Location: Gets the full address as a user displayable string
getAdvertisements() - Method in class com.swirl.Beacon: Get the list of current BeaconAdvertisements associated to this beacon.
getAll() - Static method in class com.swirl.Settings
getAllBeacons() - Method in class com.swirl.BeaconManager: Called to return the current list of Beacons
getAllVersions(Completion) - Static method in class com.swirl.Config.Firmware
getAPIHost() - Method in class com.swirl.API
getAPIKey() - Method in class com.swirl.API
getArray(String) - Static method in class com.swirl.Settings
getArray(String, JSONArray) - Method in class com.swirl.SObject
getArray(String) - Method in class com.swirl.SObject
getArrayList(String) - Static method in class com.swirl.Settings
getArrivalTime() - Method in class com.swirl.Visit: Returns the number of milliseconds since epoch start representing the time the Location was entered.
getAttachments(String) - Method in class com.swirl.Signal: If resolved returns the set of attachments that match the type specifier.
getAttributes() - Method in class com.swirl.Content: Get the attributes associated with this content.
getAttributes() - Method in class com.swirl.Signal: If resolved, returns the custom attributes associated with this signal.
getBattery() - Method in class com.swirl.Config.Beacon
getBeacons() - Method in class com.swirl.Config.Location: Get the beacons configured for this location.
getBlockCount() - Method in class com.swirl.Config.Firmware
getBoolean(String, boolean) - Static method in class com.swirl.Settings
getByteValue(String) - Method in class com.swirl.Peripheral
getCDNHost() - Method in class com.swirl.API
getCenter() - Method in class com.swirl.Region: Get the center point of the Region as an operating system Location object.
getCharacteristic(String) - Method in class com.swirl.Peripheral
getCharacteristics() - Method in class com.swirl.Peripheral
getConfigurations(Config.Partner, Completion) - Static method in class com.swirl.Config.BeaconConfiguration
getContentHistory() - Method in class com.swirl.ContentView
getContentView() - Method in class com.swirl.ContentManager: Returns the default ContentView.
getCustomType() - Method in class com.swirl.Content: Get the custom content type associeted with this content
getData(String, API.DataCompletion) - Method in class com.swirl.API
getData() - Method in class com.swirl.Attachment
getData() - Method in class com.swirl.Completion
getdBm1() - Method in class com.swirl.Beacon: Returns the 1m measured power.
getDbm1() - Method in class com.swirl.BeaconAdvertisement
getDepartureTime() - Method in class com.swirl.Visit: Returns the number of milliseconds since epoch start representing the time the Location was exited.
getDeviceConfigurationState() - Method in class com.swirl.Config.Beacon
getDeviceInfo() - Method in class com.swirl.API
getDouble(String, double) - Static method in class com.swirl.Settings
getDouble(String, double) - Method in class com.swirl.SObject
getDwellTime() - Method in class com.swirl.Visit: Returns the number of milliseconds the mobile device was within the Location.
getElapsedTime() - Method in class com.swirl.Visit: Returns the number of milliseconds the mobile device was within the Location as wall or elapsed time.
getEmptyContentHtml() - Method in class com.swirl.ContentView: Return the default html for an empty content window.
getEnteredRegions() - Method in class com.swirl.RegionManager
getError() - Method in class com.swirl.Completion
getError() - Method in class com.swirl.Signal: Get any error associated with this signal, or 0 if no error.
getError() - Method in class com.swirl.Swirl: Return the library's last recorded error.
getException() - Method in class com.swirl.Completion
getExecutor() - Method in class com.swirl.API: Return the 'swirl-thread' scheduled executor service
getExecutor() - Method in class com.swirl.Completion
getExecutor() - Static method in class com.swirl.MainLoop
getExternalIdentifier() - Method in class com.swirl.Location: Get any external (user-assigned) identifier for this Location.
getExtra() - Method in class com.swirl.Beacon: Searches the recent BeaconAdvertisements associated with this beacon to find any TLM or out-of-band data packets and returns that information as a base-64 encoded string.
getExtra(Intent, String) - Static method in class com.swirl.Util
getFallbackURL() - Method in class com.swirl.Content: Get the fallback URL associated with this content.
getFarImage() - Method in class com.swirl.Config.Beacon: Gets far image
getFarImage(Completion) - Method in class com.swirl.Config.Beacon: Return the locally configured pending far image or fetch the previously configured image.
getFarImageMarker() - Method in class com.swirl.Config.Beacon: Get the image marker associated with the far image
getFirmware() - Method in class com.swirl.Config.Beacon
getFirstEnterTime() - Method in class com.swirl.Visit
getFloat(String, float) - Static method in class com.swirl.Settings
getFloorplan() - Method in class com.swirl.Config.Beacon: Gets Floorplan
getFloorplan(String) - Method in class com.swirl.Config.Location: Get the floorplan for a location with a specific identifier
getFloorplanMarker() - Method in class com.swirl.Config.Beacon: Get the pin location marker
getFloorplans() - Method in class com.swirl.Config.Location: Gets tfloorplan objects configured for this location
getGoogleBeaconId(String) - Static method in class com.swirl.BeaconAdvertisement: Returns the google proximity beacon API compatible formatted identifier
getGoogleBeaconType(String) - Static method in class com.swirl.BeaconAdvertisement: Returns the google proximity beacon API compatible formatted type identifier
getHandler() - Static method in class com.swirl.MainLoop
getHeight() - Method in class com.swirl.Config.Floorplan
getIdentifier() - Method in class com.swirl.Content: Get the impression identifier associated with this content.
getIdentifier() - Method in class com.swirl.Location: Unique identifier for this location.
getIdentifier() - Method in class com.swirl.SObject: Returns a unique identifier for this signal by the platform
getImage(String, API.ImageCompletion) - Method in class com.swirl.API
getImage() - Method in class com.swirl.Config.Floorplan
getImage(Completion) - Method in class com.swirl.Config.Floorplan
getImage(String) - Static method in class com.swirl.Settings
getImageURL(String, API.ImageCompletion) - Method in class com.swirl.API
getInstance() - Static method in class com.swirl.API: Return the shared singleton, assuming it has already been created.
getInstance(Context) - Static method in class com.swirl.API: Return the shared singleton, assuming it has already been created.
getInstance() - Static method in class com.swirl.BeaconManager: Called to return the last BeaconManager created.
getInstance() - Static method in class com.swirl.BeaconScanner
getInstance() - Static method in class com.swirl.ContentManager: Returns the last ContentManager created.
getInstance() - Static method in class com.swirl.NearbyManager: Returns the last NearbyManager created.
getInstance() - Static method in class com.swirl.RegionManager: Returns the last RegionManager created.
getInstance() - Static method in class com.swirl.Swirl: Return the shared singleton, assuming it has already been created.
getInstance(Context) - Static method in class com.swirl.Swirl: Return the shared singleton, assuming it has already been created.
getInstance(Context, Class[]) - Static method in class com.swirl.Swirl: Return the shared singleton, assuming it has already been created.
getInstance() - Static method in class com.swirl.VisitManager: Returns the last VisitManager created.
getInt(String, int) - Static method in class com.swirl.Settings
getInt(String, int) - Method in class com.swirl.SObject
getIntervalSinceDeparture() - Method in class com.swirl.Visit: Returns the number of milliseconds since the Location associated with this Visit was exited.
getLabel() - Method in class com.swirl.Completion
getLabels() - Method in class com.swirl.Signal: If resolved, returns the custom labels associated with this signal.
getLast() - Method in class com.swirl.Beacon: Get the last BeaconAdvertisement received.
getLastContent() - Method in class com.swirl.ContentManager: Returns the last content received, regardless of whether it has been shown or not.
getLastDetected() - Method in class com.swirl.Beacon: Get the detected timestamp from the last BeaconAdvertisement or return 0
getLastDetected() - Method in class com.swirl.Region: Get the approximate range (in meters) to the center of the region
getLastDetected() - Method in class com.swirl.Signal: Get the detected timestamp for this signal or return 0, overridden by each signal type
getLastDetected() - Method in class com.swirl.WifiInfo: Return the lastDetected timestamp.
getLastDispatchMillis() - Method in class com.swirl.EventBus: Get the timestamp of the last event dispatched.
getLastShown() - Method in class com.swirl.ContentManager: Returns the last content shown (in this session)
getLatestVersion(String, String, Completion) - Static method in class com.swirl.Config.Firmware
getLatitude() - Method in class com.swirl.API
getLatitude() - Method in class com.swirl.Location: Get the latitude associated with this Location.
getLaunchIntent(Context) - Static method in class com.swirl.Util
getLoadingView() - Method in class com.swirl.ContentView: Return a loading view to display when content is taking too long to load.
getLocation() - Method in class com.swirl.Config.Beacon: Return the current (possibly uncommitted) location for the beacon
getLocation() - Method in class com.swirl.Config.Floorplan
getLocation() - Method in class com.swirl.Location: Get the Location portion of a compound location.
getLocation() - Method in class com.swirl.Signal: Get the logical Location associated with this signal in the platform
getLocation() - Method in class com.swirl.Swirl: Return the library's internal location object.
getLocation() - Method in class com.swirl.Visit: Get the Location object tied to this Visit.
getLocationName() - Method in class com.swirl.Config.Location: Get the Location name.
getLocations() - Method in class com.swirl.Config.Partner
getLong(String, long) - Static method in class com.swirl.Settings
getLongitude() - Method in class com.swirl.API
getLongitude() - Method in class com.swirl.Location: Get the longitude associated with this Location.
getMacAddress() - Method in class com.swirl.Config.Beacon
getManufacturer() - Method in class com.swirl.Beacon: Return the registered manufacturer
getManufacturer() - Method in class com.swirl.Config.Firmware
getMetaData() - Static method in class com.swirl.Settings
getModel() - Method in class com.swirl.Beacon: Returns the Beacon mdoel string
getModel() - Method in class com.swirl.Config.Firmware
getMonitoredArea() - Method in class com.swirl.RegionManager
getMonitoredRegions() - Method in class com.swirl.RegionManager
getName() - Method in class com.swirl.Beacon
getName() - Method in class com.swirl.Config.Firmware
getName() - Method in class com.swirl.Peripheral
getName() - Method in class com.swirl.SObject
getName() - Method in class com.swirl.WifiInfo: Get the SSID of the currently attached network.
getNamespaceString() - Method in class com.swirl.BeaconAdvertisement: Returns the namespace string for eddystone-uid protocols
getNearImage() - Method in class com.swirl.Config.Beacon: Gets near image
getNearImage(Completion) - Method in class com.swirl.Config.Beacon: Return the locally configured pending near image or fetch the previously configured image.
getNearImageMarker() - Method in class com.swirl.Config.Beacon: Get the image marker associated with the near image
getNotification(boolean, Bitmap) - Method in class com.swirl.Content: Get a operating system Notification object for this content or null if the content has no notification.
getNotificationIcon() - Static method in class com.swirl.Settings
getNotificationsBlocked(Context) - Static method in class com.swirl.Util
getNotificationsSilent(Context) - Static method in class com.swirl.Util
getNotificationText() - Method in class com.swirl.Content: Gets the notification text if present
getNotificationTitle() - Method in class com.swirl.Content: Gets the notification title if present or application label if not
getNotificationWithImage(boolean, Completion) - Method in class com.swirl.Content: Get a operating system Notification object for this content or null if the content has no notification.
getObject() - Method in class com.swirl.Attachment
getObject(String) - Static method in class com.swirl.Settings
getObject(String, JSONObject) - Method in class com.swirl.SObject
getObject(String) - Method in class com.swirl.SObject
getParent() - Method in class com.swirl.Visit: Get the parent Visit.
getPartner() - Method in class com.swirl.Beacon: Return the partner for this beacon
getPartnerIdentifier() - Method in class com.swirl.Config.Location: Get the Partner identifier.
getPartnerName() - Method in class com.swirl.API
getPartnerRoles(Config.Partner) - Method in class com.swirl.Config.User
getPartnersWithRoles(String[]) - Method in class com.swirl.Config.User
getPeripheral() - Method in class com.swirl.Beacon: Get the peripheral associated with this beacon (if in configuration mode)
getPeripheralBeacon(Beacon, String, Completion) - Static method in class com.swirl.Config.Beacon
getPeripheralBeacon(Beacon, String, long, Completion) - Static method in class com.swirl.Config.Beacon
getPlacement() - Method in class com.swirl.Config.Beacon: Returns the current (possibly uncommitted) placement for the beacon
getPlacement() - Method in class com.swirl.Location: Gets the placement associated with this Location.
getPlacements() - Method in class com.swirl.Config.Partner
getPolyCoords() - Method in class com.swirl.Region
getPolyCount() - Method in class com.swirl.Region: For polygon regions, get then number of vertices in the polygon
getPower() - Method in class com.swirl.Beacon: Get the transmit power as specified in the platform database (as opposed to read directly from the beacon).
getProtocol() - Method in class com.swirl.Beacon: Return the protocol of the underlying advertisements
getProtocol(String) - Static method in class com.swirl.BeaconAdvertisement: Returns the identifier for the protocol given an identifier
getProtocol() - Method in class com.swirl.BeaconAdvertisement: Returns the identifier for the protocol
getProtocolString() - Method in class com.swirl.Beacon: Return the protocol description of the underlying advertisements
getProtocolString(int) - Static method in class com.swirl.BeaconAdvertisement: Returns the protocol description given the id
getProtocolString() - Method in class com.swirl.BeaconAdvertisement: Returns the protocol of the advertisement
getPushAuthority() - Method in class com.swirl.API
getPushIdentifier() - Method in class com.swirl.API
getPushService() - Method in class com.swirl.API
getRadius() - Method in class com.swirl.Region: Get the radius of the region (meters).
getRange() - Method in class com.swirl.Beacon: Compute a range in meters based on the current RSSI estimate.
getRange() - Method in class com.swirl.Region: Get the approximate range (in meters) to the center of the region
getRange() - Method in class com.swirl.Signal: Get the approximate range to the singal source in meters.
getRange() - Method in class com.swirl.WifiInfo: Return the approximate range to this access point.
getRssi() - Method in class com.swirl.Beacon: Computes a RSSI value based on the current working set of BeaconAdvertisements associated with this beacon.
getRssi() - Method in class com.swirl.WifiInfo: Get ths RSSI associated with the last update from the operating system.
getSerial() - Method in class com.swirl.Beacon: If resolved, returns the beacon serial number, otherwise an empty string.
getServerConfigurationState() - Method in class com.swirl.Config.Beacon
getService(String) - Method in class com.swirl.Peripheral
getShareIntent() - Method in class com.swirl.Content: Returns an Intent suitable for using with the Android Share Widget
getShortValue(String) - Method in class com.swirl.Peripheral
getSignal() - Method in class com.swirl.Location: Gets the signal (beacon, wifi network, or geo-fence region) associated with this Location instance.
getState() - Method in class com.swirl.Beacon: Return the current state of the beacon with respect to its threshold.
getStatus() - Method in class com.swirl.Swirl: Return the library's running status.
getString(String, String) - Static method in class com.swirl.Settings
getString(String, String) - Method in class com.swirl.SObject
getString(String) - Method in class com.swirl.SObject
getStringArray(String, String) - Static method in class com.swirl.Settings
getStringArray(String) - Static method in class com.swirl.Settings
getThreshold() - Method in class com.swirl.Beacon: Get the RSSI threshold value.
getTimestamp() - Method in class com.swirl.Content: Returns the milliseconds since epoch of when the content was received by the client.
getTimezone() - Method in class com.swirl.Location: Get the timezone associated with this Location.
getType() - Method in class com.swirl.Attachment
getType() - Method in class com.swirl.Beacon: Inherited from Signal, for beacons this always returns the same value.
getType() - Method in class com.swirl.Content: Get the content type associated with this content.
getType() - Method in class com.swirl.Region: Get the signal type -- always returns TYPE_GEOFENCE
getType() - Method in class com.swirl.Signal: Get the type of signal
getType() - Method in class com.swirl.WifiInfo: Return the signal type of this object.
getURL() - Method in class com.swirl.Content: Get the URL associated with this content.
getURN() - Method in class com.swirl.Signal: Get the URN identifier for this signal
getUserInfo() - Method in class com.swirl.API
getUserInfo() - Method in class com.swirl.Swirl: * Get the currently stored user-info attributes.
getUserKey() - Method in class com.swirl.API
getUserKey() - Method in class com.swirl.Swirl: Returns a string representation of the UUID that the library generates for this device.
getValue(String) - Method in class com.swirl.Peripheral
getVersion() - Method in class com.swirl.Config.Firmware
getVersion() - Method in class com.swirl.Swirl: Get the current version (as a string) of the library.
getVersionNum() - Method in class com.swirl.Config.Firmware
getVersions(String, String, Completion) - Static method in class com.swirl.Config.Firmware
getVisit() - Method in class com.swirl.Content: Get the Visit object associated with this content (if present)
getVisitsForLocation(Location) - Method in class com.swirl.VisitManager: Get a list of the active visit records for a given location.
getWidth() - Method in class com.swirl.Config.Floorplan
GOOGLE_BEACON_API_KEY - Static variable in class com.swirl.Settings
GOOGLE_SENDER_ID - Static variable in class com.swirl.Settings

H

handleException(Throwable) - Method in class com.swirl.SafeRunnable
HandlerExecutor - Class in com.swirl: HandlerExecutor class adds Executor interfaces to Handlers
HandlerExecutor(Looper) - Constructor for class com.swirl.HandlerExecutor
HandlerExecutor() - Constructor for class com.swirl.HandlerExecutor
handleURLIntent(Intent) - Method in class com.swirl.ContentManager: Called to handle an URL Intent Default implementation is context.startActivity(intent)
handleViewIntent(Intent) - Method in class com.swirl.ContentManager: Called to handle a view activity intent Default implementation is context.startActivity(intent)
hasBeacons() - Method in class com.swirl.Region: Determine if this Region contains beacons (control regions only)
hasBeacons - Variable in class com.swirl.RegionManager.RegionsChangedEvent
hashCode() - Method in class com.swirl.BeaconAdvertisement
hashCode() - Method in class com.swirl.Content
hashCode() - Method in class com.swirl.SObject
hasPartnerRoles(Config.Partner, String[]) - Method in class com.swirl.Config.User
hasPermission(Context, String) - Static method in class com.swirl.Util
hexdigest(byte[]) - Static method in class com.swirl.Util
hmac_sha1(String, String) - Static method in class com.swirl.Util
HMAC_SHA256(String, String) - Static method in class com.swirl.Util
HOURS(long) - Static method in class com.swirl.Util

I

identifier - Variable in class com.swirl.BeaconAdvertisement: A String which represents a normalized protocol specific representation of beacon identity.
ImageCompletion() - Constructor for class com.swirl.API.ImageCompletion
ImageMarker(double, double, double) - Constructor for class com.swirl.Config.ImageMarker
ImageMarker(double, double) - Constructor for class com.swirl.Config.ImageMarker
imageRequest(String, JSONObject, API.ImageCompletion) - Method in class com.swirl.API
init(Context, EventBus, ScheduledExecutorService) - Method in class com.swirl.BeaconManager
init(Context, EventBus, ScheduledExecutorService) - Method in class com.swirl.BeaconScanner
init(Context, EventBus, ScheduledExecutorService) - Method in class com.swirl.NearbyManager
init(Context, EventBus, ScheduledExecutorService) - Method in class com.swirl.RegionManager
init(Context, String) - Static method in class com.swirl.Settings
init(Context, EventBus, ScheduledExecutorService) - Method in class com.swirl.VisitManager
init(Context, EventBus, ScheduledExecutorService) - Method in class com.swirl.WifiManager
intentForContent(Content) - Method in class com.swirl.ContentManager
intentForContentActivity(Context) - Method in class com.swirl.ContentManager: Called before starting the ContentActivity to proved an opportunity to subclass the default ContentActivity.
intentForURL(Context, Uri) - Static method in class com.swirl.Util
INVALID_CONFIG - Static variable in class com.swirl.Config.BeaconHandler
INVALID_RANGE - Static variable in class com.swirl.Beacon: This value for a range indicates that there is not enough information to return a value
INVALID_RSSI - Static variable in class com.swirl.Beacon: This value for an RSSI indicates that there is not enough information to return a value
isActive() - Method in class com.swirl.Config.Partner
isAdmin() - Method in class com.swirl.Config.User
isBackgroundMode() - Static method in class com.swirl.Settings
isComplete() - Method in class com.swirl.Completion
isConnectable() - Method in class com.swirl.Beacon
isConnectable() - Method in class com.swirl.BeaconAdvertisement: Returns the connectability state of the device NOTE: unfortunately due to a current android limitation, always returns *true*
isConnected() - Method in class com.swirl.Peripheral
isConnecting() - Method in class com.swirl.Peripheral
isDisconnected() - Method in class com.swirl.Peripheral
isFirstEnter() - Method in class com.swirl.Visit: Determine if this is the first enter to a location
isFromNotification() - Method in class com.swirl.Content: Returns whether this content was delivered via a notification interaction.
isOverlapping() - Method in class com.swirl.Beacon: Determine if this beacon is part of an overlapping placement or not.
isOverlapping() - Method in class com.swirl.Placement: Is the Placement an overlapping placement (or an exclusive placement).
isPending() - Method in class com.swirl.Completion
isRemoteNotification() - Method in class com.swirl.Content: Determine if this content was sent as a remote notification.

J

jsonConcat(JSONArray, JSONArray) - Static method in class com.swirl.Util
jsonFromBase64(String) - Static method in class com.swirl.Util
jsonPut(JSONObject, String, Object) - Static method in class com.swirl.Util

K

key(UUID) - Method in class com.swirl.Peripheral
keyForCharacteristic(BluetoothGattCharacteristic) - Method in class com.swirl.Peripheral

L

LAST_ACCCESS_CODE - Static variable in class com.swirl.API
LAST_ACTIVITY_START - Static variable in class com.swirl.Settings
listContainsString_nocase(List<String>, String) - Static method in class com.swirl.Util
Listener() - Constructor for class com.swirl.Gcm.Listener
load(Completion) - Method in class com.swirl.Config.Beacon
load(Completion) - Method in class com.swirl.Config.Firmware
load(Completion) - Method in class com.swirl.Config.Location: Load all data and related data for this beacon.
load(Completion) - Method in class com.swirl.Config.Partner
load(Completion) - Method in class com.swirl.Config.User
loadBeacons(Completion) - Method in class com.swirl.Config.Location: Load just the related beacon data for this location.
loadContent(Content, long, Completion) - Method in class com.swirl.ContentView
loadLocations(JSONObject, Completion) - Method in class com.swirl.Config.Partner
loadPartners(Completion) - Method in class com.swirl.Config.User
loadPlacements(Completion) - Method in class com.swirl.Config.Partner
Location(JSONObject) - Constructor for class com.swirl.Config.Location
Location - Class in com.swirl: A Location represents a physical street, city, state address or real world location.
location - Variable in class com.swirl.Signal
LOCATION_ALLOW_GPS - Static variable in class com.swirl.Settings
LOCATION_DISTANCE_MAX - Static variable in class com.swirl.Settings
LOCATION_DISTANCE_MIN - Static variable in class com.swirl.Settings
LOCATION_EXTENDS_BACKGROUND - Static variable in class com.swirl.Settings
LOCATION_HISTORY - Static variable in class com.swirl.Settings
LOCATION_HISTORY_MAX - Static variable in class com.swirl.Settings
LOCATION_TIME_MAX - Static variable in class com.swirl.Settings
LOCATION_TIME_MIN - Static variable in class com.swirl.Settings
LocationChanged() - Constructor for class com.swirl.Swirl.LocationChanged
logEvent(String, String) - Method in class com.swirl.API
logEvent(String, String) - Method in class com.swirl.Swirl: Log event to the log stream.
login(String, String, Completion) - Static method in class com.swirl.Config.User

M

MainLoop - Class in com.swirl: MainLoop class provides accessors for Main Looper, Handler, Executor
MainLoop() - Constructor for class com.swirl.MainLoop
makeRequest(String, JSONObject, API.Completion) - Method in class com.swirl.API
makeRequest(String, HashMap<String, String>, byte[], API.Completion) - Method in class com.swirl.API
manager - Variable in class com.swirl.BeaconManager.BeaconEvent
manager - Variable in class com.swirl.ContentManager.ContentEvent
Manager - Class in com.swirl: Manager is the base class for all of the managers in the Swirl library.
Manager() - Constructor for class com.swirl.Manager
manager - Variable in class com.swirl.NearbyManager.NearbyMessage
manager - Variable in class com.swirl.RegionManager.RegionsChangedEvent
manager - Variable in class com.swirl.VisitManager.VisitEvent
manager - Variable in class com.swirl.WifiManager.WifiEvent
message - Variable in class com.swirl.Error
MESSAGE_TYPE_SWIRL - Static variable in class com.swirl.NearbyManager: The type string assigned to default 'swirl' attachements.
metadata - Static variable in class com.swirl.Config.BeaconConfiguration
MINUTES(long) - Static method in class com.swirl.Util

N

namespace - Variable in class com.swirl.NearbyManager.NearbyMessage
NearbyManager - Class in com.swirl: The NearbyManager uses the Nearby APIs to scan for beacons registered using the google beacon platform.
NearbyManager(Activity) - Constructor for class com.swirl.NearbyManager
NearbyManager.NearbyMessage - Class in com.swirl
NearbyMessage(Message, int) - Constructor for class com.swirl.NearbyManager.NearbyMessage
needsUpdate() - Method in class com.swirl.Config.Beacon
newPeripheral(BeaconAdvertisement) - Method in class com.swirl.BeaconScanner
NOTIFICATION_CHANNEL - Static variable in class com.swirl.Settings
NOTIFICATION_ICON - Static variable in class com.swirl.Settings
NOTIFICATIONS_BACKGROUND - Static variable in class com.swirl.Settings
NOTIFICATIONS_FOREGROUND - Static variable in class com.swirl.Settings
notifyForContent(Content) - Method in class com.swirl.ContentManager: Called to display a notification for content.

O

objectKeysWithPrefix(String) - Static method in class com.swirl.Settings
onBackPressed() - Method in class com.swirl.ContentActivity
onBeaconDwell(BeaconManager.BeaconDwellEvent) - Method in class com.swirl.SwirlListener
onBeaconEnter(BeaconManager.BeaconEnterEvent) - Method in class com.swirl.SwirlListener
onBeaconExit(BeaconManager.BeaconExitEvent) - Method in class com.swirl.SwirlListener
onBeaconNearest(BeaconManager.BeaconNearestEvent) - Method in class com.swirl.SwirlListener
onBeaconResolve(BeaconManager.BeaconResolveEvent) - Method in class com.swirl.SwirlListener
onBeginVisit(VisitManager.BeginVisitEvent) - Method in class com.swirl.ContentManager: This method is public for technical reasons.
onBeginVisit(VisitManager.BeginVisitEvent) - Method in class com.swirl.SwirlListener
onBeginVisit(VisitManager, Visit) - Method in class com.swirl.SwirlListener: Called when a Visit to a new Location and Placement is beginning.
onChangeNearestBeacon(BeaconManager, Beacon) - Method in class com.swirl.SwirlListener: Called when the mobile device changed the beacon it is closest to.
onConnected(Bundle) - Method in class com.swirl.NearbyManager
onConnectionFailed(ConnectionResult) - Method in class com.swirl.NearbyManager
onConnectionSuspended(int) - Method in class com.swirl.NearbyManager
onCreate(Bundle) - Method in class com.swirl.ContentActivity
onCreate() - Method in class com.swirl.Swirl.Service
onCreateOptionsMenu(Menu) - Method in class com.swirl.ContentActivity
onDestroy() - Method in class com.swirl.ContentActivity
onDestroy() - Method in class com.swirl.Swirl.Service
onDwellBeacon(BeaconManager, Beacon) - Method in class com.swirl.SwirlListener: Called when the mobile device is still within range of the beacon.
onDwellBeacon(BeaconManager.BeaconDwellEvent) - Method in class com.swirl.VisitManager
onDwellVisit(VisitManager.DwellVisitEvent) - Method in class com.swirl.ContentManager: This method is public for technical reasons.
onDwellVisit(VisitManager.DwellVisitEvent) - Method in class com.swirl.SwirlListener
onDwellVisit(VisitManager, Visit) - Method in class com.swirl.SwirlListener: Called periodically as a user remains in a current Location and Placement.
onDwellWifi(WifiManager.WifiDwellEvent) - Method in class com.swirl.VisitManager
onEndVisit(VisitManager.EndVisitEvent) - Method in class com.swirl.ContentManager: This method is public for technical reasons.
onEndVisit(VisitManager.EndVisitEvent) - Method in class com.swirl.SwirlListener
onEndVisit(VisitManager, Visit) - Method in class com.swirl.SwirlListener: Called when a Visit to a new Location and Placement has ended.
onEnterBeacon(BeaconManager, Beacon) - Method in class com.swirl.SwirlListener: Called when the mobile device is within range of the beacon.
onEnterBeacon(BeaconManager.BeaconEnterEvent) - Method in class com.swirl.VisitManager
onEnterExitRegions(RegionManager.RegionsChangedEvent) - Method in class com.swirl.VisitManager
onEnterWifi(WifiManager, WifiInfo) - Method in class com.swirl.SwirlListener: Called when an access point enter is detected for the connected wifi network.
onEnterWifi(WifiManager.WifiEnterEvent) - Method in class com.swirl.VisitManager
onError(Swirl.ErrorEvent) - Method in class com.swirl.SwirlListener
onError(int) - Method in class com.swirl.SwirlListener: Called when Swirl reports an error
onEvent(BeaconAdvertisement) - Method in class com.swirl.BeaconManager
onExitBeacon(BeaconManager, Beacon) - Method in class com.swirl.SwirlListener: Called when the mobile device left the range of the beacon.
onExitBeacon(BeaconManager.BeaconExitEvent) - Method in class com.swirl.VisitManager
onExitWifi(WifiManager, WifiInfo) - Method in class com.swirl.SwirlListener: Called when an access point exit is detected for the connected wifi network.
onExitWifi(WifiManager.WifiExitEvent) - Method in class com.swirl.VisitManager
onForeground(Swirl.ForegroundEvent) - Method in class com.swirl.ContentManager: This method is public for technical reasons.
onHandleWork(Intent) - Method in class com.swirl.Swirl.Service
onIntent(Intent) - Method in class com.swirl.ContentManager: This method is public for technical reasons.
onIntent(Intent) - Method in class com.swirl.NearbyManager
onLocationChange(Device.LocationChangedEvent) - Method in class com.swirl.RegionManager
onLocationChange(Device.LocationChangedEvent) - Method in class com.swirl.Swirl
onLocationChange(Device.LocationChangedEvent) - Method in class com.swirl.SwirlListener
onLocationChange(Location) - Method in class com.swirl.SwirlListener: Called when Swirl detects a location change event
onMessageReceived(RemoteMessage) - Method in class com.swirl.Fcm.Service
onNearbyMessage(NearbyManager.NearbyMessage) - Method in class com.swirl.SwirlListener
onNearbyMessage(NearbyManager, String, String, byte[], int) - Method in class com.swirl.SwirlListener: Call whenever the NearbyManager posts a nearby related message.
onNewIntent(Intent) - Method in class com.swirl.ContentActivity
onOptionsItemSelected(MenuItem) - Method in class com.swirl.ContentActivity
onPermissionsChanged(Device.PermissionsChangedEvent) - Method in class com.swirl.BeaconScanner
onPermissionsChanged(Device.PermissionsChangedEvent) - Method in class com.swirl.RegionManager
onPrepareOptionsMenu(Menu) - Method in class com.swirl.ContentActivity
onReceive(Context, Intent) - Method in class com.swirl.Gcm.Receiver
onReceive(Context, Intent) - Method in class com.swirl.Swirl.Receiver
onReceiveContent(Content) - Method in class com.swirl.ContentManager
onReceiveContentCustom(Content) - Method in class com.swirl.ContentManager: Called when content of type Custom is received.
onReceiveContentCustom(ContentManager.ReceiveContentCustomEvent) - Method in class com.swirl.SwirlListener
onReceiveContentCustom(ContentManager, Content, Completion) - Method in class com.swirl.SwirlListener: Called when content of type Custom is received.
onReceiveContentURL(Content) - Method in class com.swirl.ContentManager: Called when content of type URL is received.
onReceiveContentURL(ContentManager.ReceiveContentURLEvent) - Method in class com.swirl.SwirlListener
onReceiveContentURL(ContentManager, Content) - Method in class com.swirl.SwirlListener: Called when content of type URL is received.
onReceiveContentView(Content) - Method in class com.swirl.ContentManager: Called when content of type Swirl is received.
onReceiveContentView(ContentManager.ReceiveContentViewEvent) - Method in class com.swirl.SwirlListener
onReceiveContentView(ContentManager, Content) - Method in class com.swirl.SwirlListener: Called when content of type Swirl is received.
onRegionsChanged(RegionManager.RegionsChangedEvent) - Method in class com.swirl.BeaconScanner
onRegionsChanged(RegionManager.RegionsChangedEvent) - Method in class com.swirl.SwirlListener
onRegionsChanged(RegionManager, Set<Region>, Set<Region>) - Method in class com.swirl.SwirlListener: Called whenever the set of entered and/or exited regions changes.
onResolveBeacon(BeaconManager, Beacon) - Method in class com.swirl.SwirlListener: Called when the detected beacon is resolved by the server.
onStart() - Method in class com.swirl.ContentActivity
onStarted(Swirl.StartedEvent) - Method in class com.swirl.SwirlListener
onStarted() - Method in class com.swirl.SwirlListener: Called when Swirl is started without error
onStatusChange(Swirl.StatusChangedEvent) - Method in class com.swirl.SwirlListener
onStatusChange(int) - Method in class com.swirl.SwirlListener: Called when Swirl status changes.
onStop() - Method in class com.swirl.ContentActivity
onStopCurrentWork() - Method in class com.swirl.Swirl.Service
onWifiChanged(Device.WifiChangedEvent) - Method in class com.swirl.WifiManager
onWifiEnter(WifiManager.WifiEnterEvent) - Method in class com.swirl.SwirlListener
onWifiEnter(WifiManager.WifiExitEvent) - Method in class com.swirl.SwirlListener

P

parseIdentifier(String) - Static method in class com.swirl.BeaconAdvertisement: Returns a parsed urn identifier
Partner(JSONObject) - Constructor for class com.swirl.Config.Partner
PARTNER_NAME - Static variable in class com.swirl.API
Peripheral - Class in com.swirl: Object for discovering, reading, writing to a bluetooth peripheral
Peripheral(Context, BluetoothDevice) - Constructor for class com.swirl.Peripheral
permissionsChanged() - Method in class com.swirl.Swirl: Informs the SDK that the user has changed permissions and to re-initialize things that depend on dynamic permissions
ping() - Method in class com.swirl.API
Placement - Class in com.swirl: A Placement is a logical area within a Location.
Placement(JSONObject) - Constructor for class com.swirl.Placement
post(Object) - Method in class com.swirl.EventBus: Post an event or object onto the bus.
post(Object) - Method in class com.swirl.Swirl: Post an object to the internal message bus.
postCreateBeacon(Config.Beacon, Beacon, Completion) - Method in class com.swirl.Config.BeaconHandler
POWER_MODE_ACTIVE - Static variable in class com.swirl.Settings
POWER_MODE_AUTO - Static variable in class com.swirl.Settings
POWER_MODE_BALANCED - Static variable in class com.swirl.Settings
POWER_MODE_LOW - Static variable in class com.swirl.Settings
processDeferred() - Method in class com.swirl.API
progress(int, double) - Method in class com.swirl.Completion
properties - Variable in class com.swirl.Attachment
properties - Variable in class com.swirl.SObject
PROTOCOL_EDDYSTONE_EID - Static variable in class com.swirl.BeaconAdvertisement
PROTOCOL_EDDYSTONE_UID - Static variable in class com.swirl.BeaconAdvertisement
PROTOCOL_EDDYSTONE_URL - Static variable in class com.swirl.BeaconAdvertisement
PROTOCOL_GENERIC - Static variable in class com.swirl.BeaconAdvertisement
PROTOCOL_IBEACON - Static variable in class com.swirl.BeaconAdvertisement
PROTOCOL_KONTAKT - Static variable in class com.swirl.BeaconAdvertisement
PROTOCOL_SECURECAST - Static variable in class com.swirl.BeaconAdvertisement
PROTOCOL_SWIRL - Static variable in class com.swirl.BeaconAdvertisement
PROTOCOL_UNKNOWN - Static variable in class com.swirl.BeaconAdvertisement
put(String, Object) - Static method in class com.swirl.Settings
putAll(JSONObject) - Static method in class com.swirl.Settings
putAll(Bundle) - Static method in class com.swirl.Settings
putAll(JSONObject, JSONObject) - Static method in class com.swirl.Util
putArray(String, JSONArray) - Static method in class com.swirl.Settings
putArrayList(String, ArrayList<Object>) - Static method in class com.swirl.Settings
putBoolean(String, boolean) - Static method in class com.swirl.Settings
putDefaults(JSONObject) - Static method in class com.swirl.Settings
putDouble(String, double) - Static method in class com.swirl.Settings
putImage(String, Bitmap) - Static method in class com.swirl.Settings
putInt(String, int) - Static method in class com.swirl.Settings
putLong(String, long) - Static method in class com.swirl.Settings
putObject(String, JSONObject) - Static method in class com.swirl.Settings
putString(String, String) - Static method in class com.swirl.Settings
putStringArray(String, String[], boolean) - Static method in class com.swirl.Settings

R

radius - Variable in class com.swirl.Config.ImageMarker: Radius as a proportion of the image height
randomString(int) - Static method in class com.swirl.Util
readCharacteristic(BluetoothGattCharacteristic, long, Completion) - Method in class com.swirl.Peripheral
readCharacteristic(String, long, Completion) - Method in class com.swirl.Peripheral
readCharacteristics(String[], long, Completion) - Method in class com.swirl.Peripheral
ReceiveContentCustomEvent(Content, Completion) - Constructor for class com.swirl.ContentManager.ReceiveContentCustomEvent
ReceiveContentURLEvent(Content) - Constructor for class com.swirl.ContentManager.ReceiveContentURLEvent
ReceiveContentViewEvent(Content) - Constructor for class com.swirl.ContentManager.ReceiveContentViewEvent
Receiver() - Constructor for class com.swirl.Gcm.Receiver
Receiver() - Constructor for class com.swirl.Swirl.Receiver
recentVisit() - Method in class com.swirl.VisitManager: Return the most recently active visit.
Region - Class in com.swirl: 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.
Region(JSONObject) - Constructor for class com.swirl.Region
RegionManager - Class in com.swirl: 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.
RegionManager.RegionsChangedEvent - Class in com.swirl: A RegionsChangedEvent is generated whenever the RegionManager determines the set of entered or exited regions to have changed based on a location change.
regions(double, double, API.Completion) - Method in class com.swirl.API
RegionsChangedEvent(Set<Region>, Set<Region>, boolean) - Constructor for class com.swirl.RegionManager.RegionsChangedEvent
remove(String) - Static method in class com.swirl.Settings
removeContent() - Method in class com.swirl.ContentActivity
removeHistory() - Method in class com.swirl.ContentActivity
removeListener(Object) - Method in class com.swirl.EventBus: Remove a listener from the bus provided it is already a listener.
removeListener(Object) - Method in class com.swirl.Swirl: Remove a listener that had been previously added via addListener().
removeObject(String) - Static method in class com.swirl.Settings
requestConnectionPriority() - Method in class com.swirl.Peripheral
requestContentPreview(String, SafeRunnable) - Method in class com.swirl.ContentManager: Force a request for content with a preview code.
requestMtu(int) - Method in class com.swirl.Peripheral
reset() - Method in class com.swirl.API
reset() - Static method in class com.swirl.Settings
reset() - Method in class com.swirl.Swirl: Removes all locally stored data and state.
resume() - Method in class com.swirl.EventBus: Resume delivery of events.
ROLE_BEACON_MANAGER_READ - Static variable in class com.swirl.Config.User
ROLE_BEACON_MANAGER_WRITE - Static variable in class com.swirl.Config.User
rssi - Variable in class com.swirl.BeaconAdvertisement: An RSSI value as reported by the operating system.
rssi - Variable in class com.swirl.NearbyManager.NearbyMessage
run() - Method in class com.swirl.Completion
run(Runnable) - Static method in class com.swirl.MainLoop
run() - Method in class com.swirl.SafeRunnable

S

safeRun() - Method in class com.swirl.SafeRunnable
SafeRunnable - Class in com.swirl: Created by Tom on 8/3/16.
SafeRunnable() - Constructor for class com.swirl.SafeRunnable
safeRunThrows() - Method in class com.swirl.SafeRunnable
SCAN_MODE_ALWAYS - Static variable in class com.swirl.Settings
SCAN_MODE_INUSE - Static variable in class com.swirl.Settings
SCAN_MODE_MANUAL - Static variable in class com.swirl.Settings
SCAN_MODE_NONE - Static variable in class com.swirl.Settings
SCAN_MODE_REGION - Static variable in class com.swirl.Settings
SECONDS(long) - Static method in class com.swirl.Util
SECS_PER_DAY - Static variable in class com.swirl.Util
SECS_PER_HOUR - Static variable in class com.swirl.Util
SECS_PER_MINUTE - Static variable in class com.swirl.Util
SECS_PER_WEEK - Static variable in class com.swirl.Util
SECURECAST_UUID - Static variable in class com.swirl.BeaconAdvertisement: A Bluetooth standard UUID representing the SecureCast Service.
Service() - Constructor for class com.swirl.Fcm.Service
Service() - Constructor for class com.swirl.Swirl.Service
service - Static variable in class com.swirl.Swirl.Service
setActivity(Activity) - Method in class com.swirl.NearbyManager: Nearby API's need to have an activity context in order to function, this can be called to provide a valid context whenever it is available or changes
setBackgroundMode(boolean) - Static method in class com.swirl.Settings
setBackgroundMode(boolean) - Method in class com.swirl.Swirl: Sets the current operating mode to foreground or background.
setBeaconHandlerForManufacturer(Config.BeaconHandler, String) - Static method in class com.swirl.Config
setCharacteristicNotification(BluetoothGattCharacteristic, boolean, Completion, Completion) - Method in class com.swirl.Peripheral
setCharacteristicNotification(String, boolean, Completion, Completion) - Method in class com.swirl.Peripheral
setConnectionPriority(int, long, long) - Method in class com.swirl.Peripheral
setConnectionPriority(int) - Method in class com.swirl.Peripheral
setData(Object) - Method in class com.swirl.Completion
setError(int) - Method in class com.swirl.Completion
setError(int) - Method in class com.swirl.Signal: Set the error for this signal or 0 to clear any error condition.
setException(Throwable) - Method in class com.swirl.Completion
setExecutor(Executor) - Method in class com.swirl.Completion
setFarImage(Bitmap) - Method in class com.swirl.Config.Beacon: Associates a far image with a beacon and optional marker
setFarImageMarker(Config.ImageMarker) - Method in class com.swirl.Config.Beacon: Set an image marker for the far image
setFilter(MessageFilter.Builder) - Method in class com.swirl.NearbyManager: Override the internal default message filters and supply your own.
setFirmware(Config.Firmware) - Method in class com.swirl.Config.Beacon: Set the firmware for this beacon.
setFloorplanLocation(Config.Floorplan, Config.ImageMarker) - Method in class com.swirl.Config.Beacon: Sets the floorplan location (pin) for the beacon
setLabel(String) - Method in class com.swirl.Completion
setLastDetected(long) - Method in class com.swirl.Region
setLocation(Config.Location) - Method in class com.swirl.Config.Beacon: Sets the new location for the beacon.
setMenuIconColors(Menu, int) - Static method in class com.swirl.Util
setNearImage(Bitmap) - Method in class com.swirl.Config.Beacon: Associates a near image with a beacon and optional marker
setNearImageMarker(Config.ImageMarker) - Method in class com.swirl.Config.Beacon: Set an image marker for the near image
setOptions(Bundle) - Method in class com.swirl.Swirl: Pushes a bundle of property value pairs into Settings.
setPlacement(Placement) - Method in class com.swirl.Config.Beacon: Set the current placement for the beacon
setProperties(JSONObject) - Method in class com.swirl.SObject
setRssiParams(JSONObject) - Method in class com.swirl.Beacon: Set a custom RSSI params to control RSSI smoothing opt_sample_age - optimal seconds to average over max_sample_age - maximum seconds to average over if less than min samples min_samples - minimum number of samples to require
setServerConfigurationState(JSONObject) - Method in class com.swirl.Config.Beacon
SETTING_RESET_TIME - Static variable in class com.swirl.Settings
settings(API.Completion) - Method in class com.swirl.API
Settings - Class in com.swirl: Settings
Settings() - Constructor for class com.swirl.Settings
setToolbarForegroundColor(Toolbar, int) - Static method in class com.swirl.Util
setUserInfo(JSONObject) - Method in class com.swirl.API
setUserInfo(JSONObject) - Method in class com.swirl.Swirl: Set the currently store user attributes
SHA1(String) - Static method in class com.swirl.Util
SHA256(byte[]) - Static method in class com.swirl.Util
SHA256(String) - Static method in class com.swirl.Util
shareProvider - Variable in class com.swirl.ContentActivity
shouldNotifyForContent(Content, Notification) - Method in class com.swirl.ContentManager: Called before a notification is presented.
shouldNotifyForContent(Content, Completion) - Method in class com.swirl.ContentManager: Called before a notification is generated (async).
shouldStartContentURLActivity(Content, Intent) - Method in class com.swirl.ContentManager: Called before CONTENT_TYPE_URL content is activated.
shouldStartContentViewActivity(Content, Intent) - Method in class com.swirl.ContentManager: Called before CONTENT_TYPE_SWIRL content is activated.
SHOW_CONTENT_TOAST - Static variable in class com.swirl.Settings
showContent() - Method in class com.swirl.ContentActivity
showHistory() - Method in class com.swirl.ContentActivity
showToastForContent(Content) - Method in class com.swirl.ContentManager
Signal - Class in com.swirl: Signal is the abstract base class for signal objects: beacon, wifi network, region.
Signal(JSONObject, String) - Constructor for class com.swirl.Signal
SObject - Class in com.swirl: SObject is the base class for all Swirl platform objects.
SObject(JSONObject) - Constructor for class com.swirl.SObject
squelch(BeaconAdvertisement, long) - Method in class com.swirl.BeaconScanner
start(Bundle, API.Completion) - Method in class com.swirl.API
start() - Method in class com.swirl.BeaconManager: This is called by the system when started.
start() - Method in class com.swirl.BeaconScanner
start() - Method in class com.swirl.ContentManager
start() - Method in class com.swirl.NearbyManager: This is called by the system when started or when a manager is added to a started system.
start() - Method in class com.swirl.RegionManager
start(Context) - Static method in class com.swirl.Swirl.Service
start(Bundle) - Method in class com.swirl.Swirl: Starts the sdk and all loaded managers.
start() - Method in class com.swirl.VisitManager
start() - Method in class com.swirl.WifiManager
startContentViewActivity() - Method in class com.swirl.ContentManager: Forces the a call to startActivity on the ContentActivity.
StartedEvent() - Constructor for class com.swirl.Swirl.StartedEvent
startScanning() - Method in class com.swirl.BeaconScanner
STATE_INSIDE - Static variable in class com.swirl.Beacon: This value indicates that there are valid advertisements to compute a range and the BeaconManager has determined that the beacon is within the specified range.
STATE_OUTSIDE - Static variable in class com.swirl.Beacon: This value indicates that there are valid advertisements to compute a range and the BeaconManager has determined that the beacon is outside of the specified range.
STATE_UNKNOWN - Static variable in class com.swirl.Beacon: This value indicates that there are not enough recent advertisements to compute a state.
STATUS_BLUETOOTH - Static variable in class com.swirl.Swirl: If this bit is set, Bluetooth Services are available.
STATUS_DEVICE_MASK - Static variable in class com.swirl.Swirl: A bit mask for accessing device status portion
STATUS_ERROR - Static variable in class com.swirl.Swirl: If this bit is set, the system has reported an error, which is available in the error property.
STATUS_LOCATION - Static variable in class com.swirl.Swirl: If this bit is set, Location Services are authorized.
STATUS_NETWORK - Static variable in class com.swirl.Swirl: If this bit is set, Network Services are available.
STATUS_NONE - Static variable in class com.swirl.Swirl: This value indicates that the system is not running.
STATUS_NOTIFICATIONS - Static variable in class com.swirl.Swirl: If this bit is set, Notifications are enabled.
STATUS_PENDING - Static variable in class com.swirl.Swirl: If this bit is set, the system is transitioning from Stopped to Running or the reverse.
STATUS_RUNNING - Static variable in class com.swirl.Swirl: If this bit is set, the system is either Running or if Pending is also set, Stopping.
STATUS_SWIRL_MASK - Static variable in class com.swirl.Swirl: A bit mask for accessing Swirl status portion
StatusChangedEvent(int) - Constructor for class com.swirl.Swirl.StatusChangedEvent
stop() - Method in class com.swirl.BeaconManager: This is called by the system when stopped.
stop() - Method in class com.swirl.BeaconScanner
stop() - Method in class com.swirl.ContentManager
stop() - Method in class com.swirl.NearbyManager: This is called by the system when stopped.
stop() - Method in class com.swirl.RegionManager
stop(Context) - Static method in class com.swirl.Swirl.Service
stop() - Method in class com.swirl.Swirl: Stops the sdk.
stop() - Method in class com.swirl.VisitManager
stop() - Method in class com.swirl.WifiManager
stopScanning() - Method in class com.swirl.BeaconScanner
streamEvents() - Method in class com.swirl.Location: True if event streaming is enabled for this location
streamMessage(JSONObject) - Method in class com.swirl.Swirl: Publish a message to the live event stream.
stringArray(JSONArray) - Static method in class com.swirl.Util
stringArray(String, String) - Static method in class com.swirl.Util
stringArray(Object) - Static method in class com.swirl.Util
suspend() - Method in class com.swirl.EventBus: Temporarily suspend event delivery.
Swirl - Class in com.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 - Class in com.swirl: Event sent when the application goes into the background.
Swirl.DeviceChanged - Class in com.swirl: A subclass of Receiver for device related events.
Swirl.ErrorEvent - Class in com.swirl: Event sent when Swirl reports an error
Swirl.ForegroundEvent - Class in com.swirl: Event sent when the application comes into the foreground.
Swirl.LocationChanged - Class in com.swirl: A subclass of Receiver for location related events.
Swirl.Receiver - Class in com.swirl: Base class for all BroadcastReceivers.
Swirl.Service - Class in com.swirl: 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 - Class in com.swirl: Event sent when Swirl started without error.
Swirl.StatusChangedEvent - Class in com.swirl: Event sent when Swirl status changes.
SwirlListener - Class in com.swirl: SwirlListener is a convenience class created to facilitate intercepting events on the eventBus.
SwirlListener() - Constructor for class com.swirl.SwirlListener

T

timestamp - Variable in class com.swirl.NearbyManager.NearbyMessage
timestamp(long) - Static method in class com.swirl.Util
timestamp() - Static method in class com.swirl.Util
timestamp_RFC339(long) - Static method in class com.swirl.Util
timestamp_RFC339() - Static method in class com.swirl.Util
toBase64(Object) - Static method in class com.swirl.Util
toBoolean(Object) - Static method in class com.swirl.Util
toBytes(InputStream) - Static method in class com.swirl.Util
toBytesFromHex(String) - Static method in class com.swirl.Util
toHexDump(byte[], int) - Static method in class com.swirl.Util
toHexString(byte[], int, int) - Static method in class com.swirl.Util
toHexString(byte[]) - Static method in class com.swirl.Util
toJSON() - Method in class com.swirl.Content: Convert the Content object to a JSONObject
toJSON(Bundle, String) - Static method in class com.swirl.Util
toJSON(Bundle) - Static method in class com.swirl.Util
toJSON(Object...) - Static method in class com.swirl.Util
toString() - Method in class com.swirl.Beacon
toString() - Method in class com.swirl.BeaconAdvertisement
toString() - Method in class com.swirl.Config.Beacon
toString() - Method in class com.swirl.Content
toString() - Method in class com.swirl.Error
toString() - Method in class com.swirl.Location
toString() - Method in class com.swirl.Placement
toString() - Method in class com.swirl.Region
toString(InputStream) - Static method in class com.swirl.Util
toString(Bundle) - Static method in class com.swirl.Util
toString(Object) - Static method in class com.swirl.Util
toString() - Method in class com.swirl.Visit
toString() - Method in class com.swirl.WifiInfo
tryClose(Closeable) - Static method in class com.swirl.Util
tryJSON(String, JSONObject) - Static method in class com.swirl.Util
tryJSON(String) - Static method in class com.swirl.Util
tryJSONArray(String) - Static method in class com.swirl.Util
trySleep(long) - Static method in class com.swirl.Util
tryUri(String) - Static method in class com.swirl.Util
tryURI(String) - Static method in class com.swirl.Util
ts(long) - Static method in class com.swirl.Util
ts() - Static method in class com.swirl.Util
type - Variable in class com.swirl.NearbyManager.NearbyMessage
TYPE_BEACON - Static variable in class com.swirl.Signal
TYPE_GEOFENCE - Static variable in class com.swirl.Signal
TYPE_WIFI - Static variable in class com.swirl.Signal

U

uniquePrefix() - Method in class com.swirl.BeaconAdvertisement
uniquePrefix(String) - Static method in class com.swirl.BeaconAdvertisement
unlockBeacon(Beacon, Completion) - Method in class com.swirl.Config.BeaconHandler
UPDATING_CONFIGURATION - Static variable in class com.swirl.Config
UPDATING_FIRMWARE - Static variable in class com.swirl.Config
UPDATING_FLOORPLAN - Static variable in class com.swirl.Config
UPDATING_IMAGES - Static variable in class com.swirl.Config
UPDATING_PLACEMENT - Static variable in class com.swirl.Config
uploadImage(String, Bitmap, API.Completion) - Method in class com.swirl.API
USE_LOCATION - Static variable in class com.swirl.Settings
USE_WIFI_NAME_FILTER - Static variable in class com.swirl.Settings
User(JSONObject) - Constructor for class com.swirl.Config.User
USER_INFO - Static variable in class com.swirl.Settings
USER_KEY - Static variable in class com.swirl.Settings
Util - Class in com.swirl
Util() - Constructor for class com.swirl.Util

V

Visit - Class in com.swirl: A Visit object encapsulates information about places that the user has been.
Visit(Location, Visit) - Constructor for class com.swirl.Visit
visit - Variable in class com.swirl.VisitManager.VisitEvent
VisitEvent(Visit) - Constructor for class com.swirl.VisitManager.VisitEvent
VisitManager - Class in com.swirl: 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.
VisitManager() - Constructor for class com.swirl.VisitManager
VisitManager.BeginVisitEvent - Class in com.swirl: This event is posted when a visit begins.
VisitManager.DwellVisitEvent - Class in com.swirl: This event is posted periodically as a visit continues.
VisitManager.EndVisitEvent - Class in com.swirl: This event is posted when a visit ends.
VisitManager.VisitEvent - Class in com.swirl: VisitEvent is the base class for all VisitManager events.

W

wifi(String, int, API.Completion) - Method in class com.swirl.API
wifi - Variable in class com.swirl.WifiManager.WifiEvent
WIFI_NAME_FILTER - Static variable in class com.swirl.Settings
WifiDwellEvent(WifiInfo) - Constructor for class com.swirl.WifiManager.WifiDwellEvent
WifiEnterEvent(WifiInfo) - Constructor for class com.swirl.WifiManager.WifiEnterEvent
WifiEvent(WifiInfo) - Constructor for class com.swirl.WifiManager.WifiEvent
WifiExitEvent(WifiInfo) - Constructor for class com.swirl.WifiManager.WifiExitEvent
WifiInfo - Class in com.swirl: A WifiInfo represents a wifi network access point and represents a Signal object of TYPE_WIFI.
WifiManager - Class in com.swirl: The WifiManager monitors the state of wifi networks and is notified by the operating system when the user changes his wifi connection.
WifiManager() - Constructor for class com.swirl.WifiManager
WifiManager.WifiDwellEvent - Class in com.swirl: This event is posted as the device is dwelling in a given AP
WifiManager.WifiEnterEvent - Class in com.swirl: This event is posted when a monitored network is entered.
WifiManager.WifiEvent - Class in com.swirl: WifiEvent is the base class for all events posted by the WifiManager.
WifiManager.WifiExitEvent - Class in com.swirl: This event is posted when a monitored network is exited.
writeCharacteristic(BluetoothGattCharacteristic, byte[], long, Completion) - Method in class com.swirl.Peripheral
writeCharacteristic(String, byte[], long, Completion) - Method in class com.swirl.Peripheral
writeCharacteristics(List<JSONObject>, long, Completion) - Method in class com.swirl.Peripheral

X

x - Variable in class com.swirl.Config.ImageMarker: X position as a proportion of the image width

Y

y - Variable in class com.swirl.Config.ImageMarker: Y position as a proportion of the image height

A B C D E F G H I J K L M N O P R S T U V W X Y