com.estimote.coresdk.service

Class BeaconService

java.lang.Object

android.content.Context

android.content.ContextWrapper

android.app.Service

com.estimote.coresdk.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.

Author:

wiktor@estimote.com (Wiktor Gworek)

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.

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, SHORTCUT_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
boolean	isActive()
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)
protected void	setBackgroundScanPeriod(ScanPeriodData backgroundScanPeriod)
protected void	setForegroundScanPeriod(ScanPeriodData foregroundScanPeriod)
protected void	setRegionExitExpiration(long regionExitExpiration)
protected void	setScanRequestDelay(long delayMillis)
protected void	startConfigurableDevicesScanning()
protected void	startEddystoneScanning()
protected void	startLocationScanning()
protected void	startMirrorScanning()
protected void	startMonitoring(BeaconRegion region)
protected void	startMonitoring(MirrorRegion region)
protected void	startNearableScanning()
protected void	startRanging(BeaconRegion region)
protected void	startRanging(MirrorRegion region)
protected void	startTelemetryScanning()
protected void	stopConfigurableDevicesScanning()
protected void	stopEddystoneScanning()
protected void	stopLocationScanning()
protected void	stopMirrorScanning()
protected void	stopMonitoring(java.lang.String regionId)
protected void	stopNearableScanning()
protected void	stopRanging(java.lang.String regionId)
protected void	stopTelemetryScanning()

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

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:

Constant Field Values

ERROR_BLUETOOTH_SCANNER_UNSTABLE

public static final int ERROR_BLUETOOTH_SCANNER_UNSTABLE

Happens when Bluetooth service is crashing frequently

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

isActive

public boolean isActive()

setForegroundScanPeriod

protected void setForegroundScanPeriod(ScanPeriodData foregroundScanPeriod)

setBackgroundScanPeriod

protected void setBackgroundScanPeriod(ScanPeriodData backgroundScanPeriod)

setRegionExitExpiration

protected void setRegionExitExpiration(long regionExitExpiration)

setScanRequestDelay

protected void setScanRequestDelay(long delayMillis)

startRanging

protected void startRanging(BeaconRegion region)

startRanging

protected void startRanging(MirrorRegion region)

stopRanging

protected void stopRanging(java.lang.String regionId)

startMonitoring

protected void startMonitoring(BeaconRegion region)

startMonitoring

protected void startMonitoring(MirrorRegion region)

stopMonitoring

protected void stopMonitoring(java.lang.String regionId)

startEddystoneScanning

protected void startEddystoneScanning()

startNearableScanning

protected void startNearableScanning()

startTelemetryScanning

protected void startTelemetryScanning()

startLocationScanning

protected void startLocationScanning()

startMirrorScanning

protected void startMirrorScanning()

startConfigurableDevicesScanning

protected void startConfigurableDevicesScanning()

stopNearableScanning

protected void stopNearableScanning()

stopTelemetryScanning

protected void stopTelemetryScanning()

stopLocationScanning

protected void stopLocationScanning()

stopMirrorScanning

protected void stopMirrorScanning()

stopConfigurableDevicesScanning

protected void stopConfigurableDevicesScanning()

stopEddystoneScanning

protected void stopEddystoneScanning()