DreamService


public class DreamService
extends Service implements Window.Callback

java.lang.Object
   ↳ android.content.Context
     ↳ android.content.ContextWrapper
       ↳ android.app.Service
         ↳ android.service.dreams.DreamService


Extend this class to implement a custom dream (available to the user as a "Daydream").

Dreams are interactive screensavers launched when a charging device is idle, or docked in a desk dock. Dreams provide another modality for apps to express themselves, tailored for an exhibition/lean-back experience.

The DreamService lifecycle is as follows:

  1. onAttachedToWindow()

    Use this for initial setup, such as calling setContentView().

  2. onDreamingStarted()

    Your dream has started, so you should begin animations or other behaviors here.

  3. onDreamingStopped()

    Use this to stop the things you started in onDreamingStarted().

  4. onDetachedFromWindow()

    Use this to dismantle resources (for example, detach from handlers and listeners).

In addition, onCreate and onDestroy (from the Service interface) will also be called, but initialization and teardown should be done by overriding the hooks above.

To be available to the system, your DreamService should be declared in the manifest as follows:

 <service
     android:name=".MyDream"
     android:exported="true"
     android:icon="@drawable/my_icon"
     android:label="@string/my_dream_label" >

     <intent-filter>
         <action android:name="android.service.dreams.DreamService" />
         <category android:name="android.intent.category.DEFAULT" />
     </intent-filter>

     <!-- Point to additional information for this dream (optional) -->
     <meta-data
         android:name="android.service.dream"
         android:resource="@xml/my_dream" />
 </service>
 

If specified with the <meta-data> element, additional information for the dream is defined using the <dream> element in a separate XML file. Currently, the only additional information you can provide is for a settings activity that allows the user to configure the dream behavior. For example:

res/xml/my_dream.xml

 <dream xmlns:android="http://schemas.android.com/apk/res/android"
     android:settingsActivity="com.example.app/.MyDreamSettingsActivity" />
 

This makes a Settings button available alongside your dream's listing in the system settings, which when pressed opens the specified activity.

To specify your dream layout, call setContentView(View), typically during the onAttachedToWindow() callback. For example:

 public class MyDream extends DreamService {

     @Override
     public void onAttachedToWindow() {
         super.onAttachedToWindow();

         // Exit dream upon user touch
         setInteractive(false);
         // Hide system UI
         setFullscreen(true);
         // Set the dream layout
         setContentView(R.layout.dream);
     }
 }
 

When targeting api level 21 and above, you must declare the service in your manifest file with the Manifest.permission.BIND_DREAM_SERVICE permission. For example:

 <service
     android:name=".MyDream"
     android:exported="true"
     android:icon="@drawable/my_icon"
     android:label="@string/my_dream_label"
     android:permission="android.permission.BIND_DREAM_SERVICE">
   <intent-filter>
     <action android:name=\u201dandroid.service.dreams.DreamService\u201d />
     <category android:name=\u201dandroid.intent.category.DEFAULT\u201d />
   </intent-filter>
 </service>
 

Summary

Constants

String DREAM_META_DATA

Name under which a Dream publishes information about itself.

String SERVICE_INTERFACE

The Intent that must be declared as handled by the service.

Inherited constants

int START_CONTINUATION_MASK

Bits returned by onStartCommand(Intent, int, int) describing how to continue the service if it is killed.

int START_FLAG_REDELIVERY

This flag is set in onStartCommand(Intent, int, int) if the Intent is a re-delivery of a previously delivered intent, because the service had previously returned START_REDELIVER_INTENT but had been killed before calling stopSelf(int) for that Intent.

int START_FLAG_RETRY

This flag is set in onStartCommand(Intent, int, int) if the Intent is a retry because the original attempt never got to or returned from onStartCommand(android.content.Intent, int, int).

int START_NOT_STICKY

Constant to return from onStartCommand(Intent, int, int): if this service's process is killed while it is started (after returning from onStartCommand(Intent, int, int)), and there are no new start intents to deliver to it, then take the service out of the started state and don't recreate until a future explicit call to Context.startService(Intent).

int START_REDELIVER_INTENT

Constant to return from onStartCommand(Intent, int, int): if this service's process is killed while it is started (after returning from onStartCommand(Intent, int, int)), then it will be scheduled for a restart and the last delivered Intent re-delivered to it again via onStartCommand(Intent, int, int).

int START_STICKY

Constant to return from onStartCommand(Intent, int, int): if this service's process is killed while it is started (after returning from onStartCommand(Intent, int, int)), then leave it in the started state but don't retain this delivered intent.

int START_STICKY_COMPATIBILITY

Constant to return from onStartCommand(Intent, int, int): compatibility version of START_STICKY that does not guarantee that onStartCommand(Intent, int, int) will be called again after being killed.

int STOP_FOREGROUND_DETACH

Selector for stopForeground(int): if set, the notification previously supplied to startForeground(int, Notification) will be detached from the service's lifecycle.

int STOP_FOREGROUND_LEGACY

This constant was deprecated in API level 33. Use STOP_FOREGROUND_DETACH instead. The legacy behavior was inconsistent, leading to bugs around unpredictable results.

int STOP_FOREGROUND_REMOVE

Selector for stopForeground(int): if supplied, the notification previously supplied to startForeground(int, Notification) will be cancelled and removed from display.

String ACCESSIBILITY_SERVICE

Use with getSystemService(java.lang.String) to retrieve a AccessibilityManager for giving the user feedback for UI events through the registered event listeners.

String ACCOUNT_SERVICE

Use with getSystemService(java.lang.String) to retrieve a AccountManager for receiving intents at a time of your choosing.

String ACTIVITY_SERVICE

Use with getSystemService(java.lang.String) to retrieve a ActivityManager for interacting with the global system state.

String ALARM_SERVICE

Use with getSystemService(java.lang.String) to retrieve a AlarmManager for receiving intents at a time of your choosing.

String APPWIDGET_SERVICE

Use with getSystemService(java.lang.String) to retrieve a AppWidgetManager for accessing AppWidgets.

String APP_FUNCTION_SERVICE

Use with getSystemService(java.lang.String) to retrieve an AppFunctionManager for executing app functions.

String APP_OPS_SERVICE

Use with getSystemService(java.lang.String) to retrieve a AppOpsManager for tracking application operations on the device.

String APP_SEARCH_SERVICE

Use with getSystemService(java.lang.String) to retrieve an AppSearchManager for indexing and querying app data managed by the system.

String AUDIO_SERVICE

Use with getSystemService(java.lang.String) to retrieve a AudioManager for handling management of volume, ringer modes and audio routing.

String BATTERY_SERVICE

Use with getSystemService(java.lang.String) to retrieve a BatteryManager for managing battery state.

int BIND_ABOVE_CLIENT

Flag for bindService(Intent, BindServiceFlags, Executor, ServiceConnection): indicates that the client application binding to this service considers the service to be more important than the app itself.

int BIND_ADJUST_WITH_ACTIVITY

Flag for bindService(Intent, BindServiceFlags, Executor, ServiceConnection): If binding from an activity, allow the target service's process importance to be raised based on whether the activity is visible to the user, regardless whether another flag is used to reduce the amount that the client process's overall importance is used to impact it.

int BIND_ALLOW_ACTIVITY_STARTS

Flag for bindService(Intent, BindServiceFlags, Executor, ServiceConnection): If binding from an app that is visible, the bound service is allowed to start an activity from background.

int BIND_ALLOW_OOM_MANAGEMENT

Flag for bindService(Intent, BindServiceFlags, Executor, ServiceConnection): allow the process hosting the bound service to go through its normal memory management.

int BIND_AUTO_CREATE

Flag for bindService(Intent, BindServiceFlags, Executor, ServiceConnection): automatically create the service as long as the binding exists.

int BIND_DEBUG_UNBIND

Flag for bindService(Intent, BindServiceFlags, Executor, ServiceConnection): include debugging help for mismatched calls to unbind.

int BIND_EXTERNAL_SERVICE

Flag for bindService(Intent, BindServiceFlags, Executor, ServiceConnection): The service being bound is an isolated, external service.

long BIND_EXTERNAL_SERVICE_LONG

Works in the same way as BIND_EXTERNAL_SERVICE, but it's defined as a long value that is compatible to BindServiceFlags.

int BIND_IMPORTANT

Flag for bindService(Intent, BindServiceFlags, Executor, ServiceConnection): this service is very important to the client, so should be brought to the foreground process level when the client is.

int BIND_INCLUDE_CAPABILITIES

Flag for bindService(Intent, BindServiceFlags, Executor, ServiceConnection): If binding from an app that has specific capabilities due to its foreground state such as an activity or foreground service, then this flag will allow the bound app to get the same capabilities, as long as it has the required permissions as well.

int BIND_NOT_FOREGROUND

Flag for bindService(Intent, BindServiceFlags, Executor, ServiceConnection): don't allow this binding to raise the target service's process to the foreground scheduling priority.

int BIND_NOT_PERCEPTIBLE

Flag for bindService(Intent, BindServiceFlags, Executor, ServiceConnection): If binding from an app that is visible or user-perceptible, lower the target service's importance to below the perceptible level.

int BIND_PACKAGE_ISOLATED_PROCESS

Flag for bindIsolatedService(Intent, BindServiceFlags, String, Executor, ServiceConnection): Bind the service into a shared isolated process, but only with other isolated services from the same package that declare the same process name.

int BIND_SHARED_ISOLATED_PROCESS

Flag for bindIsolatedService(Intent, BindServiceFlags, String, Executor, ServiceConnection): Bind the service into a shared isolated process.

int BIND_WAIVE_PRIORITY

Flag for bindService(Intent, BindServiceFlags, Executor, ServiceConnection): don't impact the scheduling or memory management priority of the target service's hosting process.

String BIOMETRIC_SERVICE

Use with getSystemService(java.lang.String) to retrieve a BiometricManager for handling biometric and PIN/pattern/password authentication.

String BLOB_STORE_SERVICE

Use with getSystemService(java.lang.String) to retrieve a BlobStoreManager for contributing and accessing data blobs from the blob store maintained by the system.

String BLUETOOTH_SERVICE

Use with getSystemService(java.lang.String) to retrieve a BluetoothManager for using Bluetooth.

String BUGREPORT_SERVICE

Service to capture a bugreport.

String CAMERA_SERVICE

Use with getSystemService(java.lang.String) to retrieve a CameraManager for interacting with camera devices.

String CAPTIONING_SERVICE

Use with getSystemService(java.lang.String) to retrieve a CaptioningManager for obtaining captioning properties and listening for changes in captioning preferences.

String CARRIER_CONFIG_SERVICE

Use with getSystemService(java.lang.String) to retrieve a CarrierConfigManager for reading carrier configuration values.

String CLIPBOARD_SERVICE

Use with getSystemService(java.lang.String) to retrieve a ClipboardManager for accessing and modifying the contents of the global clipboard.

String COMPANION_DEVICE_SERVICE

Use with getSystemService(java.lang.String) to retrieve a CompanionDeviceManager for managing companion devices

String CONNECTIVITY_DIAGNOSTICS_SERVICE

Use with getSystemService(java.lang.String) to retrieve a ConnectivityDiagnosticsManager for performing network connectivity diagnostics as well as receiving network connectivity information from the system.

String CONNECTIVITY_SERVICE

Use with getSystemService(java.lang.String) to retrieve a ConnectivityManager for handling management of network connections.

String CONSUMER_IR_SERVICE

Use with getSystemService(java.lang.String) to retrieve a ConsumerIrManager for transmitting infrared signals from the device.

String CONTACT_KEYS_SERVICE

Use with getSystemService(java.lang.String) to retrieve a E2eeContactKeysManager to managing contact keys.

int CONTEXT_IGNORE_SECURITY

Flag for use with createPackageContext(String, int): ignore any security restrictions on the Context being requested, allowing it to always be loaded.

int CONTEXT_INCLUDE_CODE

Flag for use with createPackageContext(String, int): include the application code with the context.

int CONTEXT_RESTRICTED

Flag for use with createPackageContext(String, int): a restricted context may disable specific features.

String CREDENTIAL_SERVICE

Use with getSystemService(java.lang.String) to retrieve a CredentialManager to authenticate a user to your app.

String CROSS_PROFILE_APPS_SERVICE

Use with getSystemService(java.lang.String) to retrieve a CrossProfileApps for cross profile operations.

int DEVICE_ID_DEFAULT

The default device ID, which is the ID of the primary (non-virtual) device.

int DEVICE_ID_INVALID

Invalid device ID.

String DEVICE_LOCK_SERVICE

Use with getSystemService(java.lang.String) to retrieve a DeviceLockManager.

String DEVICE_POLICY_SERVICE

Use with getSystemService(java.lang.String) to retrieve a DevicePolicyManager for working with global device policy management.

String DISPLAY_HASH_SERVICE

Use with getSystemService(java.lang.String) to access DisplayHashManager to handle display hashes.

String DISPLAY_SERVICE

Use with getSystemService(java.lang.String) to retrieve a DisplayManager for interacting with display devices.

String DOMAIN_VERIFICATION_SERVICE

Use with getSystemService(java.lang.String) to access DomainVerificationManager to retrieve approval and user state for declared web domains.

String DOWNLOAD_SERVICE

Use with getSystemService(java.lang.String) to retrieve a DownloadManager for requesting HTTP downloads.

String DROPBOX_SERVICE

Use with getSystemService(java.lang.String) to retrieve a DropBoxManager instance for recording diagnostic logs.

String EUICC_SERVICE

Use with getSystemService(java.lang.String) to retrieve a EuiccManager to manage the device eUICC (embedded SIM).

String FILE_INTEGRITY_SERVICE

Use with getSystemService(java.lang.String) to retrieve an FileIntegrityManager.

String FINGERPRINT_SERVICE

Use with getSystemService(java.lang.String) to retrieve a FingerprintManager for handling management of fingerprints.

String GAME_SERVICE

Use with getSystemService(java.lang.String) to retrieve a GameManager.

String GRAMMATICAL_INFLECTION_SERVICE

Use with getSystemService(java.lang.String) to retrieve a GrammaticalInflectionManager.

String HARDWARE_PROPERTIES_SERVICE

Use with getSystemService(java.lang.String) to retrieve a HardwarePropertiesManager for accessing the hardware properties service.

String HEALTHCONNECT_SERVICE

Use with getSystemService(java.lang.String) to retrieve a HealthConnectManager.

String INPUT_METHOD_SERVICE

Use with getSystemService(java.lang.String) to retrieve a InputMethodManager for accessing input methods.

String INPUT_SERVICE

Use with getSystemService(java.lang.String) to retrieve a InputManager for interacting with input devices.

String IPSEC_SERVICE

Use with getSystemService(java.lang.String) to retrieve a IpSecManager for encrypting Sockets or Networks with IPSec.

String JOB_SCHEDULER_SERVICE

Use with getSystemService(java.lang.String) to retrieve a JobScheduler instance for managing occasional background tasks.

String KEYGUARD_SERVICE

Use with getSystemService(java.lang.String) to retrieve a KeyguardManager for controlling keyguard.

String KEYSTORE_SERVICE

Use with getSystemService(java.lang.String) to retrieve a KeyStoreManager for accessing Android Keystore functions.

String LAUNCHER_APPS_SERVICE

Use with getSystemService(java.lang.String) to retrieve a LauncherApps for querying and monitoring launchable apps across profiles of a user.

String LAYOUT_INFLATER_SERVICE

Use with getSystemService(java.lang.String) to retrieve a LayoutInflater for inflating layout resources in this context.

String LOCALE_SERVICE

Use with getSystemService(java.lang.String) to retrieve a LocaleManager.

String LOCATION_SERVICE

Use with getSystemService(java.lang.String) to retrieve a LocationManager for controlling location updates.

String MEDIA_COMMUNICATION_SERVICE

Use with getSystemService(java.lang.String) to retrieve a MediaCommunicationManager for managing MediaSession2.

String MEDIA_METRICS_SERVICE

Use with getSystemService(java.lang.String) to retrieve a MediaMetricsManager for interacting with media metrics on the device.

String MEDIA_PROJECTION_SERVICE

Use with getSystemService(java.lang.String) to retrieve a MediaProjectionManager instance for managing media projection sessions.

String MEDIA_ROUTER_SERVICE

Use with getSystemService(Class) to retrieve a MediaRouter for controlling and managing routing of media.

String MEDIA_SESSION_SERVICE

Use with getSystemService(java.lang.String) to retrieve a MediaSessionManager for managing media Sessions.

String MIDI_SERVICE

Use with getSystemService(java.lang.String) to retrieve a MidiManager for accessing the MIDI service.

int MODE_APPEND

File creation mode: for use with openFileOutput(String, int), if the file already exists then write data to the end of the existing file instead of erasing it.

int MODE_ENABLE_WRITE_AHEAD_LOGGING

Database open flag: when set, the database is opened with write-ahead logging enabled by default.

int MODE_MULTI_PROCESS

This constant was deprecated in API level 23. MODE_MULTI_PROCESS does not work reliably in some versions of Android, and furthermore does not provide any mechanism for reconciling concurrent modifications across processes. Applications should not attempt to use it. Instead, they should use an explicit cross-process data management approach such as ContentProvider.

int MODE_NO_LOCALIZED_COLLATORS

Database open flag: when set, the database is opened without support for localized collators.

int MODE_PRIVATE

File creation mode: the default mode, where the created file can only be accessed by the calling application (or all applications sharing the same user ID).

int MODE_WORLD_READABLE

This constant was deprecated in API level 17. Creating world-readable files is very dangerous, and likely to cause security holes in applications. It is strongly discouraged; instead, applications should use more formal mechanism for interactions such as ContentProvider, BroadcastReceiver, and Service. There are no guarantees that this access mode will remain on a file, such as when it goes through a backup and restore.

int MODE_WORLD_WRITEABLE

This constant was deprecated in API level 17. Creating world-writable files is very dangerous, and likely to cause security holes in applications. It is strongly discouraged; instead, applications should use more formal mechanism for interactions such as ContentProvider, BroadcastReceiver, and Service. There are no guarantees that this access mode will remain on a file, such as when it goes through a backup and restore.

String NETWORK_STATS_SERVICE

Use with getSystemService(java.lang.String) to retrieve a NetworkStatsManager for querying network usage stats.

String NFC_SERVICE

Use with getSystemService(java.lang.String) to retrieve a NfcManager for using NFC.

String NOTIFICATION_SERVICE

Use with getSystemService(java.lang.String) to retrieve a NotificationManager for informing the user of background events.

String NSD_SERVICE

Use with getSystemService(java.lang.String) to retrieve a NsdManager for handling management of network service discovery

String OVERLAY_SERVICE

Use with getSystemService(java.lang.String) to retrieve a OverlayManager for managing overlay packages.

String PEOPLE_SERVICE

Use with getSystemService(java.lang.String) to access a PeopleManager to interact with your published conversations.

String PERFORMANCE_HINT_SERVICE

Use with getSystemService(java.lang.String) to retrieve a PerformanceHintManager for accessing the performance hinting service.

String PERSISTENT_DATA_BLOCK_SERVICE

Use with getSystemService(java.lang.String) to retrieve a PersistentDataBlockManager instance for interacting with a storage device that lives across factory resets.

String POWER_SERVICE

Use with getSystemService(java.lang.String) to retrieve a PowerManager for controlling power management, including "wake locks," which let you keep the device on while you're running long tasks.

String PRINT_SERVICE

PrintManager for printing and managing printers and print tasks.

String PROFILING_SERVICE

Use with getSystemService(java.lang.String) to retrieve an ProfilingManager.

int RECEIVER_EXPORTED

Flag for registerReceiver(BroadcastReceiver, IntentFilter): The receiver can receive broadcasts from other Apps.

int RECEIVER_NOT_EXPORTED

Flag for registerReceiver(BroadcastReceiver, IntentFilter): The receiver cannot receive broadcasts from other Apps.

int RECEIVER_VISIBLE_TO_INSTANT_APPS

Flag for registerReceiver(BroadcastReceiver, IntentFilter): The receiver can receive broadcasts from Instant Apps.

String RESTRICTIONS_SERVICE

Use with getSystemService(java.lang.String) to retrieve a RestrictionsManager for retrieving application restrictions and requesting permissions for restricted operations.

String ROLE_SERVICE

Use with getSystemService(java.lang.String) to retrieve a RoleManager for managing roles.

String SATELLITE_SERVICE

Use with getSystemService(java.lang.String) to retrieve a SatelliteManager for accessing satellite functionality.

String SEARCH_SERVICE

Use with getSystemService(java.lang.String) to retrieve a SearchManager for handling searches.

String SECURITY_STATE_SERVICE

Use with getSystemService(java.lang.String) to retrieve a SecurityStateManager for accessing the security state manager service.

String SENSOR_SERVICE

Use with getSystemService(java.lang.String) to retrieve a SensorManager for accessing sensors.

String SHORTCUT_SERVICE

Use with getSystemService(java.lang.String) to retrieve a ShortcutManager for accessing the launcher shortcut service.

String STATUS_BAR_SERVICE

Use with getSystemService(java.lang.String) to retrieve a StatusBarManager for interacting with the status bar and quick settings.

String STORAGE_SERVICE

Use with getSystemService(java.lang.String) to retrieve a StorageManager for accessing system storage functions.

String STORAGE_STATS_SERVICE

Use with getSystemService(java.lang.String) to retrieve a StorageStatsManager for accessing system storage statistics.

String SYSTEM_HEALTH_SERVICE

Use with getSystemService(java.lang.String) to retrieve a SystemHealthManager for accessing system health (battery, power, memory, etc) metrics.

String TELECOM_SERVICE

Use with getSystemService(java.lang.String) to retrieve a TelecomManager to manage telecom-related features of the device.

String TELEPHONY_IMS_SERVICE

Use with getSystemService(java.lang.String) to retrieve an ImsManager.

String TELEPHONY_SERVICE

Use with getSystemService(java.lang.String) to retrieve a TelephonyManager for handling management the telephony features of the device.

String TELEPHONY_SUBSCRIPTION_SERVICE

Use with getSystemService(java.lang.String) to retrieve a SubscriptionManager for handling management the telephony subscriptions of the device.

String TEXT_CLASSIFICATION_SERVICE

Use with getSystemService(java.lang.String) to retrieve a TextClassificationManager for text classification services.

String TEXT_SERVICES_MANAGER_SERVICE

Use with getSystemService(java.lang.String) to retrieve a TextServicesManager for accessing text services.

String TV_AD_SERVICE

Use with getSystemService(java.lang.String) to retrieve a TvAdManager for interacting with TV client-side advertisement services on the device.

String TV_INPUT_SERVICE

Use with getSystemService(java.lang.String) to retrieve a TvInputManager for interacting with TV inputs on the device.

String TV_INTERACTIVE_APP_SERVICE

Use with getSystemService(java.lang.String) to retrieve a TvInteractiveAppManager for interacting with TV interactive applications on the device.

String UI_MODE_SERVICE

Use with getSystemService(java.lang.String) to retrieve a UiModeManager for controlling UI modes.

String USAGE_STATS_SERVICE

Use with getSystemService(java.lang.String) to retrieve a UsageStatsManager for querying device usage stats.

String USB_SERVICE

Use with getSystemService(java.lang.String) to retrieve a UsbManager for access to USB devices (as a USB host) and for controlling this device's behavior as a USB device.

String USER_SERVICE

Use with getSystemService(java.lang.String) to retrieve a UserManager for managing users on devices that support multiple users.

String VIBRATOR_MANAGER_SERVICE

Use with getSystemService(java.lang.String) to retrieve a VibratorManager for accessing the device vibrators, interacting with individual ones and playing synchronized effects on multiple vibrators.

String VIBRATOR_SERVICE

This constant was deprecated in API level 31. Use VibratorManager to retrieve the default system vibrator.

String VIRTUAL_DEVICE_SERVICE

Use with getSystemService(java.lang.String) to retrieve a VirtualDeviceManager for managing virtual devices.

String VPN_MANAGEMENT_SERVICE

Use with getSystemService(java.lang.String) to retrieve a VpnManager to manage profiles for the platform built-in VPN.

String WALLPAPER_SERVICE

Use with getSystemService(java.lang.String) to retrieve a com.android.server.WallpaperService for accessing wallpapers.

String WIFI_AWARE_SERVICE

Use with getSystemService(java.lang.String) to retrieve a WifiAwareManager for handling management of Wi-Fi Aware.

String WIFI_P2P_SERVICE

Use with getSystemService(java.lang.String) to retrieve a WifiP2pManager for handling management of Wi-Fi peer-to-peer connections.

String WIFI_RTT_RANGING_SERVICE

Use with getSystemService(java.lang.String) to retrieve a WifiRttManager for ranging devices with wifi.

String WIFI_SERVICE

Use with getSystemService(java.lang.String) to retrieve a WifiManager for handling management of Wi-Fi access.

String WINDOW_SERVICE

Use with getSystemService(java.lang.String) to retrieve a WindowManager for accessing the system's window manager.

int TRIM_MEMORY_BACKGROUND

Level for onTrimMemory(int): the process has gone on to the LRU list.

int TRIM_MEMORY_COMPLETE

This constant was deprecated in API level 35. Apps are not notified of this level since API level 34

int TRIM_MEMORY_MODERATE

This constant was deprecated in API level 35. Apps are not notified of this level since API level 34

int TRIM_MEMORY_RUNNING_CRITICAL

This constant was deprecated in API level 35. Apps are not notified of this level since API level 34

int TRIM_MEMORY_RUNNING_LOW

This constant was deprecated in API level 35. Apps are not notified of this level since API level 34

int TRIM_MEMORY_RUNNING_MODERATE

This constant was deprecated in API level 35. Apps are not notified of this level since API level 34

int TRIM_MEMORY_UI_HIDDEN

Level for onTrimMemory(int): the process had been showing a user interface, and is no longer doing so.

Public constructors

DreamService()

Public methods

void addContentView(View view, ViewGroup.LayoutParams params)

Adds a view to the Dream's window, leaving other content views in place.

boolean dispatchGenericMotionEvent(MotionEvent event)

Called to process generic motion events.

boolean dispatchKeyEvent(KeyEvent event)

Called to process key events.

boolean dispatchKeyShortcutEvent(KeyEvent event)

Called to process a key shortcut event.

boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event)

Called to process population of AccessibilityEvents.

boolean dispatchTouchEvent(MotionEvent event)

Called to process touch screen events.

boolean dispatchTrackballEvent(MotionEvent event)

Called to process trackball events.

<T extends View> T findViewById(int id)

Finds a view that was identified by the id attribute from the XML that was processed in onCreate().

final void finish()

Stops the dream and detaches from the window.

Window getWindow()

Retrieves the current Window for the dream.

WindowManager getWindowManager()

Retrieves the current WindowManager for the dream.

boolean isFullscreen()

Returns whether this dream is in fullscreen mode.

boolean isInteractive()

Returns whether this dream is interactive.

boolean isScreenBright()

Returns whether this dream keeps the screen bright while dreaming.

void onActionModeFinished(ActionMode mode)

Called when an action mode has been finished.

void onActionModeStarted(ActionMode mode)

Called when an action mode has been started.

void onAttachedToWindow()

Called when the window has been attached to the window manager.

final IBinder onBind(Intent intent)

Return the communication channel to the service.

void onContentChanged()

This hook is called whenever the content view of the screen changes (due to a call to Window.setContentView or Window.addContentView).

void onCreate()

Called when this Dream is constructed.

boolean onCreatePanelMenu(int featureId, Menu menu)

Initialize the contents of the menu for panel 'featureId'.

View onCreatePanelView(int featureId)

Instantiate the view to display in the panel for 'featureId'.

void onDestroy()

Called by the system to notify a Service that it is no longer used and is being removed.

void onDetachedFromWindow()

Called when the window has been detached from the window manager.

void onDreamingStarted()

Called when the dream's window has been created and is visible and animation may now begin.

void onDreamingStopped()

Called when this Dream is stopped, either by external request or by calling finish(), before the window has been removed.

boolean onMenuItemSelected(int featureId, MenuItem item)

Called when a panel's menu item has been selected by the user.

boolean onMenuOpened(int featureId, Menu menu)

Called when a panel's menu is opened by the user.

void onPanelClosed(int featureId, Menu menu)

Called when a panel is being closed.

boolean onPreparePanel(int featureId, View view, Menu menu)

Prepare a panel to be displayed.

boolean onSearchRequested()

Called when the user signals the desire to start a search.

boolean onSearchRequested(SearchEvent event)

Called when the user signals the desire to start a search.

boolean onUnbind(Intent intent)

Called when all clients have disconnected from a particular interface published by the service.

void onWakeUp()

Called when the dream is being asked to stop itself and wake.

void onWindowAttributesChanged(WindowManager.LayoutParams attrs)

This is called whenever the current window attributes change.

void onWindowFocusChanged(boolean hasFocus)

This hook is called whenever the window focus changes.

ActionMode onWindowStartingActionMode(ActionMode.Callback callback)

Called when an action mode is being started for this window.

ActionMode onWindowStartingActionMode(ActionMode.Callback callback, int type)

Called when an action mode is being started for this window.

final <T extends View> T requireViewById(int id)

Finds a view that was identified by the id attribute from the XML that was processed in onCreate(), or throws an IllegalArgumentException if the ID is invalid or there is no matching view in the hierarchy.

void setContentView(View view)

Sets a view to be the content view for this Dream.

void setContentView(int layoutResID)

Inflates a layout resource and set it to be the content view for this Dream.

void setContentView(View view, ViewGroup.LayoutParams params)

Sets a view to be the content view for this Dream.

void setFullscreen(boolean fullscreen)

Controls WindowManager.LayoutParams.FLAG_FULLSCREEN on the dream's window.

void setInteractive(boolean interactive)

Marks this dream as interactive to receive input events.

void setScreenBright(boolean screenBright)

Marks this dream as keeping the screen bright while dreaming.

final void wakeUp()

Wakes the dream up gently.

Protected methods

void dump(FileDescriptor fd, PrintWriter pw, String[] args)

Print the Service's state into the given stream.

Inherited methods

void attachBaseContext(Context newBase)

Set the base context for this ContextWrapper.

void dump(FileDescriptor fd, PrintWriter writer, String[] args)

Print the Service's state into the given stream.

final Application getApplication()

Return the application that owns this service.

final int getForegroundServiceType()

If the service has become a foreground service by calling startForeground(int, android.app.Notification) or startForeground(int, android.app.Notification, int), getForegroundServiceType() returns the current foreground service type.

abstract IBinder onBind(Intent intent)

Return the communication channel to the service.

void onConfigurationChanged(Configuration newConfig)

Called by the system when the device configuration changes while your component is running.

void onCreate()

Called by the system when the service is first created.

void onDestroy()

Called by the system to notify a Service that it is no longer used and is being removed.

void onLowMemory()

This is called when the overall system is running low on memory, and actively running processes should trim their memory usage.

void onRebind(Intent intent)

Called when new clients have connected to the service, after it had previously been notified that all had disconnected in its onUnbind(Intent).

void onStart(Intent intent, int startId)

This method was deprecated in API level 15. Implement onStartCommand(android.content.Intent, int, int) instead.

int onStartCommand(Intent intent, int flags, int startId)

Called by the system every time a client explicitly starts the service by calling Context.startService(Intent), providing the arguments it supplied and a unique integer token representing the start request.

void onTaskRemoved(Intent rootIntent)

This is called if the service is currently running and the user has removed a task that comes from the service's application.

void onTimeout(int startId, int fgsType)

Callback called when a particular foreground service type has timed out.

void onTimeout(int startId)

Callback called on timeout for ServiceInfo.FOREGROUND_SERVICE_TYPE_SHORT_SERVICE.

void onTrimMemory(int level)

Called when the operating system has determined that it is a good time for a process to trim unneeded memory from its process.

boolean onUnbind(Intent intent)

Called when all clients have disconnected from a particular interface published by the service.

final void startForeground(int id, Notification notification)

If your service is started (running through Context.startService(Intent)), then also make this service run in the foreground, supplying the ongoing notification to be shown to the user while in this state.

final void startForeground(int id, Notification notification, int foregroundServiceType)

An overloaded version of startForeground(int, android.app.Notification) with additional foregroundServiceType parameter.

final void stopForeground(int notificationBehavior)

Remove this service from foreground state, allowing it to be killed if more memory is needed.

final void stopForeground(boolean removeNotification)

This method was deprecated in API level 33. call stopForeground(int) and pass either STOP_FOREGROUND_REMOVE or STOP_FOREGROUND_DETACH explicitly instead.

final void stopSelf()

Stop the service, if it was previously started.

final void stopSelf(int startId)

Old version of stopSelfResult(int) that doesn't return a result.

final boolean stopSelfResult(int startId)

Stop the service if the most recent time it was started was startId.

void attachBaseContext(Context base)

Set the base context for this ContextWrapper.

boolean bindIsolatedService(Intent service, int flags, String instanceName, Executor executor, ServiceConnection conn)

Variation of bindService(Intent, BindServiceFlags, Executor, ServiceConnection) that, in the specific case of isolated services, allows the caller to generate multiple instances of a service from a single component declaration.

boolean bindService(Intent service, int flags, Executor executor, ServiceConnection conn)

Same as bindService(Intent, ServiceConnection, int) with executor to control ServiceConnection callbacks.

boolean bindService(Intent service, ServiceConnection conn, Context.BindServiceFlags flags)

See bindService(android.content.Intent, android.content.ServiceConnection, int) Call BindServiceFlags.of(long) to obtain a BindServiceFlags object.

boolean bindService(Intent service, ServiceConnection conn, int flags)

Connects to an application service, creating it if needed.

boolean bindService(Intent service, Context.BindServiceFlags flags, Executor executor, ServiceConnection conn)

See bindService(android.content.Intent, int, java.util.concurrent.Executor, android.content.ServiceConnection) Call BindServiceFlags.of(long) to obtain a BindServiceFlags object.

int checkCallingOrSelfPermission(String permission)

Determine whether the calling process of an IPC or you have been granted a particular permission.

int checkCallingOrSelfUriPermission(Uri uri, int modeFlags)

Determine whether the calling process of an IPC or you has been granted permission to access a specific URI.

int[] checkCallingOrSelfUriPermissions(List<Uri> uris, int modeFlags)

Determine whether the calling process of an IPC or you has been granted permission to access a list of URIs.

int checkCallingPermission(String permission)

Determine whether the calling process of an IPC you are handling has been granted a particular permission.

int checkCallingUriPermission(Uri uri, int modeFlags)

Determine whether the calling process and uid has been granted permission to access a specific URI.

int[] checkCallingUriPermissions(List<Uri> uris, int modeFlags)

Determine whether the calling process and uid has been granted permission to access a list of URIs.

int checkContentUriPermissionFull(Uri uri, int pid, int uid, int modeFlags)

Determine whether a particular process and uid has been granted permission to access a specific content URI.

int checkPermission(String permission, int pid, int uid)

Determine whether the given permission is allowed for a particular process and user ID running in the system.

int checkSelfPermission(String permission)

Determine whether you have been granted a particular permission.

int checkUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags)

Check both a Uri and normal permission.

int checkUriPermission(Uri uri, int pid, int uid, int modeFlags)

Determine whether a particular process and uid has been granted permission to access a specific URI.

int[] checkUriPermissions(List<Uri> uris, int pid, int uid, int modeFlags)

Determine whether a particular process and uid has been granted permission to access a list of URIs.

void clearWallpaper()

This method is deprecated. Use WallpaperManager.clear() instead.

This method requires the caller to hold the permission Manifest.permission.SET_WALLPAPER.

Context createAttributionContext(String attributionTag)

Return a new Context object for the current Context but attribute to a different tag.

Context createConfigurationContext(Configuration overrideConfiguration)

Return a new Context object for the current Context but whose resources are adjusted to match the given Configuration.

Context createContext(ContextParams contextParams)

Creates a context with specific properties and behaviors.

Context createDeviceContext(int deviceId)

Returns a new Context object from the current context but with device association given by the deviceId.

Context createDeviceProtectedStorageContext()

Return a new Context object for the current Context but whose storage APIs are backed by device-protected storage.

Context createDisplayContext(Display display)

Returns a new Context object from the current context but with resources adjusted to match the metrics of display.

Context createPackageContext(String packageName, int flags)

Return a new Context object for the given application name.

Context createWindowContext(int type, Bundle options)

Creates a Context for a non-activity window.

Context createWindowContext(Display display, int type, Bundle options)

Creates a Context for a non-activity window on the given Display.

String[] databaseList()

Returns an array of strings naming the private databases associated with this Context's application package.

boolean deleteDatabase(String name)

Delete an existing private SQLiteDatabase associated with this Context's application package.

boolean deleteFile(String name)

Delete the given private file associated with this Context's application package.

boolean deleteSharedPreferences(String name)

Delete an existing shared preferences file.

void enforceCallingOrSelfPermission(String permission, String message)

If neither you nor the calling process of an IPC you are handling has been granted a particular permission, throw a SecurityException.

void enforceCallingOrSelfUriPermission(Uri uri, int modeFlags, String message)

If the calling process of an IPC or you has not been granted permission to access a specific URI, throw SecurityException.

void enforceCallingPermission(String permission, String message)

If the calling process of an IPC you are handling has not been granted a particular permission, throw a SecurityException.

void enforceCallingUriPermission(Uri uri, int modeFlags, String message)

If the calling process and uid has not been granted permission to access a specific URI, throw SecurityException.

void enforcePermission(String permission, int pid, int uid, String message)

If the given permission is not allowed for a particular process and user ID running in the system, throw a SecurityException.

void enforceUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags, String message)

Enforce both a Uri and normal permission.

void enforceUriPermission(Uri uri, int pid, int uid, int modeFlags, String message)

If a particular process and uid has not been granted permission to access a specific URI, throw SecurityException.

String[] fileList()

Returns an array of strings naming the private files associated with this Context's application package.

Context getApplicationContext()

Return the context of the single, global Application object of the current process.

ApplicationInfo getApplicationInfo()

Return the full application info for this context's package.

AssetManager getAssets()

Returns an AssetManager instance for the application's package.

AttributionSource getAttributionSource()

Context getBaseContext()
File getCacheDir()

Returns the absolute path to the application specific cache directory on the filesystem.

ClassLoader getClassLoader()

Return a class loader you can use to retrieve classes in this package.

File getCodeCacheDir()

Returns the absolute path to the application specific cache directory on the filesystem designed for storing cached code.

ContentResolver getContentResolver()

Return a ContentResolver instance for your application's package.

File getDataDir()

Returns the absolute path to the directory on the filesystem where all private files belonging to this app are stored.

File getDatabasePath(String name)

Returns the absolute path on the filesystem where a database created with openOrCreateDatabase(String, int, CursorFactory) is stored.

int getDeviceId()

Gets the device ID this context is associated with.

File getDir(String name, int mode)

Retrieve, creating if needed, a new directory in which the application can place its own custom data files.

Display getDisplay()

Get the display this context is associated with.

File getExternalCacheDir()

Returns absolute path to application-specific directory on the primary shared/external storage device where the application can place cache files it owns.

File[] getExternalCacheDirs()

Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place cache files it owns.

File getExternalFilesDir(String type)

Returns the absolute path to the directory on the primary shared/external storage device where the application can place persistent files it owns.

File[] getExternalFilesDirs(String type)

Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place persistent files it owns.

File[] getExternalMediaDirs()

This method is deprecated. These directories still exist and are scanned, but developers are encouraged to migrate to inserting content into a MediaStore collection directly, as any app can contribute new media to MediaStore with no permissions required, starting in Build.VERSION_CODES.Q.

File getFileStreamPath(String name)

Returns the absolute path on the filesystem where a file created with openFileOutput(String, int) is stored.

File getFilesDir()

Returns the absolute path to the directory on the filesystem where files created with openFileOutput(String, int) are stored.

Executor getMainExecutor()

Return an Executor that will run enqueued tasks on the main thread associated with this context.

Looper getMainLooper()

Return the Looper for the main thread of the current process.

File getNoBackupFilesDir()

Returns the absolute path to the directory on the filesystem similar to getFilesDir().

File getObbDir()

Return the primary shared/external storage directory where this application's OBB files (if there are any) can be found.

File[] getObbDirs()

Returns absolute paths to application-specific directories on all shared/external storage devices where the application's OBB files (if there are any) can be found.

String getPackageCodePath()

Return the full path to this context's primary Android package.

PackageManager getPackageManager()

Return PackageManager instance to find global package information.

String getPackageName()

Return the name of this application's package.

String getPackageResourcePath()

Return the full path to this context's primary Android package.

ContextParams getParams()

Return the set of parameters which this Context was created with, if it was created via createContext(android.content.ContextParams).

Resources getResources()

Returns a Resources instance for the application's package.

SharedPreferences getSharedPreferences(String name, int mode)

Retrieve and hold the contents of the preferences file 'name', returning a SharedPreferences through which you can retrieve and modify its values.

Object getSystemService(String name)

Return the handle to a system-level service by name.

String getSystemServiceName(Class<?> serviceClass)

Gets the name of the system-level service that is represented by the specified class.

Resources.Theme getTheme()

Return the Theme object associated with this Context.

Drawable getWallpaper()

This method is deprecated. Use WallpaperManager.get() instead.

int getWallpaperDesiredMinimumHeight()

This method is deprecated. Use WallpaperManager.getDesiredMinimumHeight() instead.

int getWallpaperDesiredMinimumWidth()

This method is deprecated. Use WallpaperManager.getDesiredMinimumWidth() instead.

void grantUriPermission(String toPackage, Uri uri, int modeFlags)

Grant permission to access a specific Uri to another package, regardless of whether that package has general permission to access the Uri's content provider.

boolean isDeviceProtectedStorage()

Indicates if the storage APIs of this Context are backed by device-protected storage.

boolean isRestricted()

Indicates whether this Context is restricted.

boolean moveDatabaseFrom(Context sourceContext, String name)

Move an existing database file from the given source storage context to this context.

boolean moveSharedPreferencesFrom(Context sourceContext, String name)

Move an existing shared preferences file from the given source storage context to this context.

FileInputStream openFileInput(String name)

Open a private file associated with this Context's application package for reading.

FileOutputStream openFileOutput(String name, int mode)

Open a private file associated with this Context's application package for writing.

SQLiteDatabase openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory, DatabaseErrorHandler errorHandler)

Open a new private SQLiteDatabase associated with this Context's application package.

SQLiteDatabase openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory)

Open a new private SQLiteDatabase associated with this Context's application package.

Drawable peekWallpaper()

This method is deprecated. Use WallpaperManager.peek() instead.

void registerComponentCallbacks(ComponentCallbacks callback)

Add a new ComponentCallbacks to the base application of the Context, which will be called at the same times as the ComponentCallbacks methods of activities and other components are called.

void registerDeviceIdChangeListener(Executor executor, IntConsumer listener)

Adds a new device ID changed listener to the Context, which will be called when the device association is changed by the system.

Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter)

Register a BroadcastReceiver to be run in the main activity thread.

Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter, int flags)

Register to receive intent broadcasts, with the receiver optionally being exposed to Instant Apps.

Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler, int flags)

Register to receive intent broadcasts, to run in the context of scheduler.

Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler)

Register to receive intent broadcasts, to run in the context of scheduler.

void removeStickyBroadcast(Intent intent)

This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

void removeStickyBroadcastAsUser(Intent intent, UserHandle user)

This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

void revokeSelfPermissionsOnKill(Collection<String> permissions)

Triggers the revocation of one or more permissions for the calling package.

void revokeUriPermission(Uri uri, int modeFlags)

Remove all permissions to access a particular content provider Uri that were previously added with grantUriPermission(String, Uri, int) or any other mechanism.

void revokeUriPermission(String targetPackage, Uri uri, int modeFlags)

Remove permissions to access a particular content provider Uri that were previously added with grantUriPermission(String, Uri, int) for a specific target package.

void sendBroadcast(Intent intent, String receiverPermission, Bundle options)

Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.

void sendBroadcast(Intent intent, String receiverPermission)

Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.

void sendBroadcast(Intent intent)

Broadcast the given intent to all interested BroadcastReceivers.

void sendBroadcastAsUser(Intent intent, UserHandle user)

Version of sendBroadcast(android.content.Intent) that allows you to specify the user the broadcast will be sent to.

void sendBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission)

Version of sendBroadcast(android.content.Intent, java.lang.String) that allows you to specify the user the broadcast will be sent to.

void sendOrderedBroadcast(Intent intent, String receiverPermission, String receiverAppOp, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

Version of sendOrderedBroadcast(android.content.Intent, java.lang.String, android.content.BroadcastReceiver, android.os.Handler, int, java.lang.String, android.os.Bundle) that allows you to specify the App Op to enforce restrictions on which receivers the broadcast will be sent to.

void sendOrderedBroadcast(Intent intent, int initialCode, String receiverPermission, String receiverAppOp, BroadcastReceiver resultReceiver, Handler scheduler, String initialData, Bundle initialExtras, Bundle options)

void sendOrderedBroadcast(Intent intent, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

Version of sendBroadcast(android.content.Intent) that allows you to receive data back from the broadcast.

void sendOrderedBroadcast(Intent intent, String receiverPermission, Bundle options)

Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers.

void sendOrderedBroadcast(Intent intent, String receiverPermission, Bundle options, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

Version of sendBroadcast(android.content.Intent) that allows you to receive data back from the broadcast.

void sendOrderedBroadcast(Intent intent, String receiverPermission)

Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers.

void sendOrderedBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

Version of sendOrderedBroadcast(android.content.Intent, java.lang.String, android.content.BroadcastReceiver, android.os.Handler, int, java.lang.String, android.os.Bundle) that allows you to specify the user the broadcast will be sent to.

void sendStickyBroadcast(Intent intent)

This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

void sendStickyBroadcast(Intent intent, Bundle options)

This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

void sendStickyBroadcastAsUser(Intent intent, UserHandle user)

This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

void sendStickyOrderedBroadcast(Intent intent, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

void sendStickyOrderedBroadcastAsUser(Intent intent, UserHandle user, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

void setTheme(int resid)

Set the base theme for this context.

void setWallpaper(Bitmap bitmap)

This method is deprecated. Use WallpaperManager.set() instead.

This method requires the caller to hold the permission Manifest.permission.SET_WALLPAPER.

void setWallpaper(InputStream data)

This method is deprecated. Use WallpaperManager.set() instead.

This method requires the caller to hold the permission Manifest.permission.SET_WALLPAPER.

void startActivities(Intent[] intents, Bundle options)

Launch multiple new activities.

void startActivities(Intent[] intents)

Same as startActivities(android.content.Intent[], android.os.Bundle) with no options specified.

void startActivity(Intent intent)

Same as startActivity(android.content.Intent, android.os.Bundle) with no options specified.

void startActivity(Intent intent, Bundle options)

Launch a new activity.

ComponentName startForegroundService(Intent service)

Similar to startService(android.content.Intent), but with an implicit promise that the Service will call startForeground(int, android.app.Notification) once it begins running.

boolean startInstrumentation(ComponentName className, String profileFile, Bundle arguments)

Start executing an Instrumentation class.

void startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags)

Same as startIntentSender(android.content.IntentSender, android.content.Intent, int, int, int, android.os.Bundle) with no options specified.

void startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)

Like startActivity(android.content.Intent, android.os.Bundle), but taking a IntentSender to start.

ComponentName startService(Intent service)

Request that a given application service be started.

boolean stopService(Intent name)

Request that a given application service be stopped.

void unbindService(ServiceConnection conn)

Disconnect from an application service.

void unregisterComponentCallbacks(ComponentCallbacks callback)

Remove a ComponentCallbacks object that was previously registered with registerComponentCallbacks(android.content.ComponentCallbacks).

void unregisterDeviceIdChangeListener(IntConsumer listener)

Removes a device ID changed listener from the Context.

void unregisterReceiver(BroadcastReceiver receiver)

Unregister a previously registered BroadcastReceiver.

void updateServiceGroup(ServiceConnection conn, int group, int importance)

For a service previously bound with bindService(Intent, BindServiceFlags, Executor, ServiceConnection) or a related method, change how the system manages that service's process in relation to other processes.

boolean bindIsolatedService(Intent service, int flags, String instanceName, Executor executor, ServiceConnection conn)

Variation of bindService(Intent, BindServiceFlags, Executor, ServiceConnection) that, in the specific case of isolated services, allows the caller to generate multiple instances of a service from a single component declaration.

boolean bindIsolatedService(Intent service, Context.BindServiceFlags flags, String instanceName, Executor executor, ServiceConnection conn)

See bindIsolatedService(android.content.Intent, int, java.lang.String, java.util.concurrent.Executor, android.content.ServiceConnection) Call BindServiceFlags.of(long) to obtain a BindServiceFlags object.

boolean bindService(Intent service, int flags, Executor executor, ServiceConnection conn)

Same as bindService(Intent, ServiceConnection, int) with executor to control ServiceConnection callbacks.

boolean bindService(Intent service, ServiceConnection conn, Context.BindServiceFlags flags)

See bindService(android.content.Intent, android.content.ServiceConnection, int) Call BindServiceFlags.of(long) to obtain a BindServiceFlags object.

abstract boolean bindService(Intent service, ServiceConnection conn, int flags)

Connects to an application service, creating it if needed.

boolean bindService(Intent service, Context.BindServiceFlags flags, Executor executor, ServiceConnection conn)

See bindService(android.content.Intent, int, java.util.concurrent.Executor, android.content.ServiceConnection) Call BindServiceFlags.of(long) to obtain a BindServiceFlags object.

boolean bindServiceAsUser(Intent service, ServiceConnection conn, int flags, UserHandle user)

Binds to a service in the given user in the same manner as bindService(Intent, BindServiceFlags, Executor, ServiceConnection).

boolean bindServiceAsUser(Intent service, ServiceConnection conn, Context.BindServiceFlags flags, UserHandle user)

See bindServiceAsUser(android.content.Intent, android.content.ServiceConnection, int, android.os.UserHandle) Call BindServiceFlags.of(long) to obtain a BindServiceFlags object.

abstract int checkCallingOrSelfPermission(String permission)

Determine whether the calling process of an IPC or you have been granted a particular permission.

abstract int checkCallingOrSelfUriPermission(Uri uri, int modeFlags)

Determine whether the calling process of an IPC or you has been granted permission to access a specific URI.

int[] checkCallingOrSelfUriPermissions(List<Uri> uris, int modeFlags)

Determine whether the calling process of an IPC or you has been granted permission to access a list of URIs.

abstract int checkCallingPermission(String permission)

Determine whether the calling process of an IPC you are handling has been granted a particular permission.

abstract int checkCallingUriPermission(Uri uri, int modeFlags)

Determine whether the calling process and uid has been granted permission to access a specific URI.

int[] checkCallingUriPermissions(List<Uri> uris, int modeFlags)

Determine whether the calling process and uid has been granted permission to access a list of URIs.

int checkContentUriPermissionFull(Uri uri, int pid, int uid, int modeFlags)

Determine whether a particular process and uid has been granted permission to access a specific content URI.

abstract int checkPermission(String permission, int pid, int uid)

Determine whether the given permission is allowed for a particular process and user ID running in the system.

abstract int checkSelfPermission(String permission)

Determine whether you have been granted a particular permission.

abstract int checkUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags)

Check both a Uri and normal permission.

abstract int checkUriPermission(Uri uri, int pid, int uid, int modeFlags)

Determine whether a particular process and uid has been granted permission to access a specific URI.

int[] checkUriPermissions(List<Uri> uris, int pid, int uid, int modeFlags)

Determine whether a particular process and uid has been granted permission to access a list of URIs.

abstract void clearWallpaper()

This method was deprecated in API level 15. Use WallpaperManager.clear() instead.

This method requires the caller to hold the permission Manifest.permission.SET_WALLPAPER.

Context createAttributionContext(String attributionTag)

Return a new Context object for the current Context but attribute to a different tag.

abstract Context createConfigurationContext(Configuration overrideConfiguration)

Return a new Context object for the current Context but whose resources are adjusted to match the given Configuration.

Context createContext(ContextParams contextParams)

Creates a context with specific properties and behaviors.

abstract Context createContextForSplit(String splitName)

Return a new Context object for the given split name.

Context createDeviceContext(int deviceId)

Returns a new Context object from the current context but with device association given by the deviceId.

abstract Context createDeviceProtectedStorageContext()

Return a new Context object for the current Context but whose storage APIs are backed by device-protected storage.

abstract Context createDisplayContext(Display display)

Returns a new Context object from the current context but with resources adjusted to match the metrics of display.

abstract Context createPackageContext(String packageName, int flags)

Return a new Context object for the given application name.

Context createWindowContext(int type, Bundle options)

Creates a Context for a non-activity window.

Context createWindowContext(Display display, int type, Bundle options)

Creates a Context for a non-activity window on the given Display.

abstract String[] databaseList()

Returns an array of strings naming the private databases associated with this Context's application package.

abstract boolean deleteDatabase(String name)

Delete an existing private SQLiteDatabase associated with this Context's application package.

abstract boolean deleteFile(String name)

Delete the given private file associated with this Context's application package.

abstract boolean deleteSharedPreferences(String name)

Delete an existing shared preferences file.

abstract void enforceCallingOrSelfPermission(String permission, String message)

If neither you nor the calling process of an IPC you are handling has been granted a particular permission, throw a SecurityException.

abstract void enforceCallingOrSelfUriPermission(Uri uri, int modeFlags, String message)

If the calling process of an IPC or you has not been granted permission to access a specific URI, throw SecurityException.

abstract void enforceCallingPermission(String permission, String message)

If the calling process of an IPC you are handling has not been granted a particular permission, throw a SecurityException.

abstract void enforceCallingUriPermission(Uri uri, int modeFlags, String message)

If the calling process and uid has not been granted permission to access a specific URI, throw SecurityException.

abstract void enforcePermission(String permission, int pid, int uid, String message)

If the given permission is not allowed for a particular process and user ID running in the system, throw a SecurityException.

abstract void enforceUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags, String message)

Enforce both a Uri and normal permission.

abstract void enforceUriPermission(Uri uri, int pid, int uid, int modeFlags, String message)

If a particular process and uid has not been granted permission to access a specific URI, throw SecurityException.

abstract String[] fileList()

Returns an array of strings naming the private files associated with this Context's application package.

abstract Context getApplicationContext()

Return the context of the single, global Application object of the current process.

abstract ApplicationInfo getApplicationInfo()

Return the full application info for this context's package.

abstract AssetManager getAssets()

Returns an AssetManager instance for the application's package.

AttributionSource getAttributionSource()
String getAttributionTag()

Attribution can be used in complex apps to logically separate parts of the app.

abstract File getCacheDir()

Returns the absolute path to the application specific cache directory on the filesystem.

abstract ClassLoader getClassLoader()

Return a class loader you can use to retrieve classes in this package.

abstract File getCodeCacheDir()

Returns the absolute path to the application specific cache directory on the filesystem designed for storing cached code.

final int getColor(int id)

Returns a color associated with a particular resource ID and styled for the current theme.

final ColorStateList getColorStateList(int id)

Returns a color state list associated with a particular resource ID and styled for the current theme.

abstract ContentResolver getContentResolver()

Return a ContentResolver instance for your application's package.

abstract File getDataDir()

Returns the absolute path to the directory on the filesystem where all private files belonging to this app are stored.

abstract File getDatabasePath(String name)

Returns the absolute path on the filesystem where a database created with openOrCreateDatabase(String, int, CursorFactory) is stored.

int getDeviceId()

Gets the device ID this context is associated with.

abstract File getDir(String name, int mode)

Retrieve, creating if needed, a new directory in which the application can place its own custom data files.

Display getDisplay()

Get the display this context is associated with.

final Drawable getDrawable(int id)

Returns a drawable object associated with a particular resource ID and styled for the current theme.

abstract File getExternalCacheDir()

Returns absolute path to application-specific directory on the primary shared/external storage device where the application can place cache files it owns.

abstract File[] getExternalCacheDirs()

Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place cache files it owns.

abstract File getExternalFilesDir(String type)

Returns the absolute path to the directory on the primary shared/external storage device where the application can place persistent files it owns.

abstract File[] getExternalFilesDirs(String type)

Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place persistent files it owns.

abstract File[] getExternalMediaDirs()

This method was deprecated in API level 30. These directories still exist and are scanned, but developers are encouraged to migrate to inserting content into a MediaStore collection directly, as any app can contribute new media to MediaStore with no permissions required, starting in Build.VERSION_CODES.Q.

abstract File getFileStreamPath(String name)

Returns the absolute path on the filesystem where a file created with openFileOutput(String, int) is stored.

abstract File getFilesDir()

Returns the absolute path to the directory on the filesystem where files created with openFileOutput(String, int) are stored.

Executor getMainExecutor()

Return an Executor that will run enqueued tasks on the main thread associated with this context.

abstract Looper getMainLooper()

Return the Looper for the main thread of the current process.

abstract File getNoBackupFilesDir()

Returns the absolute path to the directory on the filesystem similar to getFilesDir().

abstract File getObbDir()

Return the primary shared/external storage directory where this application's OBB files (if there are any) can be found.

abstract File[] getObbDirs()

Returns absolute paths to application-specific directories on all shared/external storage devices where the application's OBB files (if there are any) can be found.

String getOpPackageName()

Return the package name that should be used for AppOpsManager calls from this context, so that app ops manager's uid verification will work with the name.

abstract String getPackageCodePath()

Return the full path to this context's primary Android package.

abstract PackageManager getPackageManager()

Return PackageManager instance to find global package information.

abstract String getPackageName()

Return the name of this application's package.

abstract String getPackageResourcePath()

Return the full path to this context's primary Android package.

ContextParams getParams()

Return the set of parameters which this Context was created with, if it was created via createContext(android.content.ContextParams).

abstract Resources getResources()

Returns a Resources instance for the application's package.

abstract SharedPreferences getSharedPreferences(String name, int mode)

Retrieve and hold the contents of the preferences file 'name', returning a SharedPreferences through which you can retrieve and modify its values.

final String getString(int resId)

Returns a localized string from the application's package's default string table.

final String getString(int resId, Object... formatArgs)

Returns a localized formatted string from the application's package's default string table, substituting the format arguments as defined in Formatter and String.format(String, Object).

final <T> T getSystemService(Class<T> serviceClass)

Return the handle to a system-level service by class.

abstract Object getSystemService(String name)

Return the handle to a system-level service by name.

abstract String getSystemServiceName(Class<?> serviceClass)

Gets the name of the system-level service that is represented by the specified class.

final CharSequence getText(int resId)

Return a localized, styled CharSequence from the application's package's default string table.

abstract Resources.Theme getTheme()

Return the Theme object associated with this Context.

abstract Drawable getWallpaper()

This method was deprecated in API level 15. Use WallpaperManager.get() instead.

abstract int getWallpaperDesiredMinimumHeight()

This method was deprecated in API level 15. Use WallpaperManager.getDesiredMinimumHeight() instead.

abstract int getWallpaperDesiredMinimumWidth()

This method was deprecated in API level 15. Use WallpaperManager.getDesiredMinimumWidth() instead.

abstract void grantUriPermission(String toPackage, Uri uri, int modeFlags)

Grant permission to access a specific Uri to another package, regardless of whether that package has general permission to access the Uri's content provider.

abstract boolean isDeviceProtectedStorage()

Indicates if the storage APIs of this Context are backed by device-protected storage.

boolean isRestricted()

Indicates whether this Context is restricted.

boolean isUiContext()

Returns true if the context is a UI context which can access UI components such as WindowManager, LayoutInflater or WallpaperManager.

abstract boolean moveDatabaseFrom(Context sourceContext, String name)

Move an existing database file from the given source storage context to this context.

abstract boolean moveSharedPreferencesFrom(Context sourceContext, String name)

Move an existing shared preferences file from the given source storage context to this context.

final TypedArray obtainStyledAttributes(AttributeSet set, int[] attrs)

Retrieve styled attribute information in this Context's theme.

final TypedArray obtainStyledAttributes(AttributeSet set, int[] attrs, int defStyleAttr, int defStyleRes)

Retrieve styled attribute information in this Context's theme.

final TypedArray obtainStyledAttributes(int resid, int[] attrs)

Retrieve styled attribute information in this Context's theme.

final TypedArray obtainStyledAttributes(int[] attrs)

Retrieve styled attribute information in this Context's theme.

abstract FileInputStream openFileInput(String name)

Open a private file associated with this Context's application package for reading.

abstract FileOutputStream openFileOutput(String name, int mode)

Open a private file associated with this Context's application package for writing.

abstract SQLiteDatabase openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory, DatabaseErrorHandler errorHandler)

Open a new private SQLiteDatabase associated with this Context's application package.

abstract SQLiteDatabase openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory)

Open a new private SQLiteDatabase associated with this Context's application package.

abstract Drawable peekWallpaper()

This method was deprecated in API level 15. Use WallpaperManager.peek() instead.

void registerComponentCallbacks(ComponentCallbacks callback)

Add a new ComponentCallbacks to the base application of the Context, which will be called at the same times as the ComponentCallbacks methods of activities and other components are called.

void registerDeviceIdChangeListener(Executor executor, IntConsumer listener)

Adds a new device ID changed listener to the Context, which will be called when the device association is changed by the system.

abstract Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter)

Register a BroadcastReceiver to be run in the main activity thread.

abstract Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter, int flags)

Register to receive intent broadcasts, with the receiver optionally being exposed to Instant Apps.

abstract Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler, int flags)

Register to receive intent broadcasts, to run in the context of scheduler.

abstract Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler)

Register to receive intent broadcasts, to run in the context of scheduler.

abstract void removeStickyBroadcast(Intent intent)

This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

abstract void removeStickyBroadcastAsUser(Intent intent, UserHandle user)

This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

void revokeSelfPermissionOnKill(String permName)

Triggers the asynchronous revocation of a runtime permission.

void revokeSelfPermissionsOnKill(Collection<String> permissions)

Triggers the revocation of one or more permissions for the calling package.

abstract void revokeUriPermission(Uri uri, int modeFlags)

Remove all permissions to access a particular content provider Uri that were previously added with grantUriPermission(String, Uri, int) or any other mechanism.

abstract void revokeUriPermission(String toPackage, Uri uri, int modeFlags)

Remove permissions to access a particular content provider Uri that were previously added with grantUriPermission(String, Uri, int) for a specific target package.

void sendBroadcast(Intent intent, String receiverPermission, Bundle options)

Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.

abstract void sendBroadcast(Intent intent, String receiverPermission)

Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.

abstract void sendBroadcast(Intent intent)

Broadcast the given intent to all interested BroadcastReceivers.

abstract void sendBroadcastAsUser(Intent intent, UserHandle user)

Version of sendBroadcast(android.content.Intent) that allows you to specify the user the broadcast will be sent to.

abstract void sendBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission)

Version of sendBroadcast(android.content.Intent, java.lang.String) that allows you to specify the user the broadcast will be sent to.

void sendBroadcastWithMultiplePermissions(Intent intent, String[] receiverPermissions)

Broadcast the given intent to all interested BroadcastReceivers, allowing an array of required permissions to be enforced.

void sendOrderedBroadcast(Intent intent, String receiverPermission, String receiverAppOp, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

Version of sendOrderedBroadcast(android.content.Intent, java.lang.String, android.content.BroadcastReceiver, android.os.Handler, int, java.lang.String, android.os.Bundle) that allows you to specify the App Op to enforce restrictions on which receivers the broadcast will be sent to.

abstract void sendOrderedBroadcast(Intent intent, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

Version of sendBroadcast(android.content.Intent) that allows you to receive data back from the broadcast.

void sendOrderedBroadcast(Intent intent, String receiverPermission, Bundle options)

Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers.

void sendOrderedBroadcast(Intent intent, String receiverPermission, Bundle options, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

Version of sendBroadcast(android.content.Intent) that allows you to receive data back from the broadcast.

abstract void sendOrderedBroadcast(Intent intent, String receiverPermission)

Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers.

abstract void sendOrderedBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

Version of sendOrderedBroadcast(android.content.Intent, java.lang.String, android.content.BroadcastReceiver, android.os.Handler, int, java.lang.String, android.os.Bundle) that allows you to specify the user the broadcast will be sent to.

abstract void sendStickyBroadcast(Intent intent)

This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

void sendStickyBroadcast(Intent intent, Bundle options)

This method was deprecated in API level 31. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

abstract void sendStickyBroadcastAsUser(Intent intent, UserHandle user)

This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

abstract void sendStickyOrderedBroadcast(Intent intent, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

abstract void sendStickyOrderedBroadcastAsUser(Intent intent, UserHandle user, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

abstract void setTheme(int resid)

Set the base theme for this context.

abstract void setWallpaper(Bitmap bitmap)

This method was deprecated in API level 15. Use WallpaperManager.set() instead.

This method requires the caller to hold the permission Manifest.permission.SET_WALLPAPER.

abstract void setWallpaper(InputStream data)

This method was deprecated in API level 15. Use WallpaperManager.set() instead.

This method requires the caller to hold the permission Manifest.permission.SET_WALLPAPER.

abstract void startActivities(Intent[] intents, Bundle options)

Launch multiple new activities.

abstract void startActivities(Intent[] intents)

Same as startActivities(android.content.Intent[], android.os.Bundle) with no options specified.

abstract void startActivity(Intent intent)

Same as startActivity(android.content.Intent, android.os.Bundle) with no options specified.

abstract void startActivity(Intent intent, Bundle options)

Launch a new activity.

abstract ComponentName startForegroundService(Intent service)

Similar to startService(android.content.Intent), but with an implicit promise that the Service will call startForeground(int, android.app.Notification) once it begins running.

abstract boolean startInstrumentation(ComponentName className, String profileFile, Bundle arguments)

Start executing an Instrumentation class.

abstract void startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags)

Same as startIntentSender(android.content.IntentSender, android.content.Intent, int, int, int, android.os.Bundle) with no options specified.

abstract void startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)

Like startActivity(android.content.Intent, android.os.Bundle), but taking a IntentSender to start.

abstract ComponentName startService(Intent service)

Request that a given application service be started.

abstract boolean stopService(Intent service)

Request that a given application service be stopped.

abstract void unbindService(ServiceConnection conn)

Disconnect from an application service.

void unregisterComponentCallbacks(ComponentCallbacks callback)

Remove a ComponentCallbacks object that was previously registered with registerComponentCallbacks(android.content.ComponentCallbacks).

void unregisterDeviceIdChangeListener(IntConsumer listener)

Removes a device ID changed listener from the Context.

abstract void unregisterReceiver(BroadcastReceiver receiver)

Unregister a previously registered BroadcastReceiver.

void updateServiceGroup(ServiceConnection conn, int group, int importance)

For a service previously bound with bindService(Intent, BindServiceFlags, Executor, ServiceConnection) or a related method, change how the system manages that service's process in relation to other processes.

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

abstract void onTrimMemory(int level)

Called when the operating system has determined that it is a good time for a process to trim unneeded memory from its process.

abstract boolean dispatchGenericMotionEvent(MotionEvent event)

Called to process generic motion events.

abstract boolean dispatchKeyEvent(KeyEvent event)

Called to process key events.

abstract boolean dispatchKeyShortcutEvent(KeyEvent event)

Called to process a key shortcut event.

abstract boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event)

Called to process population of AccessibilityEvents.

abstract boolean dispatchTouchEvent(MotionEvent event)

Called to process touch screen events.

abstract boolean dispatchTrackballEvent(MotionEvent event)

Called to process trackball events.

abstract void onActionModeFinished(ActionMode mode)

Called when an action mode has been finished.

abstract void onActionModeStarted(ActionMode mode)

Called when an action mode has been started.

abstract void onAttachedToWindow()

Called when the window has been attached to the window manager.

abstract void onContentChanged()

This hook is called whenever the content view of the screen changes (due to a call to Window.setContentView or Window.addContentView).

abstract boolean onCreatePanelMenu(int featureId, Menu menu)

Initialize the contents of the menu for panel 'featureId'.

abstract View onCreatePanelView(int featureId)

Instantiate the view to display in the panel for 'featureId'.

abstract void onDetachedFromWindow()

Called when the window has been detached from the window manager.

abstract boolean onMenuItemSelected(int featureId, MenuItem item)

Called when a panel's menu item has been selected by the user.

abstract boolean onMenuOpened(int featureId, Menu menu)

Called when a panel's menu is opened by the user.

abstract void onPanelClosed(int featureId, Menu menu)

Called when a panel is being closed.

default void onPointerCaptureChanged(boolean hasCapture)

Called when pointer capture is enabled or disabled for the current window.

abstract boolean onPreparePanel(int featureId, View view, Menu menu)

Prepare a panel to be displayed.

default void onProvideKeyboardShortcuts(List<KeyboardShortcutGroup> data, Menu menu, int deviceId)

Called when Keyboard Shortcuts are requested for the current window.

abstract boolean onSearchRequested()

Called when the user signals the desire to start a search.

abstract boolean onSearchRequested(SearchEvent searchEvent)

Called when the user signals the desire to start a search.

abstract void onWindowAttributesChanged(WindowManager.LayoutParams attrs)

This is called whenever the current window attributes change.

abstract void onWindowFocusChanged(boolean hasFocus)

This hook is called whenever the window focus changes.

abstract ActionMode onWindowStartingActionMode(ActionMode.Callback callback)

Called when an action mode is being started for this window.

abstract ActionMode onWindowStartingActionMode(ActionMode.Callback callback, int type)

Called when an action mode is being started for this window.

abstract void onConfigurationChanged(Configuration newConfig)

Called by the system when the device configuration changes while your component is running.

abstract void onLowMemory()

This method was deprecated in API level 35. Since API level 14 this is superseded by ComponentCallbacks2.onTrimMemory. Since API level 34 this is never called. If you're overriding ComponentCallbacks2#onTrimMemory and your minSdkVersion is greater than API 14, you can provide an empty implementation for this method.

Constants

DREAM_META_DATA

Added in API level 17
public static final String DREAM_META_DATA

Name under which a Dream publishes information about itself. This meta-data must reference an XML resource containing a <dream> tag.

Constant Value: "android.service.dream"

SERVICE_INTERFACE

Added in API level 17
public static final String SERVICE_INTERFACE

The Intent that must be declared as handled by the service.

Constant Value: "android.service.dreams.DreamService"

Public constructors

DreamService

Added in API level 17
public DreamService ()

Public methods

addContentView

Added in API level 17
public void addContentView (View view, 
                ViewGroup.LayoutParams params)

Adds a view to the Dream's window, leaving other content views in place.

Note: Requires a window, do not call before onAttachedToWindow()

Parameters
view View: The desired content to display.

params ViewGroup.LayoutParams: Layout parameters for the view.

dispatchGenericMotionEvent

Added in API level 17
public boolean dispatchGenericMotionEvent (MotionEvent event)

Called to process generic motion events. At the very least your implementation must call Window.superDispatchGenericMotionEvent(MotionEvent) to do the standard processing.

Parameters
event MotionEvent: The generic motion event.

Returns
boolean boolean Return true if this event was consumed.

dispatchKeyEvent

Added in API level 17
public boolean dispatchKeyEvent (KeyEvent event)

Called to process key events. At the very least your implementation must call Window.superDispatchKeyEvent(KeyEvent) to do the standard key processing.

Parameters
event KeyEvent: The key event.

Returns
boolean boolean Return true if this event was consumed.

dispatchKeyShortcutEvent

Added in API level 17
public boolean dispatchKeyShortcutEvent (KeyEvent event)

Called to process a key shortcut event. At the very least your implementation must call Window.superDispatchKeyShortcutEvent(KeyEvent) to do the standard key shortcut processing.

Parameters
event KeyEvent: The key shortcut event.

Returns
boolean True if this event was consumed.

dispatchPopulateAccessibilityEvent

Added in API level 17
public boolean dispatchPopulateAccessibilityEvent (AccessibilityEvent event)

Called to process population of AccessibilityEvents.

Parameters
event AccessibilityEvent: The event.

Returns
boolean boolean Return true if event population was completed.

dispatchTouchEvent

Added in API level 17
public boolean dispatchTouchEvent (MotionEvent event)

Called to process touch screen events. At the very least your implementation must call Window.superDispatchTouchEvent(MotionEvent) to do the standard touch screen processing.

Parameters
event MotionEvent: The touch screen event.

Returns
boolean boolean Return true if this event was consumed.

dispatchTrackballEvent

Added in API level 17
public boolean dispatchTrackballEvent (MotionEvent event)

Called to process trackball events. At the very least your implementation must call Window.superDispatchTrackballEvent(MotionEvent) to do the standard trackball processing.

Parameters
event MotionEvent: The trackball event.

Returns
boolean boolean Return true if this event was consumed.

findViewById

Added in API level 17
public T findViewById (int id)

Finds a view that was identified by the id attribute from the XML that was processed in onCreate().

Note: Requires a window, do not call before onAttachedToWindow()

Note: In most cases -- depending on compiler support -- the resulting view is automatically cast to the target class type. If the target class type is unconstrained, an explicit cast may be necessary.

Parameters
id int: the ID to search for

Returns
T The view if found or null otherwise.

finish

Added in API level 17
public final void finish ()

Stops the dream and detaches from the window.

When the dream ends, the system will be allowed to go to sleep fully unless there is a reason for it to be awake such as recent user activity or wake locks being held.

getWindow

Added in API level 17
public Window getWindow ()

Retrieves the current Window for the dream. Behaves similarly to Activity.getWindow().

Returns
Window The current window, or null if the dream is not started.

getWindowManager

Added in API level 17
public WindowManager getWindowManager ()

Retrieves the current WindowManager for the dream. Behaves similarly to Activity.getWindowManager().

Returns
WindowManager The current window manager, or null if the dream is not started.

isFullscreen

Added in API level 17
public boolean isFullscreen ()

Returns whether this dream is in fullscreen mode. Defaults to false.

Returns
boolean

isInteractive

Added in API level 17
public boolean isInteractive ()

Returns whether this dream is interactive. Defaults to false.

Returns
boolean

isScreenBright

Added in API level 17
public boolean isScreenBright ()

Returns whether this dream keeps the screen bright while dreaming. Defaults to true, preventing the screen from dimming.

Returns
boolean

onActionModeFinished

Added in API level 17
public void onActionModeFinished (ActionMode mode)

Called when an action mode has been finished. The appropriate mode callback method will have already been invoked.

Parameters
mode ActionMode: The mode that was just finished.

onActionModeStarted

Added in API level 17
public void onActionModeStarted (ActionMode mode)

Called when an action mode has been started. The appropriate mode callback method will have already been invoked.

Parameters
mode ActionMode: The new mode that has just been started.

onAttachedToWindow

Added in API level 17
public void onAttachedToWindow ()

Called when the window has been attached to the window manager. See View.onAttachedToWindow() for more information.

onBind

Added in API level 17
public final IBinder onBind (Intent intent)

Return the communication channel to the service. May return null if clients can not bind to the service. The returned IBinder is usually for a complex interface that has been described using aidl.

Note that unlike other application components, calls on to the IBinder interface returned here may not happen on the main thread of the process. More information about the main thread can be found in Processes and Threads.

Parameters
intent Intent: The Intent that was used to bind to this service, as given to Context.bindService. Note that any extras that were included with the Intent at that point will not be seen here.

Returns
IBinder Return an IBinder through which clients can call on to the service.

onContentChanged

Added in API level 17
public void onContentChanged ()

This hook is called whenever the content view of the screen changes (due to a call to Window.setContentView or Window.addContentView).

onCreate

Added in API level 17
public void onCreate ()

Called when this Dream is constructed.

onCreatePanelMenu

Added in API level 17
public boolean onCreatePanelMenu (int featureId, 
                Menu menu)

Initialize the contents of the menu for panel 'featureId'. This is called if onCreatePanelView() returns null, giving you a standard menu in which you can place your items. It is only called once for the panel, the first time it is shown.

You can safely hold on to menu (and any items created from it), making modifications to it as desired, until the next time onCreatePanelMenu() is called for this feature.

Parameters
featureId int: The panel being created.

menu Menu: The menu inside the panel. This value cannot be null.

Returns
boolean boolean You must return true for the panel to be displayed; if you return false it will not be shown.

onCreatePanelView

Added in API level 17
public View onCreatePanelView (int featureId)

Instantiate the view to display in the panel for 'featureId'. You can return null, in which case the default content (typically a menu) will be created for you.

Parameters
featureId int: Which panel is being created.

Returns
View view The top-level view to place in the panel.

onDestroy

Added in API level 17
public void onDestroy ()

Called by the system to notify a Service that it is no longer used and is being removed. The service should clean up any resources it holds (threads, registered receivers, etc) at this point. Upon return, there will be no more calls in to this Service object and it is effectively dead. Do not call this method directly.

onDetachedFromWindow

Added in API level 17
public void onDetachedFromWindow ()

Called when the window has been detached from the window manager. See View.onDetachedFromWindow() for more information.

onDreamingStarted

Added in API level 17
public void onDreamingStarted ()

Called when the dream's window has been created and is visible and animation may now begin.

onDreamingStopped

Added in API level 17
public void onDreamingStopped ()

Called when this Dream is stopped, either by external request or by calling finish(), before the window has been removed.

onMenuItemSelected

Added in API level 17
public boolean onMenuItemSelected (int featureId, 
                MenuItem item)

Called when a panel's menu item has been selected by the user.

Parameters
featureId int: The panel that the menu is in.

item MenuItem: The menu item that was selected. This value cannot be null.

Returns
boolean boolean Return true to finish processing of selection, or false to perform the normal menu handling (calling its Runnable or sending a Message to its target Handler).

onMenuOpened

Added in API level 17
public boolean onMenuOpened (int featureId, 
                Menu menu)

Called when a panel's menu is opened by the user. This may also be called when the menu is changing from one type to another (for example, from the icon menu to the expanded menu).

Parameters
featureId int: The panel that the menu is in.

menu Menu: The menu that is opened. This value cannot be null.

Returns
boolean Return true to allow the menu to open, or false to prevent the menu from opening.

onPanelClosed

Added in API level 17
public void onPanelClosed (int featureId, 
                Menu menu)

Called when a panel is being closed. If another logical subsequent panel is being opened (and this panel is being closed to make room for the subsequent panel), this method will NOT be called.

Parameters
featureId int: The panel that is being displayed.

menu Menu: If onCreatePanelView() returned null, this is the Menu being displayed in the panel.

onPreparePanel

Added in API level 17
public boolean onPreparePanel (int featureId, 
                View view, 
                Menu menu)

Prepare a panel to be displayed. This is called right before the panel window is shown, every time it is shown.

Parameters
featureId int: The panel that is being displayed.

view View: The View that was returned by onCreatePanelView(). This value may be null.

menu Menu: If onCreatePanelView() returned null, this is the Menu being displayed in the panel.

Returns
boolean boolean You must return true for the panel to be displayed; if you return false it will not be shown.

onSearchRequested

Added in API level 17
public boolean onSearchRequested ()

Called when the user signals the desire to start a search.

Returns
boolean true if search launched, false if activity refuses (blocks)

onSearchRequested

Added in API level 23
public boolean onSearchRequested (SearchEvent event)

Called when the user signals the desire to start a search.

Parameters
event SearchEvent: A SearchEvent describing the signal to start a search.

Returns
boolean true if search launched, false if activity refuses (blocks)

onUnbind

Added in API level 17
public boolean onUnbind (Intent intent)

Called when all clients have disconnected from a particular interface published by the service. The default implementation does nothing and returns false.

Parameters
intent Intent: The Intent that was used to bind to this service, as given to Context.bindService. Note that any extras that were included with the Intent at that point will not be seen here.

Returns
boolean Return true if you would like to have the service's onRebind(Intent) method later called when new clients bind to it.

onWakeUp

Added in API level 21
public void onWakeUp ()

Called when the dream is being asked to stop itself and wake.

The default implementation simply calls finish() which ends the dream immediately. Subclasses may override this function to perform a smooth exit transition then call finish() afterwards.

Note that the dream will only be given a short period of time (currently about five seconds) to wake up. If the dream does not finish itself in a timely manner then the system will forcibly finish it once the time allowance is up.

onWindowAttributesChanged

Added in API level 17
public void onWindowAttributesChanged (WindowManager.LayoutParams attrs)

This is called whenever the current window attributes change.

Parameters
attrs WindowManager.LayoutParams

onWindowFocusChanged

Added in API level 17
public void onWindowFocusChanged (boolean hasFocus)

This hook is called whenever the window focus changes. See View.onWindowFocusChangedNotLocked(boolean) for more information.

Parameters
hasFocus boolean: Whether the window now has focus.

onWindowStartingActionMode

Added in API level 17
public ActionMode onWindowStartingActionMode (ActionMode.Callback callback)

Called when an action mode is being started for this window. Gives the callback an opportunity to handle the action mode in its own unique and beautiful way. If this method returns null the system can choose a way to present the mode or choose not to start the mode at all. This is equivalent to onWindowStartingActionMode(android.view.ActionMode.Callback, int) with type ActionMode.TYPE_PRIMARY.

Parameters
callback ActionMode.Callback: Callback to control the lifecycle of this action mode

Returns
ActionMode The ActionMode that was started, or null if the system should present it

onWindowStartingActionMode

Added in API level 23
public ActionMode onWindowStartingActionMode (ActionMode.Callback callback, 
                int type)

Called when an action mode is being started for this window. Gives the callback an opportunity to handle the action mode in its own unique and beautiful way. If this method returns null the system can choose a way to present the mode or choose not to start the mode at all.

Parameters
callback ActionMode.Callback: Callback to control the lifecycle of this action mode

type int: One of ActionMode.TYPE_PRIMARY or ActionMode.TYPE_FLOATING.

Returns
ActionMode The ActionMode that was started, or null if the system should present it

requireViewById

Added in API level 28
public final T requireViewById (int id)

Finds a view that was identified by the id attribute from the XML that was processed in onCreate(), or throws an IllegalArgumentException if the ID is invalid or there is no matching view in the hierarchy.

Note: Requires a window, do not call before onAttachedToWindow()

Note: In most cases -- depending on compiler support -- the resulting view is automatically cast to the target class type. If the target class type is unconstrained, an explicit cast may be necessary.

Parameters
id int: the ID to search for

Returns
T a view with given ID This value cannot be null.

setContentView

Added in API level 17
public void setContentView (View view)

Sets a view to be the content view for this Dream. Behaves similarly to Activity.setContentView(android.view.View) in an activity, including using ViewGroup.LayoutParams.MATCH_PARENT as the layout height and width of the view.

Note: This requires a window, so you should usually call it during onAttachedToWindow() and never earlier (you cannot call it during onCreate()).

Parameters
view View

setContentView

Added in API level 17
public void setContentView (int layoutResID)

Inflates a layout resource and set it to be the content view for this Dream. Behaves similarly to Activity.setContentView(int).

Note: Requires a window, do not call before onAttachedToWindow()

Parameters
layoutResID int: Resource ID to be inflated.

setContentView

Added in API level 17
public void setContentView (View view, 
                ViewGroup.LayoutParams params)

Sets a view to be the content view for this Dream. Behaves similarly to Activity.setContentView(android.view.View, android.view.ViewGroup.LayoutParams) in an activity.

Note: This requires a window, so you should usually call it during onAttachedToWindow() and never earlier (you cannot call it during onCreate()).

Parameters
view View: The desired content to display.

params ViewGroup.LayoutParams: Layout parameters for the view.

setFullscreen

Added in API level 17
public void setFullscreen (boolean fullscreen)

Controls WindowManager.LayoutParams.FLAG_FULLSCREEN on the dream's window.

Parameters
fullscreen boolean: If true, the fullscreen flag will be set; else it will be cleared.

setInteractive

Added in API level 17
public void setInteractive (boolean interactive)

Marks this dream as interactive to receive input events.

Non-interactive dreams (default) will dismiss on the first input event.

Interactive dreams should call finish() to dismiss themselves.

Parameters
interactive boolean: True if this dream will handle input events.

setScreenBright

Added in API level 17
public void setScreenBright (boolean screenBright)

Marks this dream as keeping the screen bright while dreaming. In preview mode, the screen is always allowed to dim and overrides the value specified here.

Parameters
screenBright boolean: True to keep the screen bright while dreaming.

wakeUp

Added in API level 21
public final void wakeUp ()

Wakes the dream up gently.

Calls onWakeUp() to give the dream a chance to perform an exit transition. When the transition is over, the dream should call finish().

Protected methods

dump

Added in API level 17
protected void dump (FileDescriptor fd, 
                PrintWriter pw, 
                String[] args)

Print the Service's state into the given stream. This gets invoked if you run "adb shell dumpsys activity service <yourservicename>" (note that for this command to work, the service must be running, and you must specify a fully-qualified service name). This is distinct from "dumpsys <servicename>", which only works for named system services and which invokes the IBinder.dump method on the IBinder interface registered with ServiceManager.

Parameters
fd FileDescriptor: The raw file descriptor that the dump is being sent to.

pw PrintWriter: The PrintWriter to which you should dump your state. This will be closed for you after you return.

args String: additional arguments to the dump request.