A B C D E F G H I L M N O P R S T U V W
All Classes All Packages

A

addBeacon(Beacon) - Method in class org.altbeacon.beacon.service.RangeState

addExtraDataParser(BeaconParser) - Method in class org.altbeacon.beacon.BeaconParser

Adds a BeaconParser used for parsing extra BLE beacon advertisement packets for beacons that send multiple different advertisement packets (for example, Eddystone-TLM)

addLocalRegion(Region) - Method in class org.altbeacon.beacon.service.MonitoringStatus

addMeasurement(Integer) - Method in class org.altbeacon.beacon.service.ArmaRssiFilter

addMeasurement(Integer) - Method in class org.altbeacon.beacon.service.RangedBeacon

addMeasurement(Integer) - Method in interface org.altbeacon.beacon.service.RssiFilter

addMeasurement(Integer) - Method in class org.altbeacon.beacon.service.RunningAverageRssiFilter

addMonitorNotifier(MonitorNotifier) - Method in class org.altbeacon.beacon.BeaconManager

Specifies a class that should be called each time the BeaconService sees or stops seeing a Region of beacons.

addRangeNotifier(RangeNotifier) - Method in class org.altbeacon.beacon.BeaconManager

Specifies a class that should be called each time the BeaconService gets ranging data, which is nominally once per second when beacons are detected.

addRegion(Region) - Method in class org.altbeacon.beacon.startup.RegionBootstrap

Add a new region

addRegion(Region, Callback) - Method in class org.altbeacon.beacon.service.MonitoringStatus

AltBeacon - Class in org.altbeacon.beacon

The AltBeacon class represents a single hardware AltBeacon detected by an Android device.

AltBeacon() - Constructor for class org.altbeacon.beacon.AltBeacon

AltBeacon(Parcel) - Constructor for class org.altbeacon.beacon.AltBeacon

Required for making object Parcelable

AltBeacon(Beacon) - Constructor for class org.altbeacon.beacon.AltBeacon

Copy constructor from base class

ALTBEACON_LAYOUT - Static variable in class org.altbeacon.beacon.BeaconParser

AltBeacon.Builder - Class in org.altbeacon.beacon

Builder class for AltBeacon objects.

AltBeaconParser - Class in org.altbeacon.beacon

A specific beacon parser designed to parse only AltBeacons from raw BLE packets detected by Android.

AltBeaconParser() - Constructor for class org.altbeacon.beacon.AltBeaconParser

Constructs an AltBeacon Parser and sets its layout

ANDROID_N_MAX_SCAN_DURATION_MILLIS - Static variable in class org.altbeacon.beacon.service.scanner.CycledLeScanner

AndroidModel - Class in org.altbeacon.beacon.distance

Represents a specific Android device model based on the available device build information Created by dyoung on 8/28/14.

AndroidModel(String, String, String, String) - Constructor for class org.altbeacon.beacon.distance.AndroidModel

apply(BeaconService) - Method in class org.altbeacon.beacon.service.SettingsData

applyChanges(BeaconManager) - Method in class org.altbeacon.beacon.service.ScanState

applySettings() - Method in class org.altbeacon.beacon.BeaconManager

Call this method if you are running the scanner service in a different process in order to synchronize any configuration settings, including BeaconParsers to the scanner

applySettingsToScheduledJob(Context, BeaconManager) - Method in class org.altbeacon.beacon.service.ScanJobScheduler

ArmaRssiFilter - Class in org.altbeacon.beacon.service

This filter calculates its rssi on base of an auto regressive moving average (ARMA) It needs only the current value to do this; the general formula is n(t) = n(t-1) - c * (n(t-1) - n(t)) where c is a coefficient, that denotes the smoothness - the lower the value, the smoother the average Note: a smoother average needs longer to "settle down" Note: For signals, that change rather frequently (say, 1Hz or faster) and tend to vary more a recommended value would be 0,1 (that means the actual value is changed by 10% of the difference between the actual measurement and the actual average) For signals at lower rates (10Hz) a value of 0.25 to 0.5 would be appropriate

ArmaRssiFilter() - Constructor for class org.altbeacon.beacon.service.ArmaRssiFilter

B

BackgroundPowerSaver - Class in org.altbeacon.beacon.powersave

Simply creating an instance of this class and holding a reference to it in your Application can improve battery life by 60% by slowing down scans when your app is in the background.

BackgroundPowerSaver(Context) - Constructor for class org.altbeacon.beacon.powersave.BackgroundPowerSaver

Constructs a new BackgroundPowerSaver using the default background determination strategy

BackgroundPowerSaver(Context, boolean) - Constructor for class org.altbeacon.beacon.powersave.BackgroundPowerSaver

Deprecated.

the countActiveActivityStrategy flag is no longer used. Use BackgroundPowerSaver(Context)

Beacon - Class in org.altbeacon.beacon

The Beacon class represents a single hardware Beacon detected by an Android device.

Beacon() - Constructor for class org.altbeacon.beacon.Beacon

Basic constructor that simply allocates fields

Beacon(Parcel) - Constructor for class org.altbeacon.beacon.Beacon

Deprecated.

Beacon(Beacon) - Constructor for class org.altbeacon.beacon.Beacon

Copy constructor

Beacon.Builder - Class in org.altbeacon.beacon

Builder class for Beacon objects.

BeaconBinder() - Constructor for class org.altbeacon.beacon.service.BeaconService.BeaconBinder

BeaconConsumer - Interface in org.altbeacon.beacon

An interface for an Android Activity or Service that wants to interact with beacons.

BeaconData - Interface in org.altbeacon.beacon

Server-side data associated with a beacon.

beaconDataFactory - Static variable in class org.altbeacon.beacon.Beacon

Used to attach data to individual Beacons, either locally or in the cloud

BeaconDataFactory - Interface in org.altbeacon.beacon.client

This can be configured for the public beacon data store, or a private beacon data store.

BeaconDataNotifier - Interface in org.altbeacon.beacon

Notifies when server-side beacon data are available from a web service.

beaconDataUpdate(Beacon, BeaconData, DataProviderException) - Method in interface org.altbeacon.beacon.BeaconDataNotifier

This method is called after a request to get or sync beacon data If fetching data was successful, the data is returned and the exception is null.

BeaconIntentProcessor - Class in org.altbeacon.beacon

Converts internal intents to notifier callbacks This is used with the BeaconService and supports scanning in a separate process.

BeaconIntentProcessor() - Constructor for class org.altbeacon.beacon.BeaconIntentProcessor

BeaconLayoutException(String) - Constructor for exception org.altbeacon.beacon.BeaconParser.BeaconLayoutException

BeaconLocalBroadcastProcessor - Class in org.altbeacon.beacon

Converts internal intents to notifier callbacks This is used with ScanJob and supports delivering intents even under Android O background restrictions preventing starting a new IntentService.

BeaconLocalBroadcastProcessor(Context) - Constructor for class org.altbeacon.beacon.BeaconLocalBroadcastProcessor

BeaconManager - Class in org.altbeacon.beacon

A class used to set up interaction with beacons from an Activity or Service.

BeaconManager(Context) - Constructor for class org.altbeacon.beacon.BeaconManager

BeaconManager.ServiceNotDeclaredException - Exception in org.altbeacon.beacon

BeaconParser - Class in org.altbeacon.beacon

Created by dyoung on 7/21/14.

BeaconParser() - Constructor for class org.altbeacon.beacon.BeaconParser

Makes a new BeaconParser.

BeaconParser(String) - Constructor for class org.altbeacon.beacon.BeaconParser

Makes a new BeaconParser with an identifier that can be used to identify beacons decoded with this parser

BeaconParser.BeaconLayoutException - Exception in org.altbeacon.beacon

beacons - Variable in class org.altbeacon.beacon.simulator.StaticBeaconSimulator

BeaconService - Class in org.altbeacon.beacon.service

BeaconService() - Constructor for class org.altbeacon.beacon.service.BeaconService

BeaconService.BeaconBinder - Class in org.altbeacon.beacon.service

Class used for the client Binder.

beaconSimulator - Static variable in class org.altbeacon.beacon.BeaconManager

BeaconSimulator - Interface in org.altbeacon.beacon.simulator

Created by dyoung on 4/18/14.

BeaconTransmitter - Class in org.altbeacon.beacon

Provides a mechanism for transmitting as a beacon.

BeaconTransmitter(Context, BeaconParser) - Constructor for class org.altbeacon.beacon.BeaconTransmitter

Creates a new beacon transmitter capable of transmitting beacons with the format specified in the BeaconParser and with the data fields specified in the Beacon object

bind(BeaconConsumer) - Method in class org.altbeacon.beacon.BeaconManager

Binds an Android Activity or Service to the BeaconService.

bindService(Intent, ServiceConnection, int) - Method in interface org.altbeacon.beacon.BeaconConsumer

Called by the BeaconManager to bind your BeaconConsumer to the BeaconService.

BleAdvertisement - Class in org.altbeacon.bluetooth

Parses a byte array representing a BLE advertisement into a number of "Payload Data Units" (PDUs).

BleAdvertisement(byte[]) - Constructor for class org.altbeacon.bluetooth.BleAdvertisement

BleNotAvailableException - Exception in org.altbeacon.beacon

Indicates that Bluetooth Low Energy is not available on this device

BleNotAvailableException(String) - Constructor for exception org.altbeacon.beacon.BleNotAvailableException

BluetoothCrashResolver - Class in org.altbeacon.bluetooth

This class provides relief for Android Bug 67272.

BluetoothCrashResolver(Context) - Constructor for class org.altbeacon.bluetooth.BluetoothCrashResolver

Constructor should be called only once per long-running process that does Bluetooth LE scanning.

BluetoothCrashResolver.UpdateNotifier - Interface in org.altbeacon.bluetooth

BluetoothMedic - Class in org.altbeacon.bluetooth

Utility class for checking the health of the bluetooth stack on the device by running two kinds of tests: scanning and transmitting.

BluetoothTestJob - Class in org.altbeacon.bluetooth

BluetoothTestJob() - Constructor for class org.altbeacon.bluetooth.BluetoothTestJob

BootstrapNotifier - Interface in org.altbeacon.beacon.startup

build() - Method in class org.altbeacon.beacon.AltBeacon.Builder

build() - Method in class org.altbeacon.beacon.Beacon.Builder

Builds an instance of this beacon based on parameters set in the Builder

Builder() - Constructor for class org.altbeacon.beacon.AltBeacon.Builder

Builder() - Constructor for class org.altbeacon.beacon.Beacon.Builder

Creates a builder instance

bytesToHex(byte[]) - Static method in class org.altbeacon.beacon.BeaconParser

C

calculateDistance(int, double) - Static method in class org.altbeacon.beacon.Beacon

Estimate the distance to the beacon using the DistanceCalculator set on this class.

calculateDistance(int, double) - Method in class org.altbeacon.beacon.distance.CurveFittedDistanceCalculator

Calculated the estimated distance in meters to the beacon based on a reference rssi at 1m and the known actual rssi at the current location

calculateDistance(int, double) - Method in interface org.altbeacon.beacon.distance.DistanceCalculator

calculateDistance(int, double) - Method in class org.altbeacon.beacon.distance.ModelSpecificDistanceCalculator

calculateRssi() - Method in class org.altbeacon.beacon.service.ArmaRssiFilter

calculateRssi() - Method in interface org.altbeacon.beacon.service.RssiFilter

calculateRssi() - Method in class org.altbeacon.beacon.service.RunningAverageRssiFilter

call(Context, String, Bundle) - Method in class org.altbeacon.beacon.service.Callback

Tries making the callback, first via messenger, then via intent

Callback - Class in org.altbeacon.beacon.service

Callback(String) - Constructor for class org.altbeacon.beacon.service.Callback

cancelAlarmOnUserSwitch() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner

cancelSchedule(Context) - Method in class org.altbeacon.beacon.service.ScanJobScheduler

cancelWakeUpAlarm() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner

checkAvailability() - Method in class org.altbeacon.beacon.BeaconManager

Check if Bluetooth LE is supported by this Android device, and if so, make sure it is enabled.

checkIfMainProcess() - Method in class org.altbeacon.beacon.BeaconManager

checkTransmissionSupported(Context) - Static method in class org.altbeacon.beacon.BeaconTransmitter

Checks to see if this device supports beacon advertising

cleanupCancelAlarmOnUserSwitch() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner

clear() - Method in class org.altbeacon.beacon.service.MonitoringStatus

clearDetections() - Method in class org.altbeacon.beacon.service.scanner.DistinctPacketDetector

clearSample() - Method in class org.altbeacon.beacon.service.Stats

clearSamples() - Method in class org.altbeacon.beacon.service.Stats

clone() - Method in class org.altbeacon.beacon.Region

Deprecated.

instances of this class are immutable and therefore don't have to be cloned when used in concurrent code.

clone(Beacon) - Method in class org.altbeacon.beacon.Region

collect(Context) - Method in class org.altbeacon.beacon.service.SettingsData

commitMeasurements() - Method in class org.altbeacon.beacon.service.RangedBeacon

compareTo(Identifier) - Method in class org.altbeacon.beacon.Identifier

Compares two identifiers.

compress(String) - Static method in class org.altbeacon.beacon.utils.UrlBeaconUrlCompressor

Converts the given URL string into a byte array "compressed" version of the URL.

copyBeaconFields(Beacon) - Method in class org.altbeacon.beacon.Beacon.Builder

crashDetected() - Method in class org.altbeacon.bluetooth.BluetoothCrashResolver

createScanFilterDataForBeaconParser(BeaconParser) - Method in class org.altbeacon.beacon.service.scanner.ScanFilterUtils

createScanFiltersForBeaconParsers(List<BeaconParser>) - Method in class org.altbeacon.beacon.service.scanner.ScanFilterUtils

createScanner(Context, long, long, boolean, CycledLeScanCallback, BluetoothCrashResolver) - Static method in class org.altbeacon.beacon.service.scanner.CycledLeScanner

createWildcardScanFilters() - Method in class org.altbeacon.beacon.service.scanner.ScanFilterUtils

CREATOR - Static variable in class org.altbeacon.beacon.AltBeacon

Required for making object Parcelable.

CREATOR - Static variable in class org.altbeacon.beacon.Beacon

Deprecated.

CREATOR - Static variable in class org.altbeacon.beacon.Region

Required to make class Parcelable

CREATOR - Static variable in class org.altbeacon.beacon.service.StartRMData

CurveFittedDistanceCalculator - Class in org.altbeacon.beacon.distance

This class estimates the distance between the mobile device and a BLE beacon based on the measured RSSI and a txPower calibration value that represents the expected RSSI for an iPhone 5 receiving the signal when it is 1 meter away.

CurveFittedDistanceCalculator(double, double, double) - Constructor for class org.altbeacon.beacon.distance.CurveFittedDistanceCalculator

Construct a calculator with coefficients specific for the device's signal vs.

CycledLeScanCallback - Interface in org.altbeacon.beacon.service.scanner

Android API agnostic Bluetooth scan callback wrapper.

CycledLeScanner - Class in org.altbeacon.beacon.service.scanner

CycledLeScanner(Context, long, long, boolean, CycledLeScanCallback, BluetoothCrashResolver) - Constructor for class org.altbeacon.beacon.service.scanner.CycledLeScanner

CycledLeScannerForJellyBeanMr2 - Class in org.altbeacon.beacon.service.scanner

CycledLeScannerForJellyBeanMr2(Context, long, long, boolean, CycledLeScanCallback, BluetoothCrashResolver) - Constructor for class org.altbeacon.beacon.service.scanner.CycledLeScannerForJellyBeanMr2

CycledLeScannerForLollipop - Class in org.altbeacon.beacon.service.scanner

CycledLeScannerForLollipop(Context, long, long, boolean, CycledLeScanCallback, BluetoothCrashResolver) - Constructor for class org.altbeacon.beacon.service.scanner.CycledLeScannerForLollipop

D

d(String, String, Object...) - Method in interface org.altbeacon.beacon.logging.Logger

Send a debug log message.

d(String, String, Object...) - Static method in class org.altbeacon.beacon.logging.LogManager

Send a debug log message to the logger.

d(Throwable, String, String, Object...) - Method in interface org.altbeacon.beacon.logging.Logger

Send a debug log message.

d(Throwable, String, String, Object...) - Static method in class org.altbeacon.beacon.logging.LogManager

Send a debug log message to the logger.

DataProviderException - Exception in org.altbeacon.beacon.client

DataProviderException() - Constructor for exception org.altbeacon.beacon.client.DataProviderException

DataProviderException(String) - Constructor for exception org.altbeacon.beacon.client.DataProviderException

DataProviderException(String, Throwable) - Constructor for exception org.altbeacon.beacon.client.DataProviderException

dataRequestNotifier - Variable in class org.altbeacon.beacon.BeaconManager

dataUpdated() - Method in interface org.altbeacon.bluetooth.BluetoothCrashResolver.UpdateNotifier

DEFAULT_BACKGROUND_BETWEEN_SCAN_PERIOD - Static variable in class org.altbeacon.beacon.BeaconManager

The default duration in milliseconds spent not scanning between each Bluetooth scan cycle when no ranging/monitoring clients are in the foreground

DEFAULT_BACKGROUND_SCAN_PERIOD - Static variable in class org.altbeacon.beacon.BeaconManager

The default duration in milliseconds of the Bluetooth scan cycle when no ranging/monitoring clients are in the foreground

DEFAULT_EXIT_PERIOD - Static variable in class org.altbeacon.beacon.BeaconManager

The default duration in milliseconds of region exit time

DEFAULT_FOREGROUND_BETWEEN_SCAN_PERIOD - Static variable in class org.altbeacon.beacon.BeaconManager

The default duration in milliseconds spent not scanning between each Bluetooth scan cycle

DEFAULT_FOREGROUND_SCAN_PERIOD - Static variable in class org.altbeacon.beacon.BeaconManager

The default duration in milliseconds of the Bluetooth scan cycle

DEFAULT_MAX_TRACKING_AGE - Static variable in class org.altbeacon.beacon.service.RangedBeacon

DEFAULT_SAMPLE_EXPIRATION_MILLISECONDS - Static variable in class org.altbeacon.beacon.service.RangedBeacon

DEFAULT_SAMPLE_EXPIRATION_MILLISECONDS - Static variable in class org.altbeacon.beacon.service.RunningAverageRssiFilter

deferScanIfNeeded() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner

deferScanIfNeeded() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScannerForJellyBeanMr2

deferScanIfNeeded() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScannerForLollipop

describeContents() - Method in class org.altbeacon.beacon.AltBeacon

Required for making object Parcelable

describeContents() - Method in class org.altbeacon.beacon.Beacon

Deprecated.

describeContents() - Method in class org.altbeacon.beacon.Region

describeContents() - Method in class org.altbeacon.beacon.service.StartRMData

destroy() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner

detectionCount - Variable in class org.altbeacon.beacon.service.Stats.Sample

DetectionTracker - Class in org.altbeacon.beacon.service

Created by dyoung on 1/10/15.

didDetermineStateForRegion(int, Region) - Method in interface org.altbeacon.beacon.MonitorNotifier

Called with a state value of MonitorNotifier.INSIDE when at least one beacon in a Region is visible.

didEnterRegion(Region) - Method in interface org.altbeacon.beacon.MonitorNotifier

Called when at least one beacon in a Region is visible.

didExitRegion(Region) - Method in interface org.altbeacon.beacon.MonitorNotifier

Called when no beacons in a Region are visible.

didRangeBeaconsInRegion(Collection<Beacon>, Region) - Method in interface org.altbeacon.beacon.RangeNotifier

Called once per second to give an estimate of the mDistance to visible beacons

disable() - Method in class org.altbeacon.beacon.startup.RegionBootstrap

Used to disable additional bootstrap callbacks after the first is received.

disableDebug() - Method in class org.altbeacon.bluetooth.BluetoothCrashResolver

Deprecated.

Since the default logger used by the android-beacon-library only logs warnings and above, this method is no logger used. To log debug messages use the Loggers.verboseLogger()

disableForegroundServiceScanning() - Method in class org.altbeacon.beacon.BeaconManager

Disables a foreground scanning service, if previously configured.

DistanceCalculator - Interface in org.altbeacon.beacon.distance

Interface for a class that can estimate the distance between a mobile device and a beacon based on the measured RSSI and a reference txPower calibration value.

DistanceConfigFetcher - Class in org.altbeacon.beacon.distance

Created by dyoung on 12/11/13.

DistanceConfigFetcher(String, String) - Constructor for class org.altbeacon.beacon.distance.DistanceConfigFetcher

distanceModelUpdateUrl - Static variable in class org.altbeacon.beacon.BeaconManager

DistinctPacketDetector - Class in org.altbeacon.beacon.service.scanner

Created by dyoung on 4/8/17.

DistinctPacketDetector() - Constructor for class org.altbeacon.beacon.service.scanner.DistinctPacketDetector

doInBackground(Void...) - Method in class org.altbeacon.beacon.distance.ModelSpecificDistanceUpdater

E

e(String, String, Object...) - Method in interface org.altbeacon.beacon.logging.Logger

Send a error log message.

e(String, String, Object...) - Static method in class org.altbeacon.beacon.logging.LogManager

Send a error log message to the logger.

e(Throwable, String, String, Object...) - Method in interface org.altbeacon.beacon.logging.Logger

Send a error log message.

e(Throwable, String, String, Object...) - Static method in class org.altbeacon.beacon.logging.LogManager

Send a error log message to the logger.

EDDYSTONE_TLM_LAYOUT - Static variable in class org.altbeacon.beacon.BeaconParser

EDDYSTONE_UID_LAYOUT - Static variable in class org.altbeacon.beacon.BeaconParser

EDDYSTONE_URL_LAYOUT - Static variable in class org.altbeacon.beacon.BeaconParser

EddystoneTelemetryAccessor - Class in org.altbeacon.beacon.utils

Utility class for working beacons that include Eddystone-TLM (telemetry) information Created by dyoung on 12/21/15.

EddystoneTelemetryAccessor() - Constructor for class org.altbeacon.beacon.utils.EddystoneTelemetryAccessor

empty() - Static method in class org.altbeacon.beacon.logging.Loggers

enableDebug() - Method in class org.altbeacon.bluetooth.BluetoothCrashResolver

Deprecated.

Since the default logger used by the android-beacon-library only logs warnings and above, this method is no logger used. To log debug messages use the Loggers.verboseLogger()

enableForegroundServiceScanning(Notification, int) - Method in class org.altbeacon.beacon.BeaconManager

Configures the library to use a foreground service for bacon scanning.

enablePeriodicTests(Context, int) - Method in class org.altbeacon.bluetooth.BluetoothMedic

Calling this method starts a scheduled job that will run tests of the specified type to make sure bluetooth is OK and cycle power to bluetooth if needed and configured by enablePowerCycleOnFailures

enablePowerCycleOnFailures(Context) - Method in class org.altbeacon.bluetooth.BluetoothMedic

If set to true, bluetooth will be power cycled on any tests run that determine bluetooth is in a bad state.

equals(Object) - Method in class org.altbeacon.beacon.Beacon

Two detected beacons are considered equal if they share the same three identifiers, regardless of their mDistance or RSSI.

equals(Object) - Method in class org.altbeacon.beacon.BeaconParser

equals(Object) - Method in class org.altbeacon.beacon.Identifier

Returns whether both Identifiers contain equal value.

equals(Object) - Method in class org.altbeacon.beacon.Region

ExtraDataBeaconTracker - Class in org.altbeacon.beacon.service

Keeps track of beacons that have ever been seen and merges them together depending on configured beacon parsers Created by dyoung on 5/5/15.

ExtraDataBeaconTracker() - Constructor for class org.altbeacon.beacon.service.ExtraDataBeaconTracker

ExtraDataBeaconTracker(boolean) - Constructor for class org.altbeacon.beacon.service.ExtraDataBeaconTracker

extraParsers - Variable in class org.altbeacon.beacon.BeaconParser

F

finalizeBeacons() - Method in class org.altbeacon.beacon.service.RangeState

finishScan() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner

finishScan() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScannerForJellyBeanMr2

finishScan() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScannerForLollipop

firstDetectionTime - Variable in class org.altbeacon.beacon.service.Stats.Sample

forceFlush() - Method in class org.altbeacon.bluetooth.BluetoothCrashResolver

Used to force a recovery operation

forceScheduleNextScan(Context) - Method in class org.altbeacon.beacon.service.ScanJobScheduler

forThisDevice() - Static method in class org.altbeacon.beacon.distance.AndroidModel

fromBundle(Bundle) - Static method in class org.altbeacon.beacon.service.MonitoringData

fromBundle(Bundle) - Static method in class org.altbeacon.beacon.service.RangingData

fromBundle(Bundle) - Static method in class org.altbeacon.beacon.service.SettingsData

fromBundle(Bundle) - Static method in class org.altbeacon.beacon.service.StartRMData

fromBytes(byte[], int, int, boolean) - Static method in class org.altbeacon.beacon.Identifier

Creates an Identifier from the specified byte array.

fromInt(int) - Static method in class org.altbeacon.beacon.Identifier

Creates an Identifier backed by a two byte Array (big endian).

fromLong(long, int) - Static method in class org.altbeacon.beacon.Identifier

Creates an Identifer backed by an array of length desiredByteLength

fromScanData(byte[], int, BluetoothDevice, long) - Method in class org.altbeacon.beacon.AltBeaconParser

Construct an AltBeacon from a Bluetooth LE packet collected by Android's Bluetooth APIs, including the raw Bluetooth device info

fromScanData(byte[], int, BluetoothDevice, long) - Method in class org.altbeacon.beacon.BeaconParser

Construct a Beacon from a Bluetooth LE packet collected by Android's Bluetooth APIs, including the raw Bluetooth device info

fromScanData(byte[], int, BluetoothDevice, long, Beacon) - Method in class org.altbeacon.beacon.BeaconParser

fromUuid(UUID) - Static method in class org.altbeacon.beacon.Identifier

Transforms a UUID into an Identifier.

G

GATT_SERVICE_UUID_PDU_TYPE - Static variable in class org.altbeacon.bluetooth.Pdu

get(String) - Method in interface org.altbeacon.beacon.BeaconData

getActualLength() - Method in class org.altbeacon.bluetooth.Pdu

Actual PDU length (may be less than declared length if fewer bytes are actually available.)

getAdvertiseMode() - Method in class org.altbeacon.beacon.BeaconTransmitter

getAdvertiseTxPowerLevel() - Method in class org.altbeacon.beacon.BeaconTransmitter

getApplicationContext() - Method in interface org.altbeacon.beacon.BeaconConsumer

Called by the BeaconManager to get the context of your Service or Activity.

getApplicationContext() - Method in interface org.altbeacon.beacon.startup.BootstrapNotifier

getBackgroundBetweenScanPeriod() - Method in class org.altbeacon.beacon.BeaconManager

getBackgroundBetweenScanPeriod() - Method in class org.altbeacon.beacon.service.ScanState

getBackgroundFlag() - Method in class org.altbeacon.beacon.service.StartRMData

getBackgroundMode() - Method in class org.altbeacon.beacon.BeaconManager

getBackgroundMode() - Method in class org.altbeacon.beacon.service.ScanState

getBackgroundScanPeriod() - Method in class org.altbeacon.beacon.BeaconManager

getBackgroundScanPeriod() - Method in class org.altbeacon.beacon.service.ScanState

getBase64EncodedTelemetry(Beacon) - Method in class org.altbeacon.beacon.utils.EddystoneTelemetryAccessor

Extracts the raw Eddystone telemetry bytes from the extra data fields of an associated beacon and base64 encodes them.

getBeacon() - Method in class org.altbeacon.beacon.service.RangedBeacon

getBeaconAdvertisementData(Beacon) - Method in class org.altbeacon.beacon.BeaconParser

Get BLE advertisement bytes for a Beacon

getBeaconParsers() - Method in class org.altbeacon.beacon.BeaconManager

Gets a list of the active beaconParsers.

getBeaconParsers() - Method in class org.altbeacon.beacon.service.ScanState

getBeacons() - Method in class org.altbeacon.beacon.service.RangingData

getBeacons() - Method in interface org.altbeacon.beacon.simulator.BeaconSimulator

getBeacons() - Method in class org.altbeacon.beacon.simulator.StaticBeaconSimulator

getBeaconSimulator() - Static method in class org.altbeacon.beacon.BeaconManager

getBeaconTypeCode() - Method in class org.altbeacon.beacon.Beacon

getBetweenScanPeriod() - Method in class org.altbeacon.beacon.service.StartRMData

getBluetoothAdapter() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner

getBluetoothAddress() - Method in class org.altbeacon.beacon.Beacon

getBluetoothAddress() - Method in class org.altbeacon.beacon.Region

Returns the mac address used to filter for beacons

getBluetoothName() - Method in class org.altbeacon.beacon.Beacon

getBuildNumber() - Method in class org.altbeacon.beacon.distance.AndroidModel

getByteCount() - Method in class org.altbeacon.beacon.Identifier

Returns the byte length of this identifier.

getCallback() - Method in class org.altbeacon.beacon.service.RangeState

getCallback() - Method in class org.altbeacon.beacon.service.RegionMonitoringState

getCallbackPackageName() - Method in class org.altbeacon.beacon.service.StartRMData

getCycledLeScanCallback() - Method in class org.altbeacon.beacon.service.BeaconService

getDataFieldCount() - Method in class org.altbeacon.beacon.BeaconParser

getDataFields() - Method in class org.altbeacon.beacon.Beacon

Returns the list of data fields transmitted with the advertisement

getDataRequestNotifier() - Method in class org.altbeacon.beacon.BeaconManager

getDeclaredLength() - Method in class org.altbeacon.bluetooth.Pdu

PDU length from header

getDetectedCrashCount() - Method in class org.altbeacon.bluetooth.BluetoothCrashResolver

getDistance() - Method in class org.altbeacon.beacon.Beacon

Provides a calculated estimate of the distance to the beacon based on a running average of the RSSI and the transmitted power calibration value included in the beacon advertisement.

getDistanceCalculator() - Static method in class org.altbeacon.beacon.Beacon

Gets the DistanceCalculator to use with this beacon

getDistanceModelUpdateUrl() - Static method in class org.altbeacon.beacon.BeaconManager

getDistinctPacketsDetectedPerScan() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner

getEndIndex() - Method in class org.altbeacon.bluetooth.Pdu

End index within byte buffer of PDU

getException() - Method in class org.altbeacon.beacon.distance.DistanceConfigFetcher

getExtraBeaconDataTracker() - Method in class org.altbeacon.beacon.service.ScanState

getExtraDataFields() - Method in class org.altbeacon.beacon.Beacon

Returns the list of data fields transmitted with the advertisement

getExtraDataParsers() - Method in class org.altbeacon.beacon.BeaconParser

Gets a list of extra parsers configured for this BeaconParser.

getFirstCycleDetectionTimestamp() - Method in class org.altbeacon.beacon.Beacon

Returns the timestamp of the first packet detected

getForegroundBetweenScanPeriod() - Method in class org.altbeacon.beacon.BeaconManager

getForegroundBetweenScanPeriod() - Method in class org.altbeacon.beacon.service.ScanState

getForegroundScanPeriod() - Method in class org.altbeacon.beacon.BeaconManager

getForegroundScanPeriod() - Method in class org.altbeacon.beacon.service.ScanState

getForegroundServiceNotification() - Method in class org.altbeacon.beacon.BeaconManager

getForegroundServiceNotificationId() - Method in class org.altbeacon.beacon.BeaconManager

getHardwareAssistManufacturers() - Method in class org.altbeacon.beacon.BeaconParser

Returns a list of Bluetooth manufacturer codes which will be used for hardware-assisted accelerated looking for this beacon type The possible codes are defined on this list: https://www.bluetooth.org/en-us/specification/assigned-numbers/company-identifiers

getHardwareEqualityEnforced() - Static method in class org.altbeacon.beacon.Beacon

getId1() - Method in class org.altbeacon.beacon.Beacon

Convenience method to get the first identifier

getId1() - Method in class org.altbeacon.beacon.Region

Convenience method to get the first identifier

getId2() - Method in class org.altbeacon.beacon.Beacon

Convenience method to get the second identifier

getId2() - Method in class org.altbeacon.beacon.Region

Convenience method to get the second identifier

getId3() - Method in class org.altbeacon.beacon.Beacon

Convenience method to get the third identifier

getId3() - Method in class org.altbeacon.beacon.Region

Convenience method to get the third identifier

getIdentifier() - Method in class org.altbeacon.beacon.BeaconParser

Gets an optional identifier field that may be used to identify this parser.

getIdentifier(int) - Method in class org.altbeacon.beacon.Beacon

Returns the specified identifier - 0 indexed Note: to read id1, call getIdentifier(0);

getIdentifier(int) - Method in class org.altbeacon.beacon.Region

Returns the 0-indexed identifier Note: IMPORTANT: to get id1, you would call getIdentifier(0);

getIdentifierByteCount(int) - Method in class org.altbeacon.beacon.BeaconParser

Caclculates the byte size of the specified identifier in this format

getIdentifierCount() - Method in class org.altbeacon.beacon.BeaconParser

getIdentifiers() - Method in class org.altbeacon.beacon.Beacon

Returns the list of identifiers transmitted with the advertisement

getImmediateScanJobId(Context) - Static method in class org.altbeacon.beacon.service.ScanJob

Returns the job id to be used to schedule this job.

getInside() - Method in class org.altbeacon.beacon.service.RegionMonitoringState

getInstance() - Static method in class org.altbeacon.beacon.service.DetectionTracker

getInstance() - Static method in class org.altbeacon.beacon.service.ScanJobScheduler

getInstance() - Static method in class org.altbeacon.beacon.service.Stats

getInstance() - Static method in class org.altbeacon.bluetooth.BluetoothMedic

Get a singleton instance of the BluetoothMedic

getInstanceForApplication(Context) - Static method in class org.altbeacon.beacon.BeaconManager

An accessor for the singleton instance of this class.

getInstanceForApplication(Context) - Static method in class org.altbeacon.beacon.service.MonitoringStatus

getJobId(Context) - Static method in class org.altbeacon.bluetooth.BluetoothTestJob

Returns the job id to be used to schedule this job.

getLastBluetoothCrashDetectionTime() - Method in class org.altbeacon.bluetooth.BluetoothCrashResolver

getLastCycleDetectionTimestamp() - Method in class org.altbeacon.beacon.Beacon

Returns the timestamp of the last packet detected

getLastDetectionTime() - Method in class org.altbeacon.beacon.service.DetectionTracker

getLastMonitoringStatusUpdateTime() - Method in class org.altbeacon.beacon.service.MonitoringStatus

getLastScanStartTimeMillis() - Method in class org.altbeacon.beacon.service.ScanState

getLatitude() - Method in interface org.altbeacon.beacon.BeaconData

getLayout() - Method in class org.altbeacon.beacon.BeaconParser

getLogger() - Static method in class org.altbeacon.beacon.logging.LogManager

Gets the currently set logger

getLongitude() - Method in interface org.altbeacon.beacon.BeaconData

getManifestCheckingDisabled() - Static method in class org.altbeacon.beacon.BeaconManager

Returns whether manifest checking is disabled

getManufacturer() - Method in class org.altbeacon.beacon.Beacon

getManufacturer() - Method in class org.altbeacon.beacon.distance.AndroidModel

getMatchingBeaconTypeCode() - Method in class org.altbeacon.beacon.BeaconParser

getMatchingBeaconTypeCodeEndOffset() - Method in class org.altbeacon.beacon.BeaconParser

see #mMatchingBeaconTypeCodeEndOffset

getMatchingBeaconTypeCodeStartOffset() - Method in class org.altbeacon.beacon.BeaconParser

see #mMatchingBeaconTypeCodeStartOffset

getMeasurementCount() - Method in class org.altbeacon.beacon.Beacon

Returns the number of packet detections that went in to the runningAverageRssi, if known.

getMeasurementCount() - Method in class org.altbeacon.beacon.service.ArmaRssiFilter

getMeasurementCount() - Method in interface org.altbeacon.beacon.service.RssiFilter

getMeasurementCount() - Method in class org.altbeacon.beacon.service.RunningAverageRssiFilter

getMfgReserved() - Method in class org.altbeacon.beacon.AltBeacon

Returns a field with a value from 0-255 that can be used for the purposes specified by the manufacturer.

getModel() - Method in class org.altbeacon.beacon.distance.AndroidModel

getModel() - Method in class org.altbeacon.beacon.distance.ModelSpecificDistanceCalculator

getMonitoredRegions() - Method in class org.altbeacon.beacon.BeaconManager

getMonitoringNotifier() - Method in class org.altbeacon.beacon.BeaconManager

Deprecated.

replaced by (@link #getMonitorNotifiers)

getMonitoringNotifiers() - Method in class org.altbeacon.beacon.BeaconManager

Read-only access to the registered MonitorNotifier instances

getMonitoringStatus() - Method in class org.altbeacon.beacon.service.ScanState

getMServiceUuidStartOffset() - Method in class org.altbeacon.beacon.BeaconParser

see #mServiceUuidStartOffset

getNonBeaconLeScanCallback() - Method in class org.altbeacon.beacon.BeaconManager

getPackageName() - Method in class org.altbeacon.beacon.utils.ProcessUtils

getPacketCount() - Method in class org.altbeacon.beacon.Beacon

Returns the number of packet detections in the last ranging cycle

getParserIdentifier() - Method in class org.altbeacon.beacon.Beacon

getPdus() - Method in class org.altbeacon.bluetooth.BleAdvertisement

The list of PDUs inside the advertisement

getPeriodicScanJobId(Context) - Static method in class org.altbeacon.beacon.service.ScanJob

Returns the job id to be used to schedule this job.

getPid() - Method in class org.altbeacon.beacon.utils.ProcessUtils

getPowerCorrection() - Method in class org.altbeacon.beacon.BeaconParser

getProcessName() - Method in class org.altbeacon.beacon.utils.ProcessUtils

getRangedRegions() - Method in class org.altbeacon.beacon.BeaconManager

getRangedRegionState() - Method in class org.altbeacon.beacon.service.ScanState

getRangingNotifier() - Method in class org.altbeacon.beacon.BeaconManager

Deprecated.

replaced by (@link #getRangeNotifiers)

getRangingNotifiers() - Method in class org.altbeacon.beacon.BeaconManager

Read-only access to the registered RangeNotifier instances

getRecoveryAttemptCount() - Method in class org.altbeacon.bluetooth.BluetoothCrashResolver

getRegion() - Method in class org.altbeacon.beacon.service.MonitoringData

getRegion() - Method in class org.altbeacon.beacon.service.RangingData

getRegionData() - Method in class org.altbeacon.beacon.service.StartRMData

getRegionExitPeriod() - Static method in class org.altbeacon.beacon.BeaconManager

Get region exit milliseconds

getRegions() - Method in class org.altbeacon.beacon.service.MonitoringStatus

getRequestedModel() - Method in class org.altbeacon.beacon.distance.ModelSpecificDistanceCalculator

getResponseCode() - Method in class org.altbeacon.beacon.distance.DistanceConfigFetcher

getResponseString() - Method in class org.altbeacon.beacon.distance.DistanceConfigFetcher

getRssi() - Method in class org.altbeacon.beacon.Beacon

getRssiFilterImplClass() - Static method in class org.altbeacon.beacon.BeaconManager

getRunningAverageRssi() - Method in class org.altbeacon.beacon.Beacon

Returns the running average rssi

getRunningAverageRssi(double) - Method in class org.altbeacon.beacon.Beacon

Deprecated.

To be removed in a future release. Use Beacon.getRunningAverageRssi() instead.

getSamples() - Method in class org.altbeacon.beacon.service.Stats

getScanJobIntervalMillis() - Method in class org.altbeacon.beacon.service.ScanState

getScanJobRuntimeMillis() - Method in class org.altbeacon.beacon.service.ScanState

getScanPeriod() - Method in class org.altbeacon.beacon.service.StartRMData

getScheduledScanJobsEnabled() - Method in class org.altbeacon.beacon.BeaconManager

getService() - Method in class org.altbeacon.beacon.service.BeaconService.BeaconBinder

getServiceUuid() - Method in class org.altbeacon.beacon.Beacon

getServiceUuid() - Method in class org.altbeacon.beacon.BeaconParser

getServiceUuidEndOffset() - Method in class org.altbeacon.beacon.BeaconParser

see #mServiceUuidEndOffset

getStartIndex() - Method in class org.altbeacon.bluetooth.Pdu

Start index within byte buffer of PDU This is the start of the payload data that starts after the length and the type, so the PDU actually starts two bytes earlier

getTelemetryBytes(Beacon) - Method in class org.altbeacon.beacon.utils.EddystoneTelemetryAccessor

Extracts the raw Eddystone telemetry bytes from the extra data fields of an associated beacon.

getTrackingAge() - Method in class org.altbeacon.beacon.service.RangedBeacon

getTxPower() - Method in class org.altbeacon.beacon.Beacon

getType() - Method in class org.altbeacon.bluetooth.Pdu

PDU type field

getUniqueId() - Method in class org.altbeacon.beacon.Region

Returns the identifier used to start or stop ranging/monitoring this region when calling the BeaconManager methods.

getUseTrackingCache() - Static method in class org.altbeacon.beacon.service.RangeState

getVersion() - Method in class org.altbeacon.beacon.distance.AndroidModel

getWakeUpOperation() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner

H

hashCode() - Method in class org.altbeacon.beacon.Beacon

Calculate a hashCode for this beacon

hashCode() - Method in class org.altbeacon.beacon.BeaconParser

hashCode() - Method in class org.altbeacon.beacon.Identifier

hashCode() - Method in class org.altbeacon.beacon.Region

hasSameIdentifiers(Region) - Method in class org.altbeacon.beacon.Region

I

i(String, String, Object...) - Method in interface org.altbeacon.beacon.logging.Logger

Send a info log message.

i(String, String, Object...) - Static method in class org.altbeacon.beacon.logging.LogManager

Send a info log message to the logger.

i(Throwable, String, String, Object...) - Method in interface org.altbeacon.beacon.logging.Logger

Send a info log message.

i(Throwable, String, String, Object...) - Static method in class org.altbeacon.beacon.logging.LogManager

Send a info log message to the logger.

Identifier - Class in org.altbeacon.beacon

Encapsulates a beacon identifier of arbitrary byte length.

Identifier(byte[]) - Constructor for class org.altbeacon.beacon.Identifier

Creates a new instance of Identifier

Identifier(Identifier) - Constructor for class org.altbeacon.beacon.Identifier

Deprecated.

objects of this class are immutable and therefore don't have to be cloned when used from multiple threads

infoLogger() - Static method in class org.altbeacon.beacon.logging.Loggers

INSIDE - Static variable in interface org.altbeacon.beacon.MonitorNotifier

Indicates the Android device is inside the Region of beacons

isAndroidLScanningDisabled() - Static method in class org.altbeacon.beacon.BeaconManager

Determines if Android L Scanning is disabled by user selection

isAnyConsumerBound() - Method in class org.altbeacon.beacon.BeaconManager

Tells you if the any beacon consumer is bound to the service

isBackgroundModeUninitialized() - Method in class org.altbeacon.beacon.BeaconManager

isBound(BeaconConsumer) - Method in class org.altbeacon.beacon.BeaconManager

Tells you if the passed beacon consumer is bound to the service

isConnectable() - Method in class org.altbeacon.beacon.BeaconTransmitter

isDirty() - Method in interface org.altbeacon.beacon.BeaconData

isEnabled() - Method in class org.altbeacon.beacon.service.Stats

isExpired() - Method in class org.altbeacon.beacon.service.RangedBeacon

isExtraBeaconData() - Method in class org.altbeacon.beacon.Beacon

Indicates whether this beacon is an "Extra data beacon," meaning one that has no identifiers but has data fields.

isInside() - Method in class org.altbeacon.beacon.service.MonitoringData

isLastRecoverySucceeded() - Method in class org.altbeacon.bluetooth.BluetoothCrashResolver

isMainProcess() - Method in class org.altbeacon.beacon.BeaconManager

Determines if this BeaconManager instance is associated with the main application process that hosts the user interface.

isMainProcess() - Method in class org.altbeacon.beacon.utils.ProcessUtils

isMultiFrameBeacon() - Method in class org.altbeacon.beacon.Beacon

isPacketDistinct(String, byte[]) - Method in class org.altbeacon.beacon.service.scanner.DistinctPacketDetector

isRecoveryInProgress() - Method in class org.altbeacon.bluetooth.BluetoothCrashResolver

isRegionStatePersistenceEnabled() - Method in class org.altbeacon.beacon.BeaconManager

Indicates whether region state preservation is enabled

isScannerInDifferentProcess() - Method in class org.altbeacon.beacon.BeaconManager

Determines if this BeaconManager instance is not part of the process hosting the beacon scanning service.

isStarted() - Method in class org.altbeacon.beacon.BeaconTransmitter

Tells if transmission has started

isStatePreservationOn() - Method in class org.altbeacon.beacon.service.MonitoringStatus

isTracked() - Method in class org.altbeacon.beacon.service.RangedBeacon

isVerboseLoggingEnabled() - Static method in class org.altbeacon.beacon.logging.LogManager

Indicates whether verbose logging is enabled.

L

lastDetectionTime - Variable in class org.altbeacon.beacon.service.Stats.Sample

lastTrackedTimeMillis - Variable in class org.altbeacon.beacon.service.RangedBeacon

log(Beacon) - Method in class org.altbeacon.beacon.service.Stats

logDebug(String, String) - Static method in class org.altbeacon.beacon.BeaconManager

Deprecated.

This will be removed in a later release. Use LogManager.d(String, String, Object...) instead.

logDebug(String, String, Throwable) - Static method in class org.altbeacon.beacon.BeaconManager

Deprecated.

This will be removed in a later release. Use LogManager.d(Throwable, String, String, Object...) instead.

Logger - Interface in org.altbeacon.beacon.logging

Logging interface for logging messages in the android-beacon-library.

Loggers - Class in org.altbeacon.beacon.logging

Static factory methods for getting different Logger implementations.

LogManager - Class in org.altbeacon.beacon.logging

Manager for logging in the Altbeacon library.

longToByteArray(long, int) - Static method in class org.altbeacon.beacon.BeaconParser

longToByteArray(long, int, boolean) - Static method in class org.altbeacon.beacon.BeaconParser

M

mAllowPduOverflow - Variable in class org.altbeacon.beacon.BeaconParser

MANUFACTURER_DATA_PDU_TYPE - Static variable in class org.altbeacon.bluetooth.Pdu

markInside() - Method in class org.altbeacon.beacon.service.RegionMonitoringState

markOutside() - Method in class org.altbeacon.beacon.service.RegionMonitoringState

markOutsideIfExpired() - Method in class org.altbeacon.beacon.service.RegionMonitoringState

matchesBeacon(Beacon) - Method in class org.altbeacon.beacon.Region

Checks to see if an Beacon object is included in the matching criteria of this Region

matchScore(AndroidModel) - Method in class org.altbeacon.beacon.distance.AndroidModel

Calculates a qualitative match score between two different Android device models for the purposes of how likely they are to have similar Bluetooth signal level responses

maxMillisBetweenDetections - Variable in class org.altbeacon.beacon.service.Stats.Sample

maxTrackingAge - Static variable in class org.altbeacon.beacon.service.RangedBeacon

mBackgroundFlag - Variable in class org.altbeacon.beacon.service.scanner.CycledLeScanner

mBeacon - Variable in class org.altbeacon.beacon.Beacon.Builder

mBeaconLayout - Variable in class org.altbeacon.beacon.BeaconParser

mBeaconTypeCode - Variable in class org.altbeacon.beacon.Beacon

The two byte value indicating the type of beacon that this is, which is used for figuring out the byte layout of the beacon advertisement

mBetweenScanPeriod - Variable in class org.altbeacon.beacon.service.scanner.CycledLeScanner

mBluetoothAddress - Variable in class org.altbeacon.beacon.Beacon

The Bluetooth mac address

mBluetoothAddress - Variable in class org.altbeacon.beacon.Region

mBluetoothCrashResolver - Variable in class org.altbeacon.beacon.service.scanner.CycledLeScanner

mBluetoothName - Variable in class org.altbeacon.beacon.Beacon

The Bluetooth device name.

mContext - Variable in class org.altbeacon.beacon.service.scanner.CycledLeScanner

mCycledLeScanCallback - Variable in class org.altbeacon.beacon.service.scanner.CycledLeScanner

mDataEndOffsets - Variable in class org.altbeacon.beacon.BeaconParser

mDataFields - Variable in class org.altbeacon.beacon.Beacon

A list of generic non-identifying data fields included in the beacon advertisement.

mDataLittleEndianFlags - Variable in class org.altbeacon.beacon.BeaconParser

mDataStartOffsets - Variable in class org.altbeacon.beacon.BeaconParser

mDBmCorrection - Variable in class org.altbeacon.beacon.BeaconParser

mDistance - Variable in class org.altbeacon.beacon.Beacon

A double that is an estimate of how far the Beacon is away in meters.

mException - Variable in class org.altbeacon.beacon.distance.DistanceConfigFetcher

mExtraDataFields - Variable in class org.altbeacon.beacon.Beacon

A list of generic non-identifying data fields included in a secondary beacon advertisement and merged into this beacon.

mExtraFrame - Variable in class org.altbeacon.beacon.BeaconParser

mFilter - Variable in class org.altbeacon.beacon.service.RangedBeacon

mFirstCycleDetectionTimestamp - Variable in class org.altbeacon.beacon.Beacon

The timestamp of the first packet detected in milliseconds.

mHandler - Variable in class org.altbeacon.beacon.service.scanner.CycledLeScanner

Main thread handle for scheduling scan cycle tasks.

mHardwareAssistManufacturers - Variable in class org.altbeacon.beacon.BeaconParser

mIdentifier - Variable in class org.altbeacon.beacon.BeaconParser

mIdentifierEndOffsets - Variable in class org.altbeacon.beacon.BeaconParser

mIdentifierLittleEndianFlags - Variable in class org.altbeacon.beacon.BeaconParser

mIdentifiers - Variable in class org.altbeacon.beacon.Beacon

The a list of the multi-part identifiers of the beacon.

mIdentifiers - Variable in class org.altbeacon.beacon.Region

mIdentifierStartOffsets - Variable in class org.altbeacon.beacon.BeaconParser

mIdentifierVariableLengthFlags - Variable in class org.altbeacon.beacon.BeaconParser

MIN_SCAN_JOB_INTERVAL_MILLIS - Static variable in class org.altbeacon.beacon.service.ScanState

mLastCycleDetectionTimestamp - Variable in class org.altbeacon.beacon.Beacon

The timestamp of the last packet detected in milliseconds.

mLayoutSize - Variable in class org.altbeacon.beacon.BeaconParser

mManufacturer - Variable in class org.altbeacon.beacon.Beacon

A two byte code indicating the beacon manufacturer.

mMatchingBeaconTypeCodeEndOffset - Variable in class org.altbeacon.beacon.BeaconParser

mMatchingBeaconTypeCodeStartOffset - Variable in class org.altbeacon.beacon.BeaconParser

mMultiFrameBeacon - Variable in class org.altbeacon.beacon.Beacon

An indicator marking this beacon as a potential multi frame beacon.

mNextScanCycleStartTime - Variable in class org.altbeacon.beacon.service.scanner.CycledLeScanner

ModelSpecificDistanceCalculator - Class in org.altbeacon.beacon.distance

Obtains a DistanceCalculator appropriate for a specific Android model.

ModelSpecificDistanceCalculator(Context, String) - Constructor for class org.altbeacon.beacon.distance.ModelSpecificDistanceCalculator

Obtains the best possible DistanceCalculator for the Android device calling the constructor

ModelSpecificDistanceCalculator(Context, String, AndroidModel) - Constructor for class org.altbeacon.beacon.distance.ModelSpecificDistanceCalculator

Obtains the best possible DistanceCalculator for the Android device passed as an argument

ModelSpecificDistanceUpdater - Class in org.altbeacon.beacon.distance

Created by dyoung on 9/12/14.

ModelSpecificDistanceUpdater(Context, String, ModelSpecificDistanceUpdater.CompletionHandler) - Constructor for class org.altbeacon.beacon.distance.ModelSpecificDistanceUpdater

MONITOR_NOTIFICATION - Static variable in class org.altbeacon.beacon.BeaconLocalBroadcastProcessor

MonitoringData - Class in org.altbeacon.beacon.service

MonitoringData(boolean, Region) - Constructor for class org.altbeacon.beacon.service.MonitoringData

MonitoringStatus - Class in org.altbeacon.beacon.service

MonitoringStatus(Context) - Constructor for class org.altbeacon.beacon.service.MonitoringStatus

MonitorNotifier - Interface in org.altbeacon.beacon

This interface is implemented by classes that receive beacon monitoring notifications

monitorNotifiers - Variable in class org.altbeacon.beacon.BeaconManager

mParserIdentifier - Variable in class org.altbeacon.beacon.Beacon

The identifier of the beaconParser used to create this beacon.

mPowerEndOffset - Variable in class org.altbeacon.beacon.BeaconParser

mPowerStartOffset - Variable in class org.altbeacon.beacon.BeaconParser

mResponse - Variable in class org.altbeacon.beacon.distance.DistanceConfigFetcher

mRestartNeeded - Variable in class org.altbeacon.beacon.service.scanner.CycledLeScanner

mRssi - Variable in class org.altbeacon.beacon.Beacon

The measured signal strength of the Bluetooth packet that led do this Beacon detection.

mScanHandler - Variable in class org.altbeacon.beacon.service.scanner.CycledLeScanner

Handler to background thread for interacting with the low-level Android BLE scanner.

mScanningPaused - Variable in class org.altbeacon.beacon.service.scanner.CycledLeScanner

mServiceUuid - Variable in class org.altbeacon.beacon.Beacon

A 32 bit service uuid for the beacon This is valid only for GATT-based beacons.

mServiceUuid - Variable in class org.altbeacon.beacon.BeaconParser

mServiceUuidEndOffset - Variable in class org.altbeacon.beacon.BeaconParser

mServiceUuidStartOffset - Variable in class org.altbeacon.beacon.BeaconParser

MSG_SET_SCAN_PERIODS - Static variable in class org.altbeacon.beacon.service.BeaconService

MSG_START_MONITORING - Static variable in class org.altbeacon.beacon.service.BeaconService

MSG_START_RANGING - Static variable in class org.altbeacon.beacon.service.BeaconService

Command to the service to display a message

MSG_STOP_MONITORING - Static variable in class org.altbeacon.beacon.service.BeaconService

MSG_STOP_RANGING - Static variable in class org.altbeacon.beacon.service.BeaconService

MSG_SYNC_SETTINGS - Static variable in class org.altbeacon.beacon.service.BeaconService

mTxPower - Variable in class org.altbeacon.beacon.Beacon

The calibrated measured Tx power of the Beacon in RSSI This value is baked into an Beacon when it is manufactured, and it is transmitted with each packet to aid in the mDistance estimate

mUniqueId - Variable in class org.altbeacon.beacon.Region

N

newSampleInterval() - Method in class org.altbeacon.beacon.service.Stats

NO_TEST - Static variable in class org.altbeacon.bluetooth.BluetoothMedic

Indicates that no test should be run by the BluetoothTestJob

noMeasurementsAvailable() - Method in class org.altbeacon.beacon.service.ArmaRssiFilter

noMeasurementsAvailable() - Method in class org.altbeacon.beacon.service.RangedBeacon

noMeasurementsAvailable() - Method in interface org.altbeacon.beacon.service.RssiFilter

noMeasurementsAvailable() - Method in class org.altbeacon.beacon.service.RunningAverageRssiFilter

NonBeaconLeScanCallback - Interface in org.altbeacon.beacon.service.scanner

Allows an implementation to see non-Beacon BLE devices as they are scanned.

NOT_SUPPORTED_BLE - Static variable in class org.altbeacon.beacon.BeaconTransmitter

NOT_SUPPORTED_CANNOT_GET_ADVERTISER - Static variable in class org.altbeacon.beacon.BeaconTransmitter

NOT_SUPPORTED_CANNOT_GET_ADVERTISER_MULTIPLE_ADVERTISEMENTS - Static variable in class org.altbeacon.beacon.BeaconTransmitter

NOT_SUPPORTED_MIN_SDK - Static variable in class org.altbeacon.beacon.BeaconTransmitter

NOT_SUPPORTED_MULTIPLE_ADVERTISEMENTS - Static variable in class org.altbeacon.beacon.BeaconTransmitter

Deprecated.

notifyScannedDevice(BluetoothDevice, BluetoothAdapter.LeScanCallback) - Method in class org.altbeacon.bluetooth.BluetoothCrashResolver

Call this method from your BluetoothAdapter.LeScanCallback method.

NullBeaconDataFactory - Class in org.altbeacon.beacon.client

NullBeaconDataFactory() - Constructor for class org.altbeacon.beacon.client.NullBeaconDataFactory

O

onActivityCreated(Activity, Bundle) - Method in class org.altbeacon.beacon.powersave.BackgroundPowerSaver

onActivityDestroyed(Activity) - Method in class org.altbeacon.beacon.powersave.BackgroundPowerSaver

onActivityPaused(Activity) - Method in class org.altbeacon.beacon.powersave.BackgroundPowerSaver

onActivityResumed(Activity) - Method in class org.altbeacon.beacon.powersave.BackgroundPowerSaver

onActivitySaveInstanceState(Activity, Bundle) - Method in class org.altbeacon.beacon.powersave.BackgroundPowerSaver

onActivityStarted(Activity) - Method in class org.altbeacon.beacon.powersave.BackgroundPowerSaver

onActivityStopped(Activity) - Method in class org.altbeacon.beacon.powersave.BackgroundPowerSaver

onBeaconServiceConnect() - Method in interface org.altbeacon.beacon.BeaconConsumer

Called when the beacon service is running and ready to accept your commands through the BeaconManager

onBind(Intent) - Method in class org.altbeacon.beacon.service.BeaconService

When binding to the service, we return an interface to our messenger for sending messages to the service.

onCreate() - Method in class org.altbeacon.beacon.service.BeaconService

onCycleEnd() - Method in interface org.altbeacon.beacon.service.scanner.CycledLeScanCallback

onDestroy() - Method in class org.altbeacon.beacon.service.BeaconService

onHandleIntent(Intent) - Method in class org.altbeacon.beacon.BeaconIntentProcessor

onLeScan(BluetoothDevice, int, byte[], long) - Method in interface org.altbeacon.beacon.service.scanner.CycledLeScanCallback

onNonBeaconLeScan(BluetoothDevice, int, byte[]) - Method in interface org.altbeacon.beacon.service.scanner.NonBeaconLeScanCallback

NOTE: This method is NOT called on the main UI thread.

onPostExecute() - Method in class org.altbeacon.beacon.distance.ModelSpecificDistanceUpdater

onReceive(Context, Intent) - Method in class org.altbeacon.beacon.startup.StartupBroadcastReceiver

onStartCommand(Intent, int, int) - Method in class org.altbeacon.beacon.service.BeaconService

onStartJob(JobParameters) - Method in class org.altbeacon.beacon.service.ScanJob

onStartJob(JobParameters) - Method in class org.altbeacon.bluetooth.BluetoothTestJob

onStopJob(JobParameters) - Method in class org.altbeacon.beacon.service.ScanJob

onStopJob(JobParameters) - Method in class org.altbeacon.bluetooth.BluetoothTestJob

onTaskRemoved(Intent) - Method in class org.altbeacon.beacon.service.BeaconService

onUnbind(Intent) - Method in class org.altbeacon.beacon.service.BeaconService

org.altbeacon.beacon - package org.altbeacon.beacon

org.altbeacon.beacon.client - package org.altbeacon.beacon.client

org.altbeacon.beacon.distance - package org.altbeacon.beacon.distance

org.altbeacon.beacon.logging - package org.altbeacon.beacon.logging

org.altbeacon.beacon.powersave - package org.altbeacon.beacon.powersave

org.altbeacon.beacon.service - package org.altbeacon.beacon.service

org.altbeacon.beacon.service.scanner - package org.altbeacon.beacon.service.scanner

org.altbeacon.beacon.simulator - package org.altbeacon.beacon.simulator

org.altbeacon.beacon.startup - package org.altbeacon.beacon.startup

org.altbeacon.beacon.utils - package org.altbeacon.beacon.utils

org.altbeacon.bluetooth - package org.altbeacon.bluetooth

OUTSIDE - Static variable in interface org.altbeacon.beacon.MonitorNotifier

Indicates the Android device is outside the Region of beacons

P

parse(byte[], int) - Static method in class org.altbeacon.bluetooth.Pdu

Parse a PDU from a byte array looking offset by startIndex

parse(String) - Static method in class org.altbeacon.beacon.Identifier

Takes the passed string and tries to figure out what format it is in.

parse(String, int) - Static method in class org.altbeacon.beacon.Identifier

Variant of the parse method that allows specifying the byte length of the identifier.

Pdu - Class in org.altbeacon.bluetooth

Converts a byte string from a Bluetooth LE scan into a Payload Data Unit (PDU) Created by dyoung on 4/14/15.

Pdu() - Constructor for class org.altbeacon.bluetooth.Pdu

ProcessUtils - Class in org.altbeacon.beacon.utils

Created by dyoung on 3/10/17.

ProcessUtils(Context) - Constructor for class org.altbeacon.beacon.utils.ProcessUtils

R

RANGE_NOTIFICATION - Static variable in class org.altbeacon.beacon.BeaconLocalBroadcastProcessor

RangedBeacon - Class in org.altbeacon.beacon.service

RangedBeacon(Beacon) - Constructor for class org.altbeacon.beacon.service.RangedBeacon

RangeNotifier - Interface in org.altbeacon.beacon

This interface is implemented by classes that receive beacon ranging notifications

rangeNotifiers - Variable in class org.altbeacon.beacon.BeaconManager

RangeState - Class in org.altbeacon.beacon.service

RangeState(Callback) - Constructor for class org.altbeacon.beacon.service.RangeState

RangingData - Class in org.altbeacon.beacon.service

Internal class used to transfer ranging data between the BeaconService and the client

RangingData(Collection<Beacon>, Region) - Constructor for class org.altbeacon.beacon.service.RangingData

recordDetection() - Method in class org.altbeacon.beacon.service.DetectionTracker

Region - Class in org.altbeacon.beacon

This class represents a criteria of fields used to match beacons.

Region(Parcel) - Constructor for class org.altbeacon.beacon.Region

Region(String, String) - Constructor for class org.altbeacon.beacon.Region

Constructs a new Region object to be used for Ranging or Monitoring

Region(String, List<Identifier>) - Constructor for class org.altbeacon.beacon.Region

Constructs a new Region object to be used for Ranging or Monitoring

Region(String, List<Identifier>, String) - Constructor for class org.altbeacon.beacon.Region

Constructs a new Region object to be used for Ranging or Monitoring

Region(String, Identifier, Identifier, Identifier) - Constructor for class org.altbeacon.beacon.Region

Constructs a new Region object to be used for Ranging or Monitoring

RegionBootstrap - Class in org.altbeacon.beacon.startup

Class allowing a user to set up background launching of an app when a user enters a beacon Region.

RegionBootstrap(Context, MonitorNotifier, List<Region>) - Constructor for class org.altbeacon.beacon.startup.RegionBootstrap

Constructor to bootstrap your Application on an entry/exit from multiple regions

RegionBootstrap(Context, MonitorNotifier, Region) - Constructor for class org.altbeacon.beacon.startup.RegionBootstrap

Constructor to bootstrap your Application on an entry/exit from a single region.

RegionBootstrap(BootstrapNotifier, List<Region>) - Constructor for class org.altbeacon.beacon.startup.RegionBootstrap

Constructor to bootstrap your Application on an entry/exit from multiple regions

RegionBootstrap(BootstrapNotifier, Region) - Constructor for class org.altbeacon.beacon.startup.RegionBootstrap

Constructor to bootstrap your Application on an entry/exit from a single region.

RegionMonitoringState - Class in org.altbeacon.beacon.service

RegionMonitoringState(Callback) - Constructor for class org.altbeacon.beacon.service.RegionMonitoringState

regions() - Method in class org.altbeacon.beacon.service.MonitoringStatus

regionsCount() - Method in class org.altbeacon.beacon.service.MonitoringStatus

register() - Method in class org.altbeacon.beacon.BeaconLocalBroadcastProcessor

reloadParsers() - Method in class org.altbeacon.beacon.service.BeaconService

removeAllMonitorNotifiers() - Method in class org.altbeacon.beacon.BeaconManager

Remove all the Monitor Notifiers.

removeAllRangeNotifiers() - Method in class org.altbeacon.beacon.BeaconManager

Remove all the Range Notifiers.

removeLocalRegion(Region) - Method in class org.altbeacon.beacon.service.MonitoringStatus

removeMonitoreNotifier(MonitorNotifier) - Method in class org.altbeacon.beacon.BeaconManager

Deprecated.

Misspelled. Replaced by BeaconManager.removeMonitorNotifier(org.altbeacon.beacon.MonitorNotifier)

removeMonitorNotifier(MonitorNotifier) - Method in class org.altbeacon.beacon.BeaconManager

Specifies a class to remove from the array of MonitorNotifier.

removeRangeNotifier(RangeNotifier) - Method in class org.altbeacon.beacon.BeaconManager

Specifies a class to remove from the array of RangeNotifier

removeRegion(Region) - Method in class org.altbeacon.beacon.service.MonitoringStatus

removeRegion(Region) - Method in class org.altbeacon.beacon.startup.RegionBootstrap

Remove a given region

request() - Method in class org.altbeacon.beacon.distance.DistanceConfigFetcher

requestBeaconData(Beacon, BeaconDataNotifier) - Method in interface org.altbeacon.beacon.client.BeaconDataFactory

Asynchronous call When data is available, it is passed back to the beaconDataNotifier interface

requestBeaconData(Beacon, BeaconDataNotifier) - Method in class org.altbeacon.beacon.client.NullBeaconDataFactory

requestData(BeaconDataNotifier) - Method in class org.altbeacon.beacon.Beacon

Requests server-side data for this beacon.

requestStateForRegion(Region) - Method in class org.altbeacon.beacon.BeaconManager

Requests the current in/out state on the specified region.

restore(Context) - Static method in class org.altbeacon.beacon.service.ScanState

restoreMonitoringStatus() - Method in class org.altbeacon.beacon.service.MonitoringStatus

RssiFilter - Interface in org.altbeacon.beacon.service

Interface that can be implemented to overwrite measurement and filtering of RSSI values

rssiFilterImplClass - Static variable in class org.altbeacon.beacon.BeaconManager

Default class for rssi filter/calculation implementation

RunningAverageRssiFilter - Class in org.altbeacon.beacon.service

Calculate a RSSI value on base of an arbitrary list of measured RSSI values The list is clipped by a certain length at start and end and the average is calculate by simple arithmetic average

RunningAverageRssiFilter() - Constructor for class org.altbeacon.beacon.service.RunningAverageRssiFilter

runScanTest(Context) - Method in class org.altbeacon.bluetooth.BluetoothMedic

Starts up a brief blueooth scan with the intent of seeing if it results in an error condition indicating the bluetooth stack may be in a bad state.

runTransmitterTest(Context) - Method in class org.altbeacon.bluetooth.BluetoothMedic

Starts up a beacon transmitter with the intent of seeing if it results in an error condition indicating the bluetooth stack may be in a bad state.

S

Sample() - Constructor for class org.altbeacon.beacon.service.Stats.Sample

sampleStartTime - Variable in class org.altbeacon.beacon.service.Stats.Sample

sampleStopTime - Variable in class org.altbeacon.beacon.service.Stats.Sample

save() - Method in class org.altbeacon.beacon.service.ScanState

saveMonitoringStatusIfOn() - Method in class org.altbeacon.beacon.service.MonitoringStatus

SCAN_TEST - Static variable in class org.altbeacon.bluetooth.BluetoothMedic

Indicates that the bluetooth scan test should be run by the BluetoothTestJob

ScanFilterUtils - Class in org.altbeacon.beacon.service.scanner

Created by dyoung on 1/12/15.

ScanFilterUtils() - Constructor for class org.altbeacon.beacon.service.scanner.ScanFilterUtils

ScanJob - Class in org.altbeacon.beacon.service

Used to perform scans periodically using the JobScheduler Only one instance of this will be active, even with multiple jobIds.

ScanJob() - Constructor for class org.altbeacon.beacon.service.ScanJob

ScanJobScheduler - Class in org.altbeacon.beacon.service

Schedules two types of ScanJobs: 1.

scanLeDevice(Boolean) - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner

ScanState - Class in org.altbeacon.beacon.service

Stores the full state of scanning for the libary, including all settings so it can be ressurrected easily for running from a scheduled job Created by dyoung on 3/26/17.

ScanState(Context) - Constructor for class org.altbeacon.beacon.service.ScanState

scheduleAfterBackgroundWakeup(Context, List<ScanResult>) - Method in class org.altbeacon.beacon.service.ScanJobScheduler

scheduleScanCycleStop() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner

sDistanceCalculator - Static variable in class org.altbeacon.beacon.Beacon

ServiceNotDeclaredException() - Constructor for exception org.altbeacon.beacon.BeaconManager.ServiceNotDeclaredException

set(String, String) - Method in interface org.altbeacon.beacon.BeaconData

setAdvertiseMode(int) - Method in class org.altbeacon.beacon.BeaconTransmitter

AdvertiseSettings.ADVERTISE_MODE_BALANCED 3 Hz AdvertiseSettings.ADVERTISE_MODE_LOW_LATENCY 10 Hz AdvertiseSettings.ADVERTISE_MODE_LOW_POWER 1 Hz

setAdvertiseTxPowerLevel(int) - Method in class org.altbeacon.beacon.BeaconTransmitter

AdvertiseSettings.ADVERTISE_TX_POWER_HIGH -56 dBm @ 1 meter with Nexus 5 AdvertiseSettings.ADVERTISE_TX_POWER_LOW -75 dBm @ 1 meter with Nexus 5 AdvertiseSettings.ADVERTISE_TX_POWER_MEDIUM -66 dBm @ 1 meter with Nexus 5 AdvertiseSettings.ADVERTISE_TX_POWER_ULTRA_LOW not detected with Nexus 5

setAllowPduOverflow(Boolean) - Method in class org.altbeacon.beacon.BeaconParser

Setting to true indicates that packets should be rejected if the PDU length is too short for the fields.

setAndroidLScanningDisabled(boolean) - Static method in class org.altbeacon.beacon.BeaconManager

Allows disabling use of Android L BLE Scanning APIs on devices with API 21+ If set to false (default), devices with API 21+ will use the Android L APIs to scan for beacons

setBackgroundBetweenScanPeriod(long) - Method in class org.altbeacon.beacon.BeaconManager

Sets the duration in milliseconds spent not scanning between each Bluetooth LE scan cycle when no ranging/monitoring clients are in the foreground

setBackgroundBetweenScanPeriod(Long) - Method in class org.altbeacon.beacon.service.ScanState

setBackgroundMode(boolean) - Method in class org.altbeacon.beacon.BeaconManager

This method notifies the beacon service that the application is either moving to background mode or foreground mode.

setBackgroundMode(Boolean) - Method in class org.altbeacon.beacon.service.ScanState

setBackgroundScanPeriod(long) - Method in class org.altbeacon.beacon.BeaconManager

Sets the duration in milliseconds of each Bluetooth LE scan cycle to look for beacons.

setBackgroundScanPeriod(Long) - Method in class org.altbeacon.beacon.service.ScanState

setBeacon(Beacon) - Method in class org.altbeacon.beacon.BeaconTransmitter

Sets the beacon whose fields will be transmitted

setBeaconLayout(String) - Method in class org.altbeacon.beacon.BeaconParser

Defines a beacon field parsing algorithm based on a string designating the zero-indexed offsets to bytes within a BLE advertisement.

setBeaconParser(BeaconParser) - Method in class org.altbeacon.beacon.BeaconTransmitter

Sets the beaconParsser used for formatting the transmission

setBeaconParsers(Set<BeaconParser>) - Method in class org.altbeacon.beacon.service.ScanState

setBeacons(List<Beacon>) - Method in class org.altbeacon.beacon.simulator.StaticBeaconSimulator

setBeaconSimulator(BeaconSimulator) - Static method in class org.altbeacon.beacon.BeaconManager

setBeaconTypeCode(int) - Method in class org.altbeacon.beacon.Beacon.Builder

setBluetoothAddress(String) - Method in class org.altbeacon.beacon.Beacon.Builder

setBluetoothName(String) - Method in class org.altbeacon.beacon.Beacon.Builder

setBuildNumber(String) - Method in class org.altbeacon.beacon.distance.AndroidModel

setConnectable(boolean) - Method in class org.altbeacon.beacon.BeaconTransmitter

Whether the advertisement should indicate the device is connectable.

setDataFields(List<Long>) - Method in class org.altbeacon.beacon.Beacon.Builder

setDataRequestNotifier(RangeNotifier) - Method in class org.altbeacon.beacon.BeaconManager

setDebug(boolean) - Static method in class org.altbeacon.beacon.BeaconManager

Set to true if you want to show library debugging.

setDEFAULT_ARMA_SPEED(double) - Static method in class org.altbeacon.beacon.service.ArmaRssiFilter

setDistanceCalculator(DistanceCalculator) - Static method in class org.altbeacon.beacon.Beacon

Sets the DistanceCalculator to use with this beacon

setDistanceModelUpdateUrl(String) - Static method in class org.altbeacon.beacon.BeaconManager

setDistinctPacketsDetectedPerScan(boolean) - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner

setEnabled(boolean) - Method in class org.altbeacon.beacon.service.Stats

setEnableScheduledScanJobs(boolean) - Method in class org.altbeacon.beacon.BeaconManager

Configures using a `ScanJob` run with the `JobScheduler` to perform scans rather than using a long-running `BeaconService` to do so.

setExtraBeaconDataTracker(ExtraDataBeaconTracker) - Method in class org.altbeacon.beacon.service.ScanState

setExtraDataFields(List<Long>) - Method in class org.altbeacon.beacon.Beacon.Builder

setExtraDataFields(List<Long>) - Method in class org.altbeacon.beacon.Beacon

Sets extra data fields

setFirstCycleDetectionTimestamp(long) - Method in class org.altbeacon.beacon.Beacon

Sets the timestamp of the first packet detected

setForegroundBetweenScanPeriod(long) - Method in class org.altbeacon.beacon.BeaconManager

Sets the duration in milliseconds between each Bluetooth LE scan cycle to look for beacons.

setForegroundBetweenScanPeriod(Long) - Method in class org.altbeacon.beacon.service.ScanState

setForegroundScanPeriod(long) - Method in class org.altbeacon.beacon.BeaconManager

Sets the duration in milliseconds of each Bluetooth LE scan cycle to look for beacons.

setForegroundScanPeriod(Long) - Method in class org.altbeacon.beacon.service.ScanState

setHardwareAssistManufacturerCodes(int[]) - Method in class org.altbeacon.beacon.BeaconParser

Sets a list of Bluetooth manufacturer codes which will be used for hardware-assisted accelerated looking for this beacon type The possible codes are defined on this list: https://www.bluetooth.org/en-us/specification/assigned-numbers/company-identifiers

setHardwareEqualityEnforced(boolean) - Static method in class org.altbeacon.beacon.Beacon

Configures whether a the bluetoothAddress (mac address) must be the same for two Beacons to be configured equal.

setHistoricalLoggingEnabled(boolean) - Method in class org.altbeacon.beacon.service.Stats

setId1(String) - Method in class org.altbeacon.beacon.Beacon.Builder

Convenience method allowing the first beacon identifier to be set as a String.

setId2(String) - Method in class org.altbeacon.beacon.Beacon.Builder

Convenience method allowing the second beacon identifier to be set as a String.

setId3(String) - Method in class org.altbeacon.beacon.Beacon.Builder

Convenience method allowing the third beacon identifier to be set as a String.

setIdentifiers(List<Identifier>) - Method in class org.altbeacon.beacon.Beacon.Builder

setLastCycleDetectionTimestamp(long) - Method in class org.altbeacon.beacon.Beacon

Sets the timestamp of the last packet detected

setLastScanStartTimeMillis(long) - Method in class org.altbeacon.beacon.service.ScanState

setLatitude(Double) - Method in interface org.altbeacon.beacon.BeaconData

setLogger(Logger) - Static method in class org.altbeacon.beacon.logging.LogManager

Set the logger that the Altbeacon library will use to send it's log messages to.

setLoggingEnabled(boolean) - Method in class org.altbeacon.beacon.service.Stats

setLongitude(Double) - Method in interface org.altbeacon.beacon.BeaconData

setLongScanForcingEnabled(boolean) - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner

Enables the scanner to go to extra lengths to keep scans going for longer than would otherwise be allowed.

setManifestCheckingDisabled(boolean) - Static method in class org.altbeacon.beacon.BeaconManager

Allows disabling check of manifest for proper configuration of service.

setManufacturer(int) - Method in class org.altbeacon.beacon.Beacon.Builder

setManufacturer(String) - Method in class org.altbeacon.beacon.distance.AndroidModel

setMatchingBeaconTypeCode(Long) - Method in class org.altbeacon.beacon.BeaconParser

setMaxTrackinAge(int) - Static method in class org.altbeacon.beacon.service.RangedBeacon

setMaxTrackingAge(int) - Method in class org.altbeacon.beacon.BeaconManager

Set the period of time, in which a beacon did not receive new measurements

setMfgReserved(int) - Method in class org.altbeacon.beacon.AltBeacon.Builder

setModel(String) - Method in class org.altbeacon.beacon.distance.AndroidModel

setMonitoringStatus(MonitoringStatus) - Method in class org.altbeacon.beacon.service.ScanState

setMonitorNotifier(MonitorNotifier) - Method in class org.altbeacon.beacon.BeaconManager

Deprecated.

replaced by BeaconManager.addMonitorNotifier(org.altbeacon.beacon.MonitorNotifier)

setMultiFrameBeacon(boolean) - Method in class org.altbeacon.beacon.Beacon.Builder

setNonBeaconLeScanCallback(NonBeaconLeScanCallback) - Method in class org.altbeacon.beacon.BeaconManager

setNotificationsEnabled(boolean, int) - Method in class org.altbeacon.bluetooth.BluetoothMedic

Configure whether to send user-visible notification warnings when bluetooth power is cycled.

setOverrideImmediateScanJobId(int) - Static method in class org.altbeacon.beacon.service.ScanJob

Allows configuration of the job id for the Android Job Scheduler.

setOverrideJobId(int) - Static method in class org.altbeacon.bluetooth.BluetoothTestJob

Allows configuration of the job id for the Android Job Scheduler.

setOverridePeriodicScanJobId(int) - Static method in class org.altbeacon.beacon.service.ScanJob

Allows configuration of the job id for the Android Job Scheduler.

setPacketCount(int) - Method in class org.altbeacon.beacon.Beacon

Sets the packet detections in the last ranging cycle

setParserIdentifier(String) - Method in class org.altbeacon.beacon.Beacon.Builder

setRangedRegionState(Map<Region, RangeState>) - Method in class org.altbeacon.beacon.service.ScanState

setRangeNotifier(RangeNotifier) - Method in class org.altbeacon.beacon.BeaconManager

Deprecated.

replaced by (@link #addRangeNotifier)

setRegionExitPeriod(long) - Static method in class org.altbeacon.beacon.BeaconManager

Set region exit period in milliseconds

setRegionStatePeristenceEnabled(boolean) - Method in class org.altbeacon.beacon.BeaconManager

Deprecated.

Misspelled. Replaced by BeaconManager.setRegionStatePersistenceEnabled(boolean)

setRegionStatePersistenceEnabled(boolean) - Method in class org.altbeacon.beacon.BeaconManager

Turns off saving the state of monitored regions to persistent storage so it is retained over app restarts.

setRssi(int) - Method in class org.altbeacon.beacon.Beacon.Builder

setRssi(int) - Method in class org.altbeacon.beacon.Beacon

Sets the most recently measured rssi for use in distance calculations if a running average is not available

setRssiFilterImplClass(Class) - Static method in class org.altbeacon.beacon.BeaconManager

setRssiMeasurementCount(int) - Method in class org.altbeacon.beacon.Beacon

Sets the measurement count that went into the rssi sample

setRunningAverageRssi(double) - Method in class org.altbeacon.beacon.Beacon.Builder

setRunningAverageRssi(double) - Method in class org.altbeacon.beacon.Beacon

Sets the running average rssi for use in distance calculations

setSampleExpirationMilliseconds(long) - Static method in class org.altbeacon.beacon.service.RangedBeacon

setSampleExpirationMilliseconds(long) - Static method in class org.altbeacon.beacon.service.RunningAverageRssiFilter

setSampleIntervalMillis(long) - Method in class org.altbeacon.beacon.service.Stats

setScannerInSameProcess(boolean) - Method in class org.altbeacon.beacon.BeaconManager

Reserved for internal use by the library.

setScanPeriods(long, long, boolean) - Method in class org.altbeacon.beacon.service.BeaconService

setScanPeriods(long, long, boolean) - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner

Tells the cycler the scan rate and whether it is in operating in background mode.

setServiceUuid(int) - Method in class org.altbeacon.beacon.Beacon.Builder

setsManifestCheckingDisabled(boolean) - Static method in class org.altbeacon.beacon.BeaconManager

Deprecated.

SettingsData - Class in org.altbeacon.beacon.service

Created by dyoung on 3/10/17.

SettingsData() - Constructor for class org.altbeacon.beacon.service.SettingsData

setTracked(boolean) - Method in class org.altbeacon.beacon.service.RangedBeacon

setTxPower(int) - Method in class org.altbeacon.beacon.Beacon.Builder

setUpdateNotifier(BluetoothCrashResolver.UpdateNotifier) - Method in class org.altbeacon.bluetooth.BluetoothCrashResolver

setUseTrackingCache(boolean) - Static method in class org.altbeacon.beacon.BeaconManager

Allow the library to use a tracking cache

setUseTrackingCache(boolean) - Static method in class org.altbeacon.beacon.service.RangeState

setVerboseLoggingEnabled(boolean) - Static method in class org.altbeacon.beacon.logging.LogManager

Sets whether verbose logging is enabled.

setVersion(String) - Method in class org.altbeacon.beacon.distance.AndroidModel

setWakeUpAlarm() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner

sHardwareEqualityEnforced - Static variable in class org.altbeacon.beacon.Beacon

Determines whether a the bluetoothAddress (mac address) must be the same for two Beacons to be configured equal.

sInstance - Static variable in class org.altbeacon.beacon.BeaconManager

start() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner

start() - Method in class org.altbeacon.bluetooth.BluetoothCrashResolver

Starts looking for crashes of the Bluetooth LE system and taking proactive steps to stop crashes from happening.

startAdvertising() - Method in class org.altbeacon.beacon.BeaconTransmitter

Starts this beacon advertising

startAdvertising(Beacon) - Method in class org.altbeacon.beacon.BeaconTransmitter

Starts advertising with fields from the passed beacon

startAdvertising(Beacon, AdvertiseCallback) - Method in class org.altbeacon.beacon.BeaconTransmitter

Starts advertising with fields from the passed beacon

startMonitoringBeaconsInRegion(List<Region>) - Method in class org.altbeacon.beacon.BeaconManager

startMonitoringBeaconsInRegion(Region) - Method in class org.altbeacon.beacon.BeaconManager

Tells the BeaconService to start looking for beacons that match the passed Region object.

startMonitoringBeaconsInRegion(Region, Callback) - Method in class org.altbeacon.beacon.service.BeaconService

startRangingBeaconsInRegion(List<Region>) - Method in class org.altbeacon.beacon.BeaconManager

startRangingBeaconsInRegion(Region) - Method in class org.altbeacon.beacon.BeaconManager

Tells the BeaconService to start looking for beacons that match the passed Region object, and providing updates on the estimated mDistance every seconds while beacons in the Region are visible.

startRangingBeaconsInRegion(Region, Callback) - Method in class org.altbeacon.beacon.service.BeaconService

methods for clients

StartRMData - Class in org.altbeacon.beacon.service

Internal class used to transfer ranging and monitoring data between the BeaconService and client

StartRMData(long, long, boolean) - Constructor for class org.altbeacon.beacon.service.StartRMData

StartRMData(Region, String) - Constructor for class org.altbeacon.beacon.service.StartRMData

StartRMData(Region, String, long, long, boolean) - Constructor for class org.altbeacon.beacon.service.StartRMData

startScan() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner

startScan() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScannerForJellyBeanMr2

startScan() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScannerForLollipop

startStatusPreservation() - Method in class org.altbeacon.beacon.service.MonitoringStatus

Client applications should not call directly.

StartupBroadcastReceiver - Class in org.altbeacon.beacon.startup

StartupBroadcastReceiver() - Constructor for class org.altbeacon.beacon.startup.StartupBroadcastReceiver

stateOf(Region) - Method in class org.altbeacon.beacon.service.MonitoringStatus

StaticBeaconSimulator - Class in org.altbeacon.beacon.simulator

Created by dyoung on 4/18/14.

StaticBeaconSimulator() - Constructor for class org.altbeacon.beacon.simulator.StaticBeaconSimulator

Stats - Class in org.altbeacon.beacon.service

Stats module used for internal performance testing of the library Created by dyoung on 10/16/14.

Stats.Sample - Class in org.altbeacon.beacon.service

STATUS_PRESERVATION_FILE_NAME - Static variable in class org.altbeacon.beacon.service.MonitoringStatus

stop() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner

stop() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScannerForLollipop

stop() - Method in class org.altbeacon.bluetooth.BluetoothCrashResolver

Stops looking for crashes.

stopAdvertising() - Method in class org.altbeacon.beacon.BeaconTransmitter

Stops this beacon from advertising

stopAllMonitoringBeaconsInRegion() - Method in class org.altbeacon.beacon.BeaconManager

stopAllRangingBeaconsInRegion() - Method in class org.altbeacon.beacon.BeaconManager

stopMonitoringBeaconsInRegion(List<Region>) - Method in class org.altbeacon.beacon.BeaconManager

stopMonitoringBeaconsInRegion(Region) - Method in class org.altbeacon.beacon.BeaconManager

Tells the BeaconService to stop looking for beacons that match the passed Region object.

stopMonitoringBeaconsInRegion(Region) - Method in class org.altbeacon.beacon.service.BeaconService

stopRangingBeaconsInRegion(List<Region>) - Method in class org.altbeacon.beacon.BeaconManager

stopRangingBeaconsInRegion(Region) - Method in class org.altbeacon.beacon.BeaconManager

Tells the BeaconService to stop looking for beacons that match the passed Region object and providing mDistance information for them.

stopRangingBeaconsInRegion(Region) - Method in class org.altbeacon.beacon.service.BeaconService

stopScan() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner

stopScan() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScannerForJellyBeanMr2

stopScan() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScannerForLollipop

stopStatusPreservation() - Method in class org.altbeacon.beacon.service.MonitoringStatus

Client applications should not call directly.

SUPPORTED - Static variable in class org.altbeacon.beacon.BeaconTransmitter

sync(BeaconDataNotifier) - Method in interface org.altbeacon.beacon.BeaconData

syncSettingsToService() - Method in class org.altbeacon.beacon.BeaconManager

T

TAG - Static variable in class org.altbeacon.beacon.AltBeaconParser

TAG - Static variable in class org.altbeacon.beacon.distance.CurveFittedDistanceCalculator

TAG - Static variable in class org.altbeacon.beacon.service.BeaconService

TAG - Static variable in class org.altbeacon.beacon.service.scanner.ScanFilterUtils

TAG - Static variable in class org.altbeacon.beacon.startup.RegionBootstrap

toBundle() - Method in class org.altbeacon.beacon.service.MonitoringData

toBundle() - Method in class org.altbeacon.beacon.service.RangingData

toBundle() - Method in class org.altbeacon.beacon.service.SettingsData

toBundle() - Method in class org.altbeacon.beacon.service.StartRMData

toByteArray() - Method in class org.altbeacon.beacon.Identifier

Gives you the byte array backing this Identifier.

toByteArrayOfSpecifiedEndianness(boolean) - Method in class org.altbeacon.beacon.Identifier

Converts identifier to a byte array

toHexString() - Method in class org.altbeacon.beacon.Identifier

Represents the value as a hexadecimal String.

toInt() - Method in class org.altbeacon.beacon.Identifier

Represents the value as an int.

toString() - Method in class org.altbeacon.beacon.Beacon

Formats a beacon as a string showing only its unique identifiers

toString() - Method in class org.altbeacon.beacon.distance.AndroidModel

toString() - Method in class org.altbeacon.beacon.Identifier

Represents the value as a String.

toString() - Method in class org.altbeacon.beacon.Region

toUuid() - Method in class org.altbeacon.beacon.Identifier

Gives you the Identifier as a UUID if possible.

toUuidString() - Method in class org.altbeacon.beacon.Identifier

Deprecated.

Replaced by stronger typed variant. This mathod returns a string, therefore does not offer type safety on the UUID per se. It was replaced by Identifier.toUuid().

track(Beacon) - Method in class org.altbeacon.beacon.service.ExtraDataBeaconTracker

Tracks a beacon.

TRANSMIT_TEST - Static variable in class org.altbeacon.bluetooth.BluetoothMedic

Indicates that the transmitter test should be run by the BluetoothTestJob

U

unbind(BeaconConsumer) - Method in class org.altbeacon.beacon.BeaconManager

Unbinds an Android Activity or Service to the BeaconService.

unbindService(ServiceConnection) - Method in interface org.altbeacon.beacon.BeaconConsumer

Called by the BeaconManager to unbind your BeaconConsumer to the BeaconService.

uncompress(byte[]) - Static method in class org.altbeacon.beacon.utils.UrlBeaconUrlCompressor

unregister() - Method in class org.altbeacon.beacon.BeaconLocalBroadcastProcessor

updateBeacon(Beacon) - Method in class org.altbeacon.beacon.service.RangedBeacon

updateLocalState(Region, Integer) - Method in class org.altbeacon.beacon.service.MonitoringStatus

updateMonitoringStatusTime(long) - Method in class org.altbeacon.beacon.service.MonitoringStatus

updateNewlyInsideInRegionsContaining(Beacon) - Method in class org.altbeacon.beacon.service.MonitoringStatus

updateNewlyOutside() - Method in class org.altbeacon.beacon.service.MonitoringStatus

updateScanPeriods() - Method in class org.altbeacon.beacon.BeaconManager

Updates an already running scan with scanPeriod/betweenScanPeriod according to Background/Foreground state.

URI_BEACON_LAYOUT - Static variable in class org.altbeacon.beacon.BeaconParser

UrlBeaconUrlCompressor - Class in org.altbeacon.beacon.utils

Provides encoding / decoding functions for the URL beacon https://github.com/google/uribeacon

UrlBeaconUrlCompressor() - Constructor for class org.altbeacon.beacon.utils.UrlBeaconUrlCompressor

V

v(String, String, Object...) - Method in interface org.altbeacon.beacon.logging.Logger

Send a verbose log message.

v(String, String, Object...) - Static method in class org.altbeacon.beacon.logging.LogManager

Send a verbose log message to the logger.

v(Throwable, String, String, Object...) - Method in interface org.altbeacon.beacon.logging.Logger

Send a verbose log message.

v(Throwable, String, String, Object...) - Static method in class org.altbeacon.beacon.logging.LogManager

Send a verbose log message to the logger.

verboseLogger() - Static method in class org.altbeacon.beacon.logging.Loggers

W

w(String, String, Object...) - Method in interface org.altbeacon.beacon.logging.Logger

Send a warning log message.

w(String, String, Object...) - Static method in class org.altbeacon.beacon.logging.LogManager

Send a warning log message to the logger.

w(Throwable, String, String, Object...) - Method in interface org.altbeacon.beacon.logging.Logger

Send a warning log message.

w(Throwable, String, String, Object...) - Static method in class org.altbeacon.beacon.logging.LogManager

Send a warning log message to the logger.

warningLogger() - Static method in class org.altbeacon.beacon.logging.Loggers

writeToParcel(Parcel, int) - Method in class org.altbeacon.beacon.AltBeacon

Required for making object Parcelable

writeToParcel(Parcel, int) - Method in class org.altbeacon.beacon.Beacon

Deprecated.

writeToParcel(Parcel, int) - Method in class org.altbeacon.beacon.Region

writeToParcel(Parcel, int) - Method in class org.altbeacon.beacon.service.StartRMData

A B C D E F G H I L M N O P R S T U V W
All Classes All Packages