com.estimote.sdk.service

Class BeaconService

java.lang.Object

android.content.Context

android.content.ContextWrapper

android.app.Service

com.estimote.sdk.service.BeaconService

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.ComponentCallbacks2

public class BeaconService
extends android.app.Service

Don't use this class directly, use it via BeaconManager.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BeaconService.ScanAlarmBroadcastReceiver

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_BLUETOOTH_SCANNER_UNSTABLE Happens when Bluetooth service is crashing frequently.
static int	ERROR_COULD_NOT_START_LOW_ENERGY_SCANNING Happens when Bluetooth service for some reason does not want to start low energy scanning.
static java.lang.String	ERROR_ID_KEY Key to data where Integer (error id) is stored.
static java.lang.String	MONITORING_RESULT_KEY Key to data where MonitoringResult is stored.
static int	MSG_EDDYSTONE_SCAN_RESPONSE Service sends Eddystone scanning result.
static int	MSG_ERROR_RESPONSE Service sends error.
static int	MSG_LOCATIONS_SCAN_RESPONSE Service sends Esitmote Location scanning result.
static int	MSG_MONITORING_RESPONSE Service sends monitoring results.
static int	MSG_NEARABLE_SCAN_RESPONSE Service sends Nearable scanning result.
static int	MSG_RANGING_RESPONSE Service sends ranging results.
static int	MSG_REGISTER_ERROR_LISTENER Service registers error listener where errors can be send.
static int	MSG_REGISTER_SCAN_STATUS_LISTENER Starts Bluetooth scanning.
static int	MSG_SCAN_STARTED Starts Bluetooth scanning.
static int	MSG_SCAN_STOPPED Starts Bluetooth scanning.
static int	MSG_SET_BACKGROUND_SCAN_PERIOD Sets scan periods for monitoring, that is when app is in foreground.
static int	MSG_SET_FOREGROUND_SCAN_PERIOD Sets scan periods for ranging, that is when app is in foreground.
static int	MSG_SET_REGION_EXIT_EXPIRATION Starts Bluetooth scanning.
static int	MSG_START_EDDYSTONE_SCANNING Starts Eddystone scanning.
static int	MSG_START_LOCATION_SCANNING Starts Esitmote Location scanning.
static int	MSG_START_MONITORING Service starts monitoring region.
static int	MSG_START_NEARABLE_SCANNING Starts Nearable scanning.
static int	MSG_START_RANGING Service starts ranging region.
static int	MSG_START_TELEMETRY_SCANNING Starts Telemetry scanning.
static int	MSG_STOP_EDDYSTONE_SCANNING Stops Eddystone scanning.
static int	MSG_STOP_LOCATION_SCANNING Stops Esitmote Location scanning.
static int	MSG_STOP_MONITORING Service stops monitoring region.
static int	MSG_STOP_NEARABLE_SCANNING Stops Nearable scanning.
static int	MSG_STOP_RANGING Service stops ranging region.
static int	MSG_STOP_TELEMETRY_SCANNING Stops Telemetry scanning.
static int	MSG_TELEMETRY_SCAN_RESPONSE Service sends Telemetry scanning result.
static java.lang.String	RANGING_RESULT_KEY Key to data where RangingResult is stored.
static java.lang.String	REGION_EXIT_EXPIRATION Key to data where Integer (error id) is stored.
static java.lang.String	REGION_ID_KEY Key to data where String (region id) is stored.
static java.lang.String	REGION_KEY Key to data where Region is stored.
static java.lang.String	SCAN_PERIOD_KEY Key to data where ScanPeriodData is stored.

Fields inherited from class android.app.Service

START_CONTINUATION_MASK, START_FLAG_REDELIVERY, START_FLAG_RETRY, START_NOT_STICKY, START_REDELIVER_INTENT, START_STICKY, START_STICKY_COMPATIBILITY, STOP_FOREGROUND_DETACH, STOP_FOREGROUND_REMOVE

Fields inherited from class android.content.Context

ACCESSIBILITY_SERVICE, ACCOUNT_SERVICE, ACTIVITY_SERVICE, ALARM_SERVICE, APP_OPS_SERVICE, APPWIDGET_SERVICE, AUDIO_SERVICE, BATTERY_SERVICE, BIND_ABOVE_CLIENT, BIND_ADJUST_WITH_ACTIVITY, BIND_ALLOW_OOM_MANAGEMENT, BIND_AUTO_CREATE, BIND_DEBUG_UNBIND, BIND_EXTERNAL_SERVICE, BIND_IMPORTANT, BIND_NOT_FOREGROUND, BIND_WAIVE_PRIORITY, BLUETOOTH_SERVICE, CAMERA_SERVICE, CAPTIONING_SERVICE, CARRIER_CONFIG_SERVICE, CLIPBOARD_SERVICE, CONNECTIVITY_SERVICE, CONSUMER_IR_SERVICE, CONTEXT_IGNORE_SECURITY, CONTEXT_INCLUDE_CODE, CONTEXT_RESTRICTED, DEVICE_POLICY_SERVICE, DISPLAY_SERVICE, DOWNLOAD_SERVICE, DROPBOX_SERVICE, FINGERPRINT_SERVICE, HARDWARE_PROPERTIES_SERVICE, INPUT_METHOD_SERVICE, INPUT_SERVICE, JOB_SCHEDULER_SERVICE, KEYGUARD_SERVICE, LAUNCHER_APPS_SERVICE, LAYOUT_INFLATER_SERVICE, LOCATION_SERVICE, MEDIA_PROJECTION_SERVICE, MEDIA_ROUTER_SERVICE, MEDIA_SESSION_SERVICE, MIDI_SERVICE, MODE_APPEND, MODE_ENABLE_WRITE_AHEAD_LOGGING, MODE_MULTI_PROCESS, MODE_NO_LOCALIZED_COLLATORS, MODE_PRIVATE, MODE_WORLD_READABLE, MODE_WORLD_WRITEABLE, NETWORK_STATS_SERVICE, NFC_SERVICE, NOTIFICATION_SERVICE, NSD_SERVICE, POWER_SERVICE, PRINT_SERVICE, RESTRICTIONS_SERVICE, SEARCH_SERVICE, SENSOR_SERVICE, STORAGE_SERVICE, SYSTEM_HEALTH_SERVICE, TELECOM_SERVICE, TELEPHONY_SERVICE, TELEPHONY_SUBSCRIPTION_SERVICE, TEXT_SERVICES_MANAGER_SERVICE, TV_INPUT_SERVICE, UI_MODE_SERVICE, USAGE_STATS_SERVICE, USB_SERVICE, USER_SERVICE, VIBRATOR_SERVICE, WALLPAPER_SERVICE, WIFI_P2P_SERVICE, WIFI_SERVICE, WINDOW_SERVICE

Fields inherited from interface android.content.ComponentCallbacks2

TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN

Constructor Summary

Constructors

Constructor and Description
BeaconService()

Method Summary

Modifier and Type	Method and Description
android.os.IBinder	onBind(android.content.Intent intent)
void	onCreate()
void	onDestroy()
void	onRebind(android.content.Intent intent)
int	onStartCommand(android.content.Intent intent, int flags, int startId)
boolean	onUnbind(android.content.Intent intent)

Methods inherited from class android.app.Service

dump, getApplication, onConfigurationChanged, onLowMemory, onStart, onTaskRemoved, onTrimMemory, startForeground, stopForeground, stopForeground, stopSelf, stopSelf, stopSelfResult

Methods inherited from class android.content.ContextWrapper

attachBaseContext, bindService, checkCallingOrSelfPermission, checkCallingOrSelfUriPermission, checkCallingPermission, checkCallingUriPermission, checkPermission, checkSelfPermission, checkUriPermission, checkUriPermission, clearWallpaper, createConfigurationContext, createDeviceProtectedStorageContext, createDisplayContext, createPackageContext, databaseList, deleteDatabase, deleteFile, deleteSharedPreferences, enforceCallingOrSelfPermission, enforceCallingOrSelfUriPermission, enforceCallingPermission, enforceCallingUriPermission, enforcePermission, enforceUriPermission, enforceUriPermission, fileList, getApplicationContext, getApplicationInfo, getAssets, getBaseContext, getCacheDir, getClassLoader, getCodeCacheDir, getContentResolver, getDatabasePath, getDataDir, getDir, getExternalCacheDir, getExternalCacheDirs, getExternalFilesDir, getExternalFilesDirs, getExternalMediaDirs, getFilesDir, getFileStreamPath, getMainLooper, getNoBackupFilesDir, getObbDir, getObbDirs, getPackageCodePath, getPackageManager, getPackageName, getPackageResourcePath, getResources, getSharedPreferences, getSystemService, getSystemServiceName, getTheme, getWallpaper, getWallpaperDesiredMinimumHeight, getWallpaperDesiredMinimumWidth, grantUriPermission, isDeviceProtectedStorage, isRestricted, moveDatabaseFrom, moveSharedPreferencesFrom, openFileInput, openFileOutput, openOrCreateDatabase, openOrCreateDatabase, peekWallpaper, registerReceiver, registerReceiver, removeStickyBroadcast, removeStickyBroadcastAsUser, revokeUriPermission, sendBroadcast, sendBroadcast, sendBroadcastAsUser, sendBroadcastAsUser, sendOrderedBroadcast, sendOrderedBroadcast, sendOrderedBroadcastAsUser, sendStickyBroadcast, sendStickyBroadcastAsUser, sendStickyOrderedBroadcast, sendStickyOrderedBroadcastAsUser, setTheme, setWallpaper, setWallpaper, startActivities, startActivities, startActivity, startActivity, startInstrumentation, startIntentSender, startIntentSender, startService, stopService, unbindService, unregisterReceiver

Methods inherited from class android.content.Context

getColor, getColorStateList, getDrawable, getString, getString, getSystemService, getText, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, registerComponentCallbacks, unregisterComponentCallbacks

Methods inherited from class java.lang.Object

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

Field Detail

MSG_START_RANGING

public static final int MSG_START_RANGING

Service starts ranging region. Message contains Region under REGION_KEY.

See Also:

Constant Field Values

MSG_STOP_RANGING

public static final int MSG_STOP_RANGING

Service stops ranging region. Message contains String (region id) under REGION_ID_KEY.

See Also:

Constant Field Values

MSG_RANGING_RESPONSE

public static final int MSG_RANGING_RESPONSE

Service sends ranging results. Message contains RangingResult under RANGING_RESULT_KEY.

See Also:

Constant Field Values

MSG_START_MONITORING

public static final int MSG_START_MONITORING

Service starts monitoring region. Message contains Region under REGION_KEY.

See Also:

Constant Field Values

MSG_STOP_MONITORING

public static final int MSG_STOP_MONITORING

Service stops monitoring region. Message contains String (region id) under REGION_ID_KEY.

See Also:

Constant Field Values

MSG_START_EDDYSTONE_SCANNING

public static final int MSG_START_EDDYSTONE_SCANNING

Starts Eddystone scanning.

See Also:

Constant Field Values

MSG_EDDYSTONE_SCAN_RESPONSE

public static final int MSG_EDDYSTONE_SCAN_RESPONSE

Service sends Eddystone scanning result. Message contains

See Also:

Constant Field Values

MSG_STOP_EDDYSTONE_SCANNING

public static final int MSG_STOP_EDDYSTONE_SCANNING

Stops Eddystone scanning.

See Also:

Constant Field Values

MSG_START_NEARABLE_SCANNING

public static final int MSG_START_NEARABLE_SCANNING

Starts Nearable scanning.

See Also:

Constant Field Values

MSG_NEARABLE_SCAN_RESPONSE

public static final int MSG_NEARABLE_SCAN_RESPONSE

Service sends Nearable scanning result.

See Also:

Constant Field Values

MSG_STOP_NEARABLE_SCANNING

public static final int MSG_STOP_NEARABLE_SCANNING

Stops Nearable scanning.

See Also:

Constant Field Values

MSG_START_TELEMETRY_SCANNING

public static final int MSG_START_TELEMETRY_SCANNING

Starts Telemetry scanning.

See Also:

Constant Field Values

MSG_TELEMETRY_SCAN_RESPONSE

public static final int MSG_TELEMETRY_SCAN_RESPONSE

Service sends Telemetry scanning result.

See Also:

Constant Field Values

MSG_STOP_TELEMETRY_SCANNING

public static final int MSG_STOP_TELEMETRY_SCANNING

Stops Telemetry scanning.

See Also:

Constant Field Values

MSG_START_LOCATION_SCANNING

public static final int MSG_START_LOCATION_SCANNING

Starts Esitmote Location scanning.

See Also:

Constant Field Values

MSG_LOCATIONS_SCAN_RESPONSE

public static final int MSG_LOCATIONS_SCAN_RESPONSE

Service sends Esitmote Location scanning result.

See Also:

Constant Field Values

MSG_STOP_LOCATION_SCANNING

public static final int MSG_STOP_LOCATION_SCANNING

Stops Esitmote Location scanning.

See Also:

Constant Field Values

MSG_MONITORING_RESPONSE

public static final int MSG_MONITORING_RESPONSE

Service sends monitoring results. Message contains MonitoringResult under MONITORING_RESULT_KEY.

See Also:

Constant Field Values

MSG_REGISTER_ERROR_LISTENER

public static final int MSG_REGISTER_ERROR_LISTENER

Service registers error listener where errors can be send.

See Also:

Constant Field Values

MSG_ERROR_RESPONSE

public static final int MSG_ERROR_RESPONSE

Service sends error. Message contains Integer as error id under ERROR_ID_KEY.

See Also:

Constant Field Values

MSG_SET_FOREGROUND_SCAN_PERIOD

public static final int MSG_SET_FOREGROUND_SCAN_PERIOD

Sets scan periods for ranging, that is when app is in foreground. Message contains ScanPeriodData.

See Also:

Constant Field Values

MSG_SET_BACKGROUND_SCAN_PERIOD

public static final int MSG_SET_BACKGROUND_SCAN_PERIOD

Sets scan periods for monitoring, that is when app is in foreground. Message contains ScanPeriodData.

See Also:

Constant Field Values

MSG_SCAN_STARTED

public static final int MSG_SCAN_STARTED

Starts Bluetooth scanning.

See Also:

Constant Field Values

MSG_SCAN_STOPPED

public static final int MSG_SCAN_STOPPED

Starts Bluetooth scanning.

See Also:

Constant Field Values

MSG_REGISTER_SCAN_STATUS_LISTENER

public static final int MSG_REGISTER_SCAN_STATUS_LISTENER

Starts Bluetooth scanning.

See Also:

Constant Field Values

MSG_SET_REGION_EXIT_EXPIRATION

public static final int MSG_SET_REGION_EXIT_EXPIRATION

Starts Bluetooth scanning.

See Also:

Constant Field Values

ERROR_COULD_NOT_START_LOW_ENERGY_SCANNING

public static final int ERROR_COULD_NOT_START_LOW_ENERGY_SCANNING

Happens when Bluetooth service for some reason does not want to start low energy scanning. It is good indicator to restart Bluetooth stack.

See Also:

Utils.restartBluetooth(Context, com.estimote.sdk.Utils.RestartCompletedListener), Constant Field Values

ERROR_BLUETOOTH_SCANNER_UNSTABLE

public static final int ERROR_BLUETOOTH_SCANNER_UNSTABLE

Happens when Bluetooth service is crashing frequently.

See Also:

Utils.restartBluetooth(Context, com.estimote.sdk.Utils.RestartCompletedListener), Constant Field Values

REGION_KEY

public static final java.lang.String REGION_KEY

Key to data where Region is stored.

See Also:

Constant Field Values

REGION_ID_KEY

public static final java.lang.String REGION_ID_KEY

Key to data where String (region id) is stored.

See Also:

Constant Field Values

RANGING_RESULT_KEY

public static final java.lang.String RANGING_RESULT_KEY

Key to data where RangingResult is stored.

See Also:

Constant Field Values

MONITORING_RESULT_KEY

public static final java.lang.String MONITORING_RESULT_KEY

Key to data where MonitoringResult is stored.

See Also:

Constant Field Values

SCAN_PERIOD_KEY

public static final java.lang.String SCAN_PERIOD_KEY

Key to data where ScanPeriodData is stored.

See Also:

Constant Field Values

ERROR_ID_KEY

public static final java.lang.String ERROR_ID_KEY

Key to data where Integer (error id) is stored.

See Also:

Constant Field Values

REGION_EXIT_EXPIRATION

public static final java.lang.String REGION_EXIT_EXPIRATION

Key to data where Integer (error id) is stored.

See Also:

Constant Field Values

Constructor Detail

BeaconService

public BeaconService()

Method Detail

onCreate

public void onCreate()

Overrides:

onCreate in class android.app.Service

onStartCommand

public int onStartCommand(android.content.Intent intent,
                          int flags,
                          int startId)

Overrides:

onStartCommand in class android.app.Service

onDestroy

public void onDestroy()

Overrides:

onDestroy in class android.app.Service

onBind

public android.os.IBinder onBind(android.content.Intent intent)

Specified by:

onBind in class android.app.Service

onUnbind

public boolean onUnbind(android.content.Intent intent)

Overrides:

onUnbind in class android.app.Service

onRebind

public void onRebind(android.content.Intent intent)

Overrides:

onRebind in class android.app.Service