NotificationListenerService
abstract class NotificationListenerService : Service
A service that receives calls from the system when new notifications are posted or removed, or their ranking changed.
To extend this class, you must declare the service in your manifest file with the android.Manifest.permission#BIND_NOTIFICATION_LISTENER_SERVICE
permission and include an intent filter with the SERVICE_INTERFACE
action. For example:
<service android:name=".NotificationListener"
android:label="@string/service_name"
android:exported="false"
android:permission="android.permission.BIND_NOTIFICATION_LISTENER_SERVICE">
<intent-filter>
<action android:name="android.service.notification.NotificationListenerService" />
</intent-filter>
<meta-data
android:name="android.service.notification.default_filter_types"
android:value="conversations|alerting">
</meta-data>
<meta-data
android:name="android.service.notification.disabled_filter_types"
android:value="ongoing|silent">
</meta-data>
</service>
The service should wait for the onListenerConnected()
event before performing any operations. The requestRebind(android.content.ComponentName)
method is the only one that is safe to call before onListenerConnected()
or after onListenerDisconnected()
.
Notification listeners cannot get notification access or be bound by the system on low-RAM devices running Android Q (and below). The system also ignores notification listeners running in a work profile. A android.app.admin.DevicePolicyManager
might block notifications originating from a work profile.
From Build.VERSION_CODES#N
onward all callbacks are called on the main thread. Prior to N, there is no guarantee on what thread the callback will happen.
Summary
Nested classes |
open |
Stores ranking related information on a currently active notification.
|
open |
Provides access to ranking information on currently active notifications.
|
Constants |
static String |
An optional activity intent action that shows additional settings for what notifications should be processed by this notification listener service.
|
static Int |
A flag value indicating that this notification listener can see altering type notifications.
|
static Int |
A flag value indicating that this notification listener can see conversation type notifications.
|
static Int |
A flag value indicating that this notification listener can see important ( > NotificationManager#IMPORTANCE_MIN ) ongoing type notifications.
|
static Int |
A flag value indicating that this notification listener can see silent type notifications.
|
static Int |
Listener hints constant - the primary device UI should disable phone call sounds, but not notification sound.
|
static Int |
Listener hints constant - the primary device UI should disable notification sound, vibrating and other visual or aural effects.
|
static Int |
Listener hints constant - the primary device UI should disable notification sound, but not phone calls.
|
static Int |
Interruption filter constant - Alarms only interruption filter.
|
static Int |
Interruption filter constant - Normal interruption filter.
|
static Int |
Interruption filter constant - No interruptions filter.
|
static Int |
Interruption filter constant - Priority interruption filter.
|
static Int |
Interruption filter constant - returned when the value is unavailable for any reason.
|
static String |
The name of the meta-data tag containing a boolean value that is used to decide if this listener should be automatically bound by default.
|
static String |
The name of the meta-data tag containing a pipe separated list of default integer notification types or "ongoing", "conversations", "alerting", or "silent" that should be provided to this listener.
|
static String |
The name of the meta-data tag containing a comma separated list of default integer notification types that this listener never wants to receive.
|
static Int |
Channel or group modification reason provided to onNotificationChannelModified(java.lang.String,android.os.UserHandle,android.app.NotificationChannel,int) or onNotificationChannelGroupModified(java.lang.String,android.os.UserHandle,android.app.NotificationChannelGroup,int) - the provided object was created.
|
static Int |
Channel or group modification reason provided to onNotificationChannelModified(java.lang.String,android.os.UserHandle,android.app.NotificationChannel,int) or onNotificationChannelGroupModified(java.lang.String,android.os.UserHandle,android.app.NotificationChannelGroup,int) - the provided object was deleted.
|
static Int |
Channel or group modification reason provided to onNotificationChannelModified(java.lang.String,android.os.UserHandle,android.app.NotificationChannel,int) or onNotificationChannelGroupModified(java.lang.String,android.os.UserHandle,android.app.NotificationChannelGroup,int) - the provided object was updated.
|
static Int |
Notification was canceled by the app canceling this specific notification.
|
static Int |
Notification was canceled by the app cancelling all its notifications.
|
static Int |
Notification was canceled due to an assistant adjustment update.
|
static Int |
Notification was canceled by the status bar reporting a user dismissal.
|
static Int |
Notification was canceled by the status bar reporting a user dismiss all.
|
static Int |
Notification was canceled by the user banning the channel.
|
static Int |
Notification was canceled due to the backing channel being deleted
|
static Int |
Notification was canceled due to the app's storage being cleared
|
static Int |
Notification was canceled by the status bar reporting a notification click.
|
static Int |
Notification was canceled by the status bar reporting an inflation error.
|
static Int |
Notification was canceled because it was an invisible member of a group.
|
static Int |
Notification was canceled because it was a member of a canceled group.
|
static Int |
Notification was canceled by a listener reporting a user dismissal.
|
static Int |
Notification was canceled by a listener reporting a user dismiss all.
|
static Int |
Notification was canceled when entering lockdown mode, which turns off Smart Lock, fingerprint unlocking, and notifications on the lock screen.
|
static Int |
Notification was canceled by the user banning the package.
|
static Int |
Notification was canceled by the package manager modifying the package.
|
static Int |
Notification was canceled by the device administrator suspending the package.
|
static Int |
Notification was canceled by the owning managed profile being turned off.
|
static Int |
Notification was snoozed.
|
static Int |
Notification was canceled due to timeout
|
static Int |
Autobundled summary notification was canceled because its group was unbundled
|
static Int |
Notification was canceled by the owning user context being stopped.
|
static String |
The Intent that must be declared as handled by the service.
|
static Int |
Whether notification suppressed by DND should not interruption visually when the screen is off.
|
static Int |
Whether notification suppressed by DND should not interruption visually when the screen is on.
|
Inherited constants |
From class Context
String |
ACCESSIBILITY_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.view.accessibility.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 android.accounts.AccountManager for receiving intents at a time of your choosing.
|
String |
ACTIVITY_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.app.ActivityManager for interacting with the global system state.
|
String |
ALARM_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.app.AlarmManager for receiving intents at a time of your choosing.
|
String |
APPWIDGET_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.appwidget.AppWidgetManager for accessing AppWidgets.
|
String |
APP_OPS_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.app.AppOpsManager for tracking application operations on the device.
|
String |
APP_SEARCH_SERVICE
Use with getSystemService(java.lang.String) to retrieve an android.app.appsearch.AppSearchManager for indexing and querying app data managed by the system.
|
String |
AUDIO_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.media.AudioManager for handling management of volume, ringer modes and audio routing.
|
String |
BATTERY_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.os.BatteryManager for managing battery state.
|
Int |
BIND_ABOVE_CLIENT
Flag for #bindService: indicates that the client application binding to this service considers the service to be more important than the app itself. When set, the platform will try to have the out of memory killer kill the app before it kills the service it is bound to, though this is not guaranteed to be the case.
|
Int |
BIND_ADJUST_WITH_ACTIVITY
Flag for #bindService: 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: If binding from an app that is visible, the bound service is allowed to start an activity from background. This was the default behavior before SDK version android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE . Since then, the default behavior changed to disallow the bound service to start a background activity even if the app bound to it is in foreground, unless this flag is specified when binding.
|
Int |
BIND_ALLOW_OOM_MANAGEMENT
Flag for #bindService: allow the process hosting the bound service to go through its normal memory management. It will be treated more like a running service, allowing the system to (temporarily) expunge the process if low on memory or for some other whim it may have, and being more aggressive about making it a candidate to be killed (and restarted) if running for a long time.
|
Int |
BIND_AUTO_CREATE
Flag for #bindService: automatically create the service as long as the binding exists. Note that while this will create the service, its android.app.Service#onStartCommand method will still only be called due to an explicit call to startService . Even without that, though, this still provides you with access to the service object while the service is created.
Note that prior to android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH , not supplying this flag would also impact how important the system consider's the target service's process to be. When set, the only way for it to be raised was by binding from a service in which case it will only be important when that activity is in the foreground. Now to achieve this behavior you must explicitly supply the new flag BIND_ADJUST_WITH_ACTIVITY . For compatibility, old applications that don't specify BIND_AUTO_CREATE will automatically have the flags BIND_WAIVE_PRIORITY and BIND_ADJUST_WITH_ACTIVITY set for them in order to achieve the same result.
|
Int |
BIND_DEBUG_UNBIND
Flag for #bindService: include debugging help for mismatched calls to unbind. When this flag is set, the callstack of the following unbindService call is retained, to be printed if a later incorrect unbind call is made. Note that doing this requires retaining information about the binding that was made for the lifetime of the app, resulting in a leak -- this should only be used for debugging.
|
Int |
BIND_EXTERNAL_SERVICE
Flag for #bindService: The service being bound is an isolated , external service. This binds the service into the calling application's package, rather than the package in which the service is declared.
When using this flag, the code for the service being bound will execute under the calling application's package name and user ID. Because the service must be an isolated process, it will not have direct access to the application's data, though. The purpose of this flag is to allow applications to provide services that are attributed to the app using the service, rather than the application providing the service.
This flag is NOT compatible with BindServiceFlags . If you need to use BindServiceFlags , you must use BIND_EXTERNAL_SERVICE_LONG instead.
|
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: this service is very important to the client, so should be brought to the foreground process level when the client is. Normally a process can only be raised to the visibility level by a client, even if that client is in the foreground.
|
Int |
BIND_INCLUDE_CAPABILITIES
Flag for #bindService: 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. If binding from a top app and its target SDK version is at or above android.os.Build.VERSION_CODES#R , the app needs to explicitly use BIND_INCLUDE_CAPABILITIES flag to pass all capabilities to the service so the other app can have while-in-use access such as location, camera, microphone from background. If binding from a top app and its target SDK version is below android.os.Build.VERSION_CODES#R , BIND_INCLUDE_CAPABILITIES is implicit.
|
Int |
BIND_NOT_FOREGROUND
Flag for #bindService: don't allow this binding to raise the target service's process to the foreground scheduling priority. It will still be raised to at least the same memory priority as the client (so that its process will not be killable in any situation where the client is not killable), but for CPU scheduling purposes it may be left in the background. This only has an impact in the situation where the binding client is a foreground process and the target service is in a background process.
|
Int |
BIND_NOT_PERCEPTIBLE
Flag for #bindService: If binding from an app that is visible or user-perceptible, lower the target service's importance to below the perceptible level. This allows the system to (temporarily) expunge the bound process from memory to make room for more important user-perceptible processes.
|
Int |
BIND_PACKAGE_ISOLATED_PROCESS
Flag for #bindIsolatedService: Bind the service into a shared isolated process, but only with other isolated services from the same package that declare the same process name.
Specifying this flag allows multiple isolated services defined in the same package to be running in a single shared isolated process. This shared isolated process must be specified since this flag will not work with the default application process.
This flag is different from BIND_SHARED_ISOLATED_PROCESS since it only allows binding services from the same package in the same shared isolated process. This also means the shared package isolated process is global, and not scoped to each potential calling app.
The shared isolated process instance is identified by the "android:process" attribute defined by the service. This flag cannot be used without this attribute set.
|
Int |
BIND_SHARED_ISOLATED_PROCESS
Flag for #bindIsolatedService: Bind the service into a shared isolated process. Specifying this flag allows multiple isolated services to be running in a single shared isolated process. The shared isolated process instance is identified by the instanceName parameter in bindIsolatedService(android.content.Intent,int,java.lang.String,java.util.concurrent.Executor,android.content.ServiceConnection) . Subsequent calls to #bindIsolatedService with the same instanceName will cause the isolated service to be co-located in the same shared isolated process. Note that the shared isolated process is scoped to the calling app; once created, only the calling app can bind additional isolated services into the shared process. However, the services themselves can come from different APKs and therefore different vendors. Only services that set the android.R.attr#allowSharedIsolatedProcess attribute to true are allowed to be bound into a shared isolated process.
|
Int |
BIND_WAIVE_PRIORITY
Flag for #bindService: don't impact the scheduling or memory management priority of the target service's hosting process. Allows the service's process to be managed on the background LRU list just like a regular application process in the background.
|
String |
BIOMETRIC_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.hardware.biometrics.BiometricManager for handling biometric and PIN/pattern/password authentication.
|
String |
BLOB_STORE_SERVICE
Use with getSystemService(java.lang.String) to retrieve a 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 android.bluetooth.BluetoothManager for using Bluetooth.
|
String |
BUGREPORT_SERVICE
Service to capture a bugreport.
|
String |
CAMERA_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.hardware.camera2.CameraManager for interacting with camera devices.
|
String |
CAPTIONING_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.view.accessibility.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 android.telephony.CarrierConfigManager for reading carrier configuration values.
|
String |
CLIPBOARD_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.content.ClipboardManager for accessing and modifying the contents of the global clipboard.
|
String |
COMPANION_DEVICE_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.companion.CompanionDeviceManager for managing companion devices
|
String |
CONNECTIVITY_DIAGNOSTICS_SERVICE
Use with getSystemService(java.lang.String) to retrieve a 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 for handling management of network connections.
|
String |
CONSUMER_IR_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.hardware.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 : ignore any security restrictions on the Context being requested, allowing it to always be loaded. For use with CONTEXT_INCLUDE_CODE to allow code to be loaded into a process even when it isn't safe to do so. Use with extreme care!
|
Int |
CONTEXT_INCLUDE_CODE
Flag for use with createPackageContext : include the application code with the context. This means loading code into the caller's process, so that getClassLoader() can be used to instantiate the application's classes. Setting this flags imposes security restrictions on what application context you can access; if the requested application can not be safely loaded into your process, java.lang.SecurityException will be thrown. If this flag is not set, there will be no restrictions on the packages that can be loaded, but getClassLoader will always return the default system class loader.
|
Int |
CONTEXT_RESTRICTED
Flag for use with createPackageContext : a restricted context may disable specific features. For instance, a View associated with a restricted context would ignore particular XML attributes.
|
String |
CREDENTIAL_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.credentials.CredentialManager to authenticate a user to your app.
|
String |
CROSS_PROFILE_APPS_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.content.pm.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 android.devicelock.DeviceLockManager .
|
String |
DEVICE_POLICY_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.app.admin.DevicePolicyManager for working with global device policy management.
|
String |
DISPLAY_HASH_SERVICE
Use with getSystemService(java.lang.String) to access android.view.displayhash.DisplayHashManager to handle display hashes.
|
String |
DISPLAY_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.hardware.display.DisplayManager for interacting with display devices.
|
String |
DOMAIN_VERIFICATION_SERVICE
Use with getSystemService(java.lang.String) to access android.content.pm.verify.domain.DomainVerificationManager to retrieve approval and user state for declared web domains.
|
String |
DOWNLOAD_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.app.DownloadManager for requesting HTTP downloads.
|
String |
DROPBOX_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.os.DropBoxManager instance for recording diagnostic logs.
|
String |
EUICC_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.telephony.euicc.EuiccManager to manage the device eUICC (embedded SIM).
|
String |
FILE_INTEGRITY_SERVICE
Use with getSystemService(java.lang.String) to retrieve an android.security.FileIntegrityManager .
|
String |
FINGERPRINT_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.hardware.fingerprint.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 android.os.HardwarePropertiesManager for accessing the hardware properties service.
|
String |
HEALTHCONNECT_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.health.connect.HealthConnectManager .
|
String |
INPUT_METHOD_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.view.inputmethod.InputMethodManager for accessing input methods.
|
String |
INPUT_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.hardware.input.InputManager for interacting with input devices.
|
String |
IPSEC_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.net.IpSecManager for encrypting Sockets or Networks with IPSec.
|
String |
JOB_SCHEDULER_SERVICE
Use with getSystemService(java.lang.String) to retrieve a instance for managing occasional background tasks.
|
String |
KEYGUARD_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.app.KeyguardManager for controlling keyguard.
|
String |
LAUNCHER_APPS_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.content.pm.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 android.view.LayoutInflater for inflating layout resources in this context.
|
String |
LOCALE_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.app.LocaleManager .
|
String |
LOCATION_SERVICE
Use with getSystemService(java.lang.String) to retrieve a for controlling location updates.
|
String |
MEDIA_COMMUNICATION_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.media.MediaCommunicationManager for managing android.media.MediaSession2 .
|
String |
MEDIA_METRICS_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.media.metrics.MediaMetricsManager for interacting with media metrics on the device.
|
String |
MEDIA_PROJECTION_SERVICE
Use with getSystemService(java.lang.String) to retrieve a instance for managing media projection sessions.
|
String |
MEDIA_ROUTER_SERVICE
Use with #getSystemService to retrieve a android.media.MediaRouter for controlling and managing routing of media.
|
String |
MEDIA_SESSION_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.media.session.MediaSessionManager for managing media Sessions.
|
String |
MIDI_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.media.midi.MidiManager for accessing the MIDI service.
|
Int |
MODE_APPEND
File creation mode: for use with openFileOutput , 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
SharedPreference loading flag: when set, the file on disk will be checked for modification even if the shared preferences instance is already loaded in this process. This behavior is sometimes desired in cases where the application has multiple processes, all writing to the same SharedPreferences file. Generally there are better forms of communication between processes, though.
This was the legacy (but undocumented) behavior in and before Gingerbread (Android 2.3) and this flag is implied when targeting such releases. For applications targeting SDK versions greater than Android 2.3, this flag must be explicitly set if desired.
|
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
File creation mode: allow all other applications to have read access to the created file.
Starting from android.os.Build.VERSION_CODES#N , attempting to use this mode throws a SecurityException .
|
Int |
MODE_WORLD_WRITEABLE
File creation mode: allow all other applications to have write access to the created file.
Starting from android.os.Build.VERSION_CODES#N , attempting to use this mode will throw a SecurityException .
|
String |
NETWORK_STATS_SERVICE
Use with getSystemService(java.lang.String) to retrieve a for querying network usage stats.
|
String |
NFC_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.nfc.NfcManager for using NFC.
|
String |
NOTIFICATION_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.app.NotificationManager for informing the user of background events.
|
String |
NSD_SERVICE
Use with getSystemService(java.lang.String) to retrieve a for handling management of network service discovery
|
String |
OVERLAY_SERVICE
Use with getSystemService(java.lang.String) to retrieve a 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 android.os.PerformanceHintManager for accessing the performance hinting service.
|
String |
PERSISTENT_DATA_BLOCK_SERVICE
Use with getSystemService(java.lang.String) to retrieve a instance for interacting with a storage device that lives across factory resets.
|
String |
POWER_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.os.PowerManager for controlling power management, including "wake locks," which let you keep the device on while you're running long tasks.
|
String |
PRINT_SERVICE
android.print.PrintManager for printing and managing printers and print tasks.
|
String |
PROFILING_SERVICE
Use with getSystemService(java.lang.String) to retrieve an android.os.ProfilingManager .
|
Int |
RECEIVER_EXPORTED
Flag for #registerReceiver: The receiver can receive broadcasts from other Apps. Has the same behavior as marking a statically registered receiver with "exported=true"
|
Int |
RECEIVER_NOT_EXPORTED
Flag for #registerReceiver: The receiver cannot receive broadcasts from other Apps. Has the same behavior as marking a statically registered receiver with "exported=false"
|
Int |
RECEIVER_VISIBLE_TO_INSTANT_APPS
Flag for #registerReceiver: The receiver can receive broadcasts from Instant Apps.
|
String |
RESTRICTIONS_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.content.RestrictionsManager for retrieving application restrictions and requesting permissions for restricted operations.
|
String |
ROLE_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.app.role.RoleManager for managing roles.
|
String |
SEARCH_SERVICE
Use with getSystemService(java.lang.String) to retrieve a for handling searches.
Configuration#UI_MODE_TYPE_WATCH does not support android.app.SearchManager .
|
String |
SECURITY_STATE_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.os.SecurityStateManager for accessing the security state manager service.
|
String |
SENSOR_SERVICE
Use with getSystemService(java.lang.String) to retrieve a for accessing sensors.
|
String |
SHORTCUT_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.content.pm.ShortcutManager for accessing the launcher shortcut service.
|
String |
STATUS_BAR_SERVICE
Use with getSystemService(java.lang.String) to retrieve a for interacting with the status bar and quick settings.
|
String |
STORAGE_SERVICE
Use with getSystemService(java.lang.String) to retrieve a for accessing system storage functions.
|
String |
STORAGE_STATS_SERVICE
Use with getSystemService(java.lang.String) to retrieve a for accessing system storage statistics.
|
String |
SYSTEM_HEALTH_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.os.health.SystemHealthManager for accessing system health (battery, power, memory, etc) metrics.
|
String |
TELECOM_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.telecom.TelecomManager to manage telecom-related features of the device.
|
String |
TELEPHONY_IMS_SERVICE
Use with getSystemService(java.lang.String) to retrieve an android.telephony.ims.ImsManager .
|
String |
TELEPHONY_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.telephony.TelephonyManager for handling management the telephony features of the device.
|
String |
TELEPHONY_SUBSCRIPTION_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.telephony.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 android.view.textservice.TextServicesManager for accessing text services.
|
String |
TV_INPUT_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.media.tv.TvInputManager for interacting with TV inputs on the device.
|
String |
TV_INTERACTIVE_APP_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.media.tv.interactive.TvInteractiveAppManager for interacting with TV interactive applications on the device.
|
String |
UI_MODE_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.app.UiModeManager for controlling UI modes.
|
String |
USAGE_STATS_SERVICE
Use with getSystemService(java.lang.String) to retrieve a for querying device usage stats.
|
String |
USB_SERVICE
Use with getSystemService(java.lang.String) to retrieve a 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 android.os.UserManager for managing users on devices that support multiple users.
|
String |
VIBRATOR_MANAGER_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.os.VibratorManager for accessing the device vibrators, interacting with individual ones and playing synchronized effects on multiple vibrators.
|
String |
VIBRATOR_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.os.Vibrator for interacting with the vibration hardware.
|
String |
VIRTUAL_DEVICE_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.companion.virtual.VirtualDeviceManager for managing virtual devices. On devices without PackageManager#FEATURE_COMPANION_DEVICE_SETUP system feature the getSystemService(java.lang.String) will return null .
|
String |
VPN_MANAGEMENT_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.net.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 android.net.wifi.aware.WifiAwareManager for handling management of Wi-Fi Aware.
|
String |
WIFI_P2P_SERVICE
Use with getSystemService(java.lang.String) to retrieve a for handling management of Wi-Fi peer-to-peer connections.
|
String |
WIFI_RTT_RANGING_SERVICE
Use with getSystemService(java.lang.String) to retrieve a for ranging devices with wifi.
|
String |
WIFI_SERVICE
Use with getSystemService(java.lang.String) to retrieve a for handling management of Wi-Fi access.
|
String |
WINDOW_SERVICE
Use with getSystemService(java.lang.String) to retrieve a android.view.WindowManager for accessing the system's window manager.
|
|
From class Service
Int |
START_CONTINUATION_MASK
Bits returned by onStartCommand describing how to continue the service if it is killed. May be START_STICKY , START_NOT_STICKY , START_REDELIVER_INTENT , or START_STICKY_COMPATIBILITY .
|
Int |
START_FLAG_REDELIVERY
This flag is set in onStartCommand 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 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 : if this service's process is killed while it is started (after returning from onStartCommand ), 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) . The service will not receive a onStartCommand(android.content.Intent,int,int) call with a null Intent because it will not be restarted if there are no pending Intents to deliver.
This mode makes sense for things that want to do some work as a result of being started, but can be stopped when under memory pressure and will explicit start themselves again later to do more work. An example of such a service would be one that polls for data from a server: it could schedule an alarm to poll every N minutes by having the alarm start its service. When its onStartCommand is called from the alarm, it schedules a new alarm for N minutes later, and spawns a thread to do its networking. If its process is killed while doing that check, the service will not be restarted until the alarm goes off.
|
Int |
START_REDELIVER_INTENT
Constant to return from onStartCommand : if this service's process is killed while it is started (after returning from onStartCommand ), then it will be scheduled for a restart and the last delivered Intent re-delivered to it again via onStartCommand . This Intent will remain scheduled for redelivery until the service calls stopSelf(int) with the start ID provided to onStartCommand . The service will not receive a onStartCommand(android.content.Intent,int,int) call with a null Intent because it will only be restarted if it is not finished processing all Intents sent to it (and any such pending events will be delivered at the point of restart).
|
Int |
START_STICKY
Constant to return from onStartCommand : if this service's process is killed while it is started (after returning from onStartCommand ), then leave it in the started state but don't retain this delivered intent. Later the system will try to re-create the service. Because it is in the started state, it will guarantee to call onStartCommand after creating the new service instance; if there are not any pending start commands to be delivered to the service, it will be called with a null intent object, so you must take care to check for this.
This mode makes sense for things that will be explicitly started and stopped to run for arbitrary periods of time, such as a service performing background music playback.
Since Android version Build.VERSION_CODES#S , apps targeting Build.VERSION_CODES#S or above are disallowed to start a foreground service from the background, but the restriction doesn't impact restarts of a sticky foreground service. However, when apps start a sticky foreground service from the background, the same restriction still applies.
|
Int |
START_STICKY_COMPATIBILITY
Constant to return from onStartCommand : compatibility version of START_STICKY that does not guarantee that onStartCommand will be called again after being killed.
|
Int |
STOP_FOREGROUND_DETACH
Selector for stopForeground(int) : if set, the notification previously supplied to #startForeground will be detached from the service's lifecycle. The notification will remain shown even after the service is stopped and destroyed.
|
Int |
STOP_FOREGROUND_LEGACY
Selector for stopForeground(int) : equivalent to passing false to the legacy API stopForeground(boolean) .
|
Int |
STOP_FOREGROUND_REMOVE
Selector for stopForeground(int) : if supplied, the notification previously supplied to #startForeground will be cancelled and removed from display.
|
|
From class ComponentCallbacks2
Int |
TRIM_MEMORY_BACKGROUND
Level for onTrimMemory(int) : the process has gone on to the LRU list. This is a good opportunity to clean up resources that can efficiently and quickly be re-built if the user returns to the app.
|
Int |
TRIM_MEMORY_COMPLETE
Level for onTrimMemory(int) : the process is nearing the end of the background LRU list, and if more memory isn't found soon it will be killed.
|
Int |
TRIM_MEMORY_MODERATE
Level for onTrimMemory(int) : the process is around the middle of the background LRU list; freeing memory can help the system keep other processes running later in the list for better overall performance.
|
Int |
TRIM_MEMORY_RUNNING_CRITICAL
Level for onTrimMemory(int) : the process is not an expendable background process, but the device is running extremely low on memory and is about to not be able to keep any background processes running. Your running process should free up as many non-critical resources as it can to allow that memory to be used elsewhere. The next thing that will happen after this is onLowMemory() called to report that nothing at all can be kept in the background, a situation that can start to notably impact the user.
|
Int |
TRIM_MEMORY_RUNNING_LOW
Level for onTrimMemory(int) : the process is not an expendable background process, but the device is running low on memory. Your running process should free up unneeded resources to allow that memory to be used elsewhere.
|
Int |
TRIM_MEMORY_RUNNING_MODERATE
Level for onTrimMemory(int) : the process is not an expendable background process, but the device is running moderately low on memory. Your running process may want to release some unneeded resources for use elsewhere.
|
Int |
TRIM_MEMORY_UI_HIDDEN
Level for onTrimMemory(int) : the process had been showing a user interface, and is no longer doing so. Large allocations with the UI should be released at this point to allow memory to be better managed.
|
|
Public methods |
Unit |
Inform the notification manager about dismissal of all notifications.
|
Unit |
Inform the notification manager about dismissal of a single notification.
|
Unit |
Inform the notification manager about dismissal of a single notification.
|
Unit |
Inform the notification manager about dismissal of specific notifications.
|
Unit |
Clears listener hints set via getCurrentListenerHints() .
|
open Array<StatusBarNotification!>! |
Request the list of outstanding notifications (that is, those that are visible to the current user).
|
open Array<StatusBarNotification!>! |
Request one or more notifications by key.
|
Int |
Gets the current notification interruption filter active on the host.
|
Int |
Gets the set of hints representing current state.
|
open NotificationListenerService.RankingMap! |
Returns current ranking information.
|
MutableList<NotificationChannelGroup!>! |
Returns all notification channel groups belonging to the given package for a given user.
|
MutableList<NotificationChannel!>! |
Returns all notification channels belonging to the given package for a given user.
|
Array<StatusBarNotification!>! |
Like getActiveNotifications() , but returns the list of currently snoozed notifications, for all users this listener has access to.
|
Unit |
Lets an app migrate notification filters from its app into the OS.
|
open IBinder? |
This is not the lifecycle event you are looking for.
|
open Unit |
|
open Unit |
Implement this method to be notified when the interruption filter changed.
|
open Unit |
Implement this method to learn about when the listener is enabled and connected to the notification manager.
|
open Unit |
Implement this method to learn about when the listener is disconnected from the notification manager.
|
open Unit |
Implement this method to be notified when the Listener hints change.
|
open Unit |
Implement this method to learn about notification channel group modifications.
|
open Unit |
Implement this method to learn about notification channel modifications.
|
open Unit |
Implement this method to learn about new notifications as they are posted by apps.
|
open Unit |
Implement this method to learn about new notifications as they are posted by apps.
|
open Unit |
Implement this method to be notified when the notification ranking changes.
|
open Unit |
Implement this method to learn when notifications are removed.
|
open Unit |
Implement this method to learn when notifications are removed.
|
open Unit |
Implement this method to learn when notifications are removed and why.
|
open Unit |
Implement this method to be notified when the behavior of silent notifications in the status bar changes.
|
Unit |
Sets the desired interruption filter .
|
Unit |
Sets the desired listener hints .
|
open static Unit |
Request that the listener be rebound, after a previous call to #requestUnbind.
|
Unit |
Request that the service be unbound.
|
open static Unit |
Request that the service be unbound.
|
Unit |
Inform the notification manager that these notifications have been viewed by the user.
|
Unit |
Inform the notification manager about snoozing a specific notification.
|
Unit |
Updates a notification channel for a given package for a given user.
|
Protected methods |
open Unit |
|
Inherited functions |
From class ContextWrapper
Boolean |
bindIsolatedService(service: Intent, flags: Int, instanceName: String, executor: Executor, conn: ServiceConnection)
|
Boolean |
bindService(service: Intent, conn: ServiceConnection, flags: Int)
|
Boolean |
bindService(service: Intent, conn: ServiceConnection, flags: Context.BindServiceFlags)
See bindService(android.content.Intent,android.content.ServiceConnection,int) Call BindServiceFlags#of(long) to obtain a BindServiceFlags object.
|
Boolean |
bindService(service: Intent, flags: Int, executor: Executor, conn: ServiceConnection)
|
Boolean |
bindService(service: Intent, flags: Context.BindServiceFlags, executor: Executor, conn: ServiceConnection)
See bindService(android.content.Intent,int,java.util.concurrent.Executor,android.content.ServiceConnection) Call BindServiceFlags#of(long) to obtain a BindServiceFlags object.
|
Int |
checkCallingOrSelfPermission(permission: String)
|
Int |
checkCallingOrSelfUriPermission(uri: Uri!, modeFlags: Int)
|
IntArray |
checkCallingOrSelfUriPermissions(uris: MutableList<Uri!>, modeFlags: Int)
Determine whether the calling process of an IPC or you has been granted permission to access a list of URIs. This is the same as checkCallingUriPermission , except it grants your own permissions if you are not currently processing an IPC. Use with care!
|
Int |
checkCallingPermission(permission: String)
|
Int |
checkCallingUriPermission(uri: Uri!, modeFlags: Int)
|
IntArray |
checkCallingUriPermissions(uris: MutableList<Uri!>, modeFlags: Int)
Determine whether the calling process and uid has been granted permission to access a list of URIs. This is basically the same as calling checkUriPermissions(java.util.List,int,int,int) with the pid and uid returned by android.os.Binder#getCallingPid and android.os.Binder#getCallingUid . One important difference is that if you are not currently processing an IPC, this function will always fail.
|
Int |
checkContentUriPermissionFull(uri: Uri, pid: Int, uid: Int, modeFlags: Int)
Determine whether a particular process and uid has been granted permission to access a specific content URI.
Unlike checkUriPermission(android.net.Uri,int,int,int) , this method checks for general access to the URI's content provider, as well as explicitly granted permissions.
Note, this check will throw an IllegalArgumentException for non-content URIs.
|
Int |
checkPermission(permission: String, pid: Int, uid: Int)
|
Int |
checkSelfPermission(permission: String)
|
Int |
checkUriPermission(uri: Uri!, pid: Int, uid: Int, modeFlags: Int)
|
Int |
checkUriPermission(uri: Uri?, readPermission: String?, writePermission: String?, pid: Int, uid: Int, modeFlags: Int)
Check both a Uri and normal permission. This allows you to perform both checkPermission and #checkUriPermission in one call.
|
IntArray |
checkUriPermissions(uris: MutableList<Uri!>, pid: Int, uid: Int, modeFlags: Int)
Determine whether a particular process and uid has been granted permission to access a list of URIs. This only checks for permissions that have been explicitly granted -- if the given process/uid has more general access to the URI's content provider then this check will always fail. Note: On SDK Version android.os.Build.VERSION_CODES#S , calling this method from a secondary-user's context will incorrectly return PackageManager#PERMISSION_DENIED for all {code uris}.
|
Unit |
clearWallpaper()
|
Context |
createAttributionContext(attributionTag: String?)
Return a new Context object for the current Context but attribute to a different tag. In complex apps attribution tagging can be used to distinguish between separate logical parts.
|
Context! |
createConfigurationContext(overrideConfiguration: Configuration)
|
Context |
createContext(contextParams: ContextParams)
Creates a context with specific properties and behaviors.
|
Context |
createDeviceContext(deviceId: Int)
Returns a new Context object from the current context but with device association given by the deviceId . Each call to this method returns a new instance of a context object. Context objects are not shared; however, common state (such as the ClassLoader and other resources for the same configuration) can be shared, so the Context itself is lightweight.
Applications that run on virtual devices may use this method to access the default device capabilities and functionality (by passing Context#DEVICE_ID_DEFAULT . Similarly, applications running on the default device may access the functionality of virtual devices.
Note that the newly created instance will be associated with the same display as the parent Context, regardless of the device ID passed here.
|
Context! |
createDeviceProtectedStorageContext()
|
Context! |
createDisplayContext(display: Display)
|
Context! |
createPackageContext(packageName: String!, flags: Int)
|
Context |
createWindowContext(type: Int, options: Bundle?)
Creates a Context for a non-activity window.
A window context is a context that can be used to add non-activity windows, such as android.view.WindowManager.LayoutParams#TYPE_APPLICATION_OVERLAY . A window context must be created from a context that has an associated Display , such as Activity or a context created with createDisplayContext(android.view.Display) .
The window context is created with the appropriate Configuration for the area of the display that the windows created with it can occupy; it must be used when inflating views, such that they can be inflated with proper Resources . Below is a sample code to add an application overlay window on the primary display:
...
final DisplayManager dm = anyContext.getSystemService(DisplayManager.class);
final Display primaryDisplay = dm.getDisplay(DEFAULT_DISPLAY);
final Context windowContext = anyContext.createDisplayContext(primaryDisplay)
.createWindowContext(TYPE_APPLICATION_OVERLAY, null);
final View overlayView = Inflater.from(windowContext).inflate(someLayoutXml, null);
// WindowManager.LayoutParams initialization
...
// The types used in addView and createWindowContext must match.
mParams.type = TYPE_APPLICATION_OVERLAY;
...
windowContext.getSystemService(WindowManager.class).addView(overlayView, mParams);
This context's configuration and resources are adjusted to an area of the display where the windows with provided type will be added. Note that all windows associated with the same context will have an affinity and can only be moved together between different displays or areas on a display. If there is a need to add different window types, or non-associated windows, separate Contexts should be used.
Creating a window context is an expensive operation. Misuse of this API may lead to a huge performance drop. The best practice is to use the same window context when possible. An approach is to create one window context with specific window type and display and use it everywhere it's needed.
After Build.VERSION_CODES#S , window context provides the capability to receive configuration changes for existing token by overriding the token of the android.view.WindowManager.LayoutParams passed in WindowManager#addView(View, LayoutParams) . This is useful when an application needs to attach its window to an existing activity for window token sharing use-case.
Note that the window context in Build.VERSION_CODES#R didn't have this capability. This is a no-op for the window context in Build.VERSION_CODES#R .
Below is sample code to attach an existing token to a window context:
final DisplayManager dm = anyContext.getSystemService(DisplayManager.class);
final Display primaryDisplay = dm.getDisplay(DEFAULT_DISPLAY);
final Context windowContext = anyContext.createWindowContext(primaryDisplay,
TYPE_APPLICATION, null);
// Get an existing token.
final IBinder existingToken = activity.getWindow().getAttributes().token;
// The types used in addView() and createWindowContext() must match.
final WindowManager.LayoutParams params = new WindowManager.LayoutParams(TYPE_APPLICATION);
params.token = existingToken;
// After WindowManager#addView(), the server side will extract the provided token from
// LayoutParams#token (existingToken in the sample code), and switch to propagate
// configuration changes from the node associated with the provided token.
windowContext.getSystemService(WindowManager.class).addView(overlayView, mParams);
After Build.VERSION_CODES#S , window context provides the capability to listen to its Configuration changes by calling registerComponentCallbacks(android.content.ComponentCallbacks) , while other kinds of Context will register the ComponentCallbacks to its . Note that window context only propagate ComponentCallbacks#onConfigurationChanged(Configuration) callback. ComponentCallbacks#onLowMemory() or other callbacks in ComponentCallbacks2 won't be invoked.
Note that using android.app.Application or android.app.Service context for UI-related queries may result in layout or continuity issues on devices with variable screen sizes (e.g. foldables) or in multi-window modes, since these non-UI contexts may not reflect the Configuration changes for the visual container.
|
Context |
createWindowContext(display: Display, type: Int, options: Bundle?)
Creates a Context for a non-activity window on the given Display .
Similar to createWindowContext(int,android.os.Bundle) , but the display is passed in, instead of implicitly using the original Context's Display .
|
Array<String!>! |
databaseList()
|
Boolean |
deleteDatabase(name: String!)
|
Boolean |
deleteFile(name: String!)
|
Boolean |
deleteSharedPreferences(name: String!)
|
Unit |
enforceCallingOrSelfPermission(permission: String, message: String?)
If neither you nor the calling process of an IPC you are handling has been granted a particular permission, throw a SecurityException . This is the same as enforceCallingPermission , except it grants your own permissions if you are not currently processing an IPC. Use with care!
|
Unit |
enforceCallingOrSelfUriPermission(uri: Uri!, modeFlags: Int, message: String!)
|
Unit |
enforceCallingPermission(permission: String, message: String?)
If the calling process of an IPC you are handling has not been granted a particular permission, throw a SecurityException . This is basically the same as calling enforcePermission(java.lang.String,int,int,java.lang.String) with the pid and uid returned by android.os.Binder#getCallingPid and android.os.Binder#getCallingUid . One important difference is that if you are not currently processing an IPC, this function will always throw the SecurityException. This is done to protect against accidentally leaking permissions; you can use enforceCallingOrSelfPermission to avoid this protection.
|
Unit |
enforceCallingUriPermission(uri: Uri!, modeFlags: Int, message: String!)
|
Unit |
enforcePermission(permission: String, pid: Int, uid: Int, message: String?)
If the given permission is not allowed for a particular process and user ID running in the system, throw a SecurityException .
|
Unit |
enforceUriPermission(uri: Uri!, pid: Int, uid: Int, modeFlags: Int, message: String!)
|
Unit |
enforceUriPermission(uri: Uri?, readPermission: String?, writePermission: String?, pid: Int, uid: Int, modeFlags: Int, message: String?)
Enforce both a Uri and normal permission. This allows you to perform both enforcePermission and #enforceUriPermission in one call.
|
Array<String!>! |
fileList()
|
Context! |
getApplicationContext()
|
ApplicationInfo! |
getApplicationInfo()
|
AssetManager! |
getAssets()
|
AttributionSource |
getAttributionSource()
|
Context! |
getBaseContext()
|
File! |
getCacheDir()
|
ClassLoader! |
getClassLoader()
|
File! |
getCodeCacheDir()
|
ContentResolver! |
getContentResolver()
|
File! |
getDataDir()
|
File! |
getDatabasePath(name: String!)
|
Int |
getDeviceId()
|
File! |
getDir(name: String!, mode: Int)
|
Display! |
getDisplay()
Get the display this context is associated with. Applications should use this method with android.app.Activity or a context associated with a Display via createDisplayContext(android.view.Display) to get a display object associated with a Context, or android.hardware.display.DisplayManager#getDisplay to get a display object by id.
|
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. These files are internal to the application, and not typically visible to the user as media.
This is like getCacheDir() in that these files will be deleted when the application is uninstalled, however there are some important differences:
If a shared storage device is emulated (as determined by Environment#isExternalStorageEmulated(File) ), its contents are backed by a private user data partition, which means there is little benefit to storing data here instead of the private directory returned by getCacheDir() .
Starting in android.os.Build.VERSION_CODES#KITKAT , no permissions are required to read or write to the returned path; it's always accessible to the calling app. This only applies to paths generated for package name of the calling application. To access paths belonging to other packages, android.Manifest.permission#WRITE_EXTERNAL_STORAGE and/or android.Manifest.permission#READ_EXTERNAL_STORAGE are required.
On devices with multiple users (as described by UserManager ), each user has their own isolated shared storage. Applications only have access to the shared storage for the user they're running as.
The returned path may change over time if different shared storage media is inserted, so only relative paths should be persisted.
|
Array<File!>! |
getExternalCacheDirs()
|
File? |
getExternalFilesDir(type: String?)
Returns the absolute path to the directory on the primary shared/external storage device where the application can place persistent files it owns. These files are internal to the applications, and not typically visible to the user as media.
This is like getFilesDir() in that these files will be deleted when the application is uninstalled, however there are some important differences:
If a shared storage device is emulated (as determined by Environment#isExternalStorageEmulated(File) ), its contents are backed by a private user data partition, which means there is little benefit to storing data here instead of the private directories returned by getFilesDir() , etc.
Starting in android.os.Build.VERSION_CODES#KITKAT , no permissions are required to read or write to the returned path; it's always accessible to the calling app. This only applies to paths generated for package name of the calling application. To access paths belonging to other packages, android.Manifest.permission#WRITE_EXTERNAL_STORAGE and/or android.Manifest.permission#READ_EXTERNAL_STORAGE are required.
On devices with multiple users (as described by UserManager ), each user has their own isolated shared storage. Applications only have access to the shared storage for the user they're running as.
The returned path may change over time if different shared storage media is inserted, so only relative paths should be persisted.
Here is an example of typical code to manipulate a file in an application's shared storage:
If you supply a non-null type to this function, the returned file will be a path to a sub-directory of the given type. Though these files are not automatically scanned by the media scanner, you can explicitly add them to the media database with MediaScannerConnection.scanFile . Note that this is not the same as Environment.getExternalStoragePublicDirectory() , which provides directories of media shared by all applications. The directories returned here are owned by the application, and their contents will be removed when the application is uninstalled. Unlike Environment.getExternalStoragePublicDirectory() , the directory returned here will be automatically created for you.
Here is an example of typical code to manipulate a picture in an application's shared storage and add it to the media database:
|
Array<File!>! |
getExternalFilesDirs(type: String!)
|
Array<File!>! |
getExternalMediaDirs()
|
File! |
getFileStreamPath(name: String!)
|
File! |
getFilesDir()
|
Executor! |
getMainExecutor()
|
Looper! |
getMainLooper()
|
File! |
getNoBackupFilesDir()
|
File! |
getObbDir()
|
Array<File!>! |
getObbDirs()
|
String! |
getPackageCodePath()
|
PackageManager! |
getPackageManager()
|
String! |
getPackageName()
|
String! |
getPackageResourcePath()
|
ContextParams? |
getParams()
Return the set of parameters which this Context was created with, if it was created via createContext(android.content.ContextParams) .
|
Resources! |
getResources()
|
SharedPreferences! |
getSharedPreferences(name: String!, mode: Int)
|
Any! |
getSystemService(name: String)
|
String? |
getSystemServiceName(serviceClass: Class<*>)
|
Resources.Theme! |
getTheme()
|
Drawable! |
getWallpaper()
|
Int |
getWallpaperDesiredMinimumHeight()
|
Int |
getWallpaperDesiredMinimumWidth()
|
Unit |
grantUriPermission(toPackage: String!, uri: Uri!, modeFlags: Int)
|
Boolean |
isDeviceProtectedStorage()
|
Boolean |
isRestricted()
|
Boolean |
moveDatabaseFrom(sourceContext: Context!, name: String!)
|
Boolean |
moveSharedPreferencesFrom(sourceContext: Context!, name: String!)
|
FileInputStream! |
openFileInput(name: String!)
|
FileOutputStream! |
openFileOutput(name: String!, mode: Int)
|
SQLiteDatabase! |
openOrCreateDatabase(name: String!, mode: Int, factory: SQLiteDatabase.CursorFactory!)
|
SQLiteDatabase! |
openOrCreateDatabase(name: String!, mode: Int, factory: SQLiteDatabase.CursorFactory!, errorHandler: DatabaseErrorHandler?)
Open a new private SQLiteDatabase associated with this Context's application package. Creates the database file if it doesn't exist.
Accepts input param: a concrete instance of DatabaseErrorHandler to be used to handle corruption when sqlite reports database corruption.
|
Drawable! |
peekWallpaper()
|
Unit |
registerComponentCallbacks(callback: ComponentCallbacks!)
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. Note that you must be sure to use unregisterComponentCallbacks when appropriate in the future; this will not be removed for you.
After Build.VERSION_CODES#TIRAMISU , the ComponentCallbacks will be registered to the base Context , and can be only used after attachBaseContext(android.content.Context) . Users can still call to getApplicationContext().registerComponentCallbacks(ComponentCallbacks) to add ComponentCallbacks to the base application.
|
Unit |
registerDeviceIdChangeListener(executor: Executor, listener: IntConsumer)
Adds a new device ID changed listener to the Context , which will be called when the device association is changed by the system.
The callback can be called when an app is moved to a different device and the Context is not explicitly associated with a specific device.
When an application receives a device id update callback, this Context is guaranteed to also have an updated display ID(if any) and Configuration .
|
Intent? |
registerReceiver(receiver: BroadcastReceiver?, filter: IntentFilter!)
Register a BroadcastReceiver to be run in the main activity thread. The receiver will be called with any broadcast Intent that matches filter, in the main application thread.
The system may broadcast Intents that are "sticky" -- these stay around after the broadcast has finished, to be sent to any later registrations. If your IntentFilter matches one of these sticky Intents, that Intent will be returned by this function and sent to your receiver as if it had just been broadcast.
There may be multiple sticky Intents that match filter, in which case each of these will be sent to receiver. In this case, only one of these can be returned directly by the function; which of these that is returned is arbitrarily decided by the system.
If you know the Intent your are registering for is sticky, you can supply null for your receiver. In this case, no receiver is registered -- the function simply returns the sticky Intent that matches filter. In the case of multiple matches, the same rules as described above apply.
See BroadcastReceiver for more information on Intent broadcasts.
As of android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE , the system can place context-registered broadcasts in a queue while the app is in the cached state. When the app leaves the cached state, such as returning to the foreground, the system delivers any queued broadcasts. Multiple instances of certain broadcasts might be merged into one broadcast.
As of android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH , receivers registered with this method will correctly respect the Intent#setPackage(String) specified for an Intent being broadcast. Prior to that, it would be ignored and delivered to all matching registered receivers. Be careful if using this for security.
For apps targeting android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE , either RECEIVER_EXPORTED or RECEIVER_NOT_EXPORTED must be specified if the receiver is not being registered for system broadcasts or a SecurityException will be thrown. See registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter,int) to register a receiver with flags.
Note: this method cannot be called from a BroadcastReceiver component; that is, from a BroadcastReceiver that is declared in an application's manifest. It is okay, however, to call this method from another BroadcastReceiver that has itself been registered at run time with #registerReceiver, since the lifetime of such a registered BroadcastReceiver is tied to the object that registered it.
|
Intent? |
registerReceiver(receiver: BroadcastReceiver?, filter: IntentFilter!, flags: Int)
Register to receive intent broadcasts, with the receiver optionally being exposed to Instant Apps. See registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter) for more information. By default Instant Apps cannot interact with receivers in other applications, this allows you to expose a receiver that Instant Apps can interact with.
See BroadcastReceiver for more information on Intent broadcasts.
As of android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE , the system can place context-registered broadcasts in a queue while the app is in the cached state. When the app leaves the cached state, such as returning to the foreground, the system delivers any queued broadcasts. Multiple instances of certain broadcasts might be merged into one broadcast.
As of android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH , receivers registered with this method will correctly respect the Intent#setPackage(String) specified for an Intent being broadcast. Prior to that, it would be ignored and delivered to all matching registered receivers. Be careful if using this for security.
|
Intent? |
registerReceiver(receiver: BroadcastReceiver?, filter: IntentFilter!, broadcastPermission: String?, scheduler: Handler?)
Register to receive intent broadcasts, to run in the context of scheduler. See registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter) for more information. This allows you to enforce permissions on who can broadcast intents to your receiver, or have the receiver run in a different thread than the main application thread.
See BroadcastReceiver for more information on Intent broadcasts.
As of android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE , the system can place context-registered broadcasts in a queue while the app is in the cached state. When the app leaves the cached state, such as returning to the foreground, the system delivers any queued broadcasts. Multiple instances of certain broadcasts might be merged into one broadcast.
As of android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH , receivers registered with this method will correctly respect the Intent#setPackage(String) specified for an Intent being broadcast. Prior to that, it would be ignored and delivered to all matching registered receivers. Be careful if using this for security.
For apps targeting android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE , either RECEIVER_EXPORTED or RECEIVER_NOT_EXPORTED must be specified if the receiver is not being registered for system broadcasts or a SecurityException will be thrown. See registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter,java.lang.String,android.os.Handler,int) to register a receiver with flags.
|
Intent? |
registerReceiver(receiver: BroadcastReceiver?, filter: IntentFilter!, broadcastPermission: String?, scheduler: Handler?, flags: Int)
Register to receive intent broadcasts, to run in the context of scheduler. See registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter,int) and registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter,java.lang.String,android.os.Handler) for more information.
See BroadcastReceiver for more information on Intent broadcasts.
As of android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE , the system can place context-registered broadcasts in a queue while the app is in the cached state. When the app leaves the cached state, such as returning to the foreground, the system delivers any queued broadcasts. Multiple instances of certain broadcasts might be merged into one broadcast.
As of android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH , receivers registered with this method will correctly respect the Intent#setPackage(String) specified for an Intent being broadcast. Prior to that, it would be ignored and delivered to all matching registered receivers. Be careful if using this for security.
|
Unit |
removeStickyBroadcast(intent: Intent!)
|
Unit |
removeStickyBroadcastAsUser(intent: Intent!, user: UserHandle!)
|
Unit |
revokeSelfPermissionsOnKill(permissions: MutableCollection<String!>)
Triggers the revocation of one or more permissions for the calling package. A package is only able to revoke runtime permissions. If a permission is not currently granted, it is ignored and will not get revoked (even if later granted by the user). Ultimately, you should never make assumptions about a permission status as users may grant or revoke them at any time.
Background permissions which have no corresponding foreground permission still granted once the revocation is effective will also be revoked.
The revocation happens asynchronously and kills all processes running in the calling UID. It will be triggered once it is safe to do so. In particular, it will not be triggered as long as the package remains in the foreground, or has any active manifest components (e.g. when another app is accessing a content provider in the package).
If you want to revoke the permissions right away, you could call System.exit() in Handler.postDelayed with a delay to allow completion of async IPC, But System.exit() could affect other apps that are accessing your app at the moment. For example, apps accessing a content provider in your app will all crash.
Note that the settings UI shows a permission group as granted as long as at least one permission in the group is granted. If you want the user to observe the revocation in the settings, you should revoke every permission in the target group. To learn the current list of permissions in a group, you may use PackageManager#getGroupOfPlatformPermission(String, Executor, Consumer) and PackageManager#getPlatformPermissionsForGroup(String, Executor, Consumer) . This list of permissions may evolve over time, so it is recommended to check whether it contains any permission you wish to retain before trying to revoke an entire group.
|
Unit |
revokeUriPermission(uri: Uri!, modeFlags: Int)
|
Unit |
revokeUriPermission(targetPackage: String!, uri: Uri!, modeFlags: Int)
|
Unit |
sendBroadcast(intent: Intent!)
|
Unit |
sendBroadcast(intent: Intent!, receiverPermission: String?)
Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run. No results are propagated from receivers and receivers can not abort the broadcast. If you want to allow receivers to propagate results or abort the broadcast, you must send an ordered broadcast using sendOrderedBroadcast(android.content.Intent,java.lang.String) .
See BroadcastReceiver for more information on Intent broadcasts.
|
Unit |
sendBroadcast(intent: Intent, receiverPermission: String?, options: Bundle?)
Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run. No results are propagated from receivers and receivers can not abort the broadcast. If you want to allow receivers to propagate results or abort the broadcast, you must send an ordered broadcast using sendOrderedBroadcast(android.content.Intent,java.lang.String) .
See BroadcastReceiver for more information on Intent broadcasts.
|
Unit |
sendBroadcastAsUser(intent: Intent!, user: UserHandle!)
|
Unit |
sendBroadcastAsUser(intent: Intent!, user: UserHandle!, receiverPermission: String?)
|
Unit |
sendOrderedBroadcast(intent: Intent!, receiverPermission: String?)
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. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run.
See BroadcastReceiver for more information on Intent broadcasts.
|
Unit |
sendOrderedBroadcast(intent: Intent, receiverPermission: String?, options: Bundle?)
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. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run.
See BroadcastReceiver for more information on Intent broadcasts.
|
Unit |
sendOrderedBroadcast(intent: Intent, receiverPermission: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)
Version of sendBroadcast(android.content.Intent) that allows you to receive data back from the broadcast. This is accomplished by supplying your own BroadcastReceiver when calling, which will be treated as a final receiver at the end of the broadcast -- its BroadcastReceiver#onReceive method will be called with the result values collected from the other receivers. The broadcast will be serialized in the same way as calling sendOrderedBroadcast(android.content.Intent,java.lang.String) .
Like sendBroadcast(android.content.Intent) , this method is asynchronous; it will return before resultReceiver.onReceive() is called.
See BroadcastReceiver for more information on Intent broadcasts.
|
Unit |
sendOrderedBroadcast(intent: Intent, receiverPermission: String?, options: Bundle?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)
Version of sendBroadcast(android.content.Intent) that allows you to receive data back from the broadcast. This is accomplished by supplying your own BroadcastReceiver when calling, which will be treated as a final receiver at the end of the broadcast -- its BroadcastReceiver#onReceive method will be called with the result values collected from the other receivers. The broadcast will be serialized in the same way as calling sendOrderedBroadcast(android.content.Intent,java.lang.String) .
Like sendBroadcast(android.content.Intent) , this method is asynchronous; it will return before resultReceiver.onReceive() is called.
See BroadcastReceiver for more information on Intent broadcasts.
|
Unit |
sendOrderedBroadcast(intent: Intent, receiverPermission: String?, receiverAppOp: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)
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.
See BroadcastReceiver for more information on Intent broadcasts.
|
Unit |
sendOrderedBroadcast(intent: Intent, initialCode: Int, receiverPermission: String?, receiverAppOp: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialData: String?, initialExtras: Bundle?, options: Bundle?)
|
Unit |
sendOrderedBroadcastAsUser(intent: Intent!, user: UserHandle!, receiverPermission: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)
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. This is not available to applications that are not pre-installed on the system image.
See BroadcastReceiver for more information on Intent broadcasts. Requires android.Manifest.permission.INTERACT_ACROSS_USERS
|
Unit |
sendStickyBroadcast(intent: Intent!)
|
Unit |
sendStickyBroadcast(intent: Intent, options: Bundle?)
Perform a sendBroadcast(android.content.Intent) that is "sticky," meaning the Intent you are sending stays around after the broadcast is complete, so that others can quickly retrieve that data through the return value of registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter) . In all other ways, this behaves the same as sendBroadcast(android.content.Intent) .
|
Unit |
sendStickyBroadcastAsUser(intent: Intent!, user: UserHandle!)
|
Unit |
sendStickyOrderedBroadcast(intent: Intent!, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)
Version of #sendStickyBroadcast that allows you to receive data back from the broadcast. This is accomplished by supplying your own BroadcastReceiver when calling, which will be treated as a final receiver at the end of the broadcast -- its BroadcastReceiver#onReceive method will be called with the result values collected from the other receivers. The broadcast will be serialized in the same way as calling sendOrderedBroadcast(android.content.Intent,java.lang.String) .
Like sendBroadcast(android.content.Intent) , this method is asynchronous; it will return before resultReceiver.onReceive() is called. Note that the sticky data stored is only the data you initially supply to the broadcast, not the result of any changes made by the receivers.
See BroadcastReceiver for more information on Intent broadcasts. Requires android.Manifest.permission#BROADCAST_STICKY
|
Unit |
sendStickyOrderedBroadcastAsUser(intent: Intent!, user: UserHandle!, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)
Version of sendStickyOrderedBroadcast(android.content.Intent,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. This is not available to applications that are not pre-installed on the system image.
See BroadcastReceiver for more information on Intent broadcasts. Requires android.Manifest.permission.INTERACT_ACROSS_USERS and android.Manifest.permission#BROADCAST_STICKY
|
Unit |
setTheme(resid: Int)
|
Unit |
setWallpaper(bitmap: Bitmap!)
|
Unit |
setWallpaper(data: InputStream!)
|
Unit |
startActivities(intents: Array<Intent!>!)
|
Unit |
startActivities(intents: Array<Intent!>!, options: Bundle?)
Launch multiple new activities. This is generally the same as calling startActivity(android.content.Intent) for the first Intent in the array, that activity during its creation calling startActivity(android.content.Intent) for the second entry, etc. Note that unlike that approach, generally none of the activities except the last in the array will be created at this point, but rather will be created when the user first visits them (due to pressing back from the activity on top).
This method throws ActivityNotFoundException if there was no Activity found for any given Intent. In this case the state of the activity stack is undefined (some Intents in the list may be on it, some not), so you probably want to avoid such situations.
|
Unit |
startActivity(intent: Intent!)
|
Unit |
startActivity(intent: Intent!, options: Bundle?)
Launch a new activity. You will not receive any information about when the activity exits.
Note that if this method is being called from outside of an android.app.Activity Context, then the Intent must include the Intent#FLAG_ACTIVITY_NEW_TASK launch flag. This is because, without being started from an existing Activity, there is no existing task in which to place the new activity and thus it needs to be placed in its own separate task.
This method throws ActivityNotFoundException if there was no Activity found to run the given Intent.
|
ComponentName? |
startForegroundService(service: Intent!)
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. The service is given an amount of time comparable to the ANR interval to do this, otherwise the system will automatically crash the process, in which case an internal exception ForegroundServiceDidNotStartInTimeException is logged on logcat on devices running SDK Version android.os.Build.VERSION_CODES#S or later. On older Android versions, an internal exception RemoteServiceException is logged instead, with a corresponding message.
Unlike the ordinary startService(android.content.Intent) , this method can be used at any time, regardless of whether the app hosting the service is in a foreground state.
Note: Beginning with SDK Version android.os.Build.VERSION_CODES#S , apps targeting SDK Version android.os.Build.VERSION_CODES#S or higher are not allowed to start foreground services from the background. See Behavior changes: Apps targeting Android 12 for more details.
|
Boolean |
startInstrumentation(className: ComponentName, profileFile: String?, arguments: Bundle?)
Start executing an android.app.Instrumentation class. The given Instrumentation component will be run by killing its target application (if currently running), starting the target process, instantiating the instrumentation component, and then letting it drive the application.
This function is not synchronous -- it returns as soon as the instrumentation has started and while it is running.
Instrumentation is normally only allowed to run against a package that is either unsigned or signed with a signature that the the instrumentation package is also signed with (ensuring the target trusts the instrumentation).
|
Unit |
startIntentSender(intent: IntentSender!, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int)
Same as startIntentSender(android.content.IntentSender,android.content.Intent,int,int,int,android.os.Bundle) with no options specified.
|
Unit |
startIntentSender(intent: IntentSender!, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: Bundle?)
Like startActivity(android.content.Intent,android.os.Bundle) , but taking a IntentSender to start. If the IntentSender is for an activity, that activity will be started as if you had called the regular startActivity(android.content.Intent) here; otherwise, its associated action will be executed (such as sending a broadcast) as if you had called android.content.IntentSender#sendIntent on it.
|
ComponentName? |
startService(service: Intent!)
Request that a given application service be started. The Intent should either contain the complete class name of a specific service implementation to start, or a specific package name to target. If the Intent is less specified, it logs a warning about this. In this case any of the multiple matching services may be used. If this service is not already running, it will be instantiated and started (creating a process for it if needed); if it is running then it remains running.
Every call to this method will result in a corresponding call to the target service's android.app.Service#onStartCommand method, with the intent given here. This provides a convenient way to submit jobs to a service without having to bind and call on to its interface.
Using startService() overrides the default service lifetime that is managed by #bindService: it requires the service to remain running until stopService is called, regardless of whether any clients are connected to it. Note that calls to startService() do not nest: no matter how many times you call startService(), a single call to stopService will stop it.
The system attempts to keep running services around as much as possible. The only time they should be stopped is if the current foreground application is using so many resources that the service needs to be killed. If any errors happen in the service's process, it will automatically be restarted.
This function will throw SecurityException if you do not have permission to start the given service.
Note: Each call to startService() results in significant work done by the system to manage service lifecycle surrounding the processing of the intent, which can take multiple milliseconds of CPU time. Due to this cost, startService() should not be used for frequent intent delivery to a service, and only for scheduling significant work. Use #bindService for high frequency calls.
Beginning with SDK Version android.os.Build.VERSION_CODES#O , apps targeting SDK Version android.os.Build.VERSION_CODES#O or higher are not allowed to start background services from the background. See Background Execution Limits for more details.
Note: Beginning with SDK Version android.os.Build.VERSION_CODES#S , apps targeting SDK Version android.os.Build.VERSION_CODES#S or higher are not allowed to start foreground services from the background. See Behavior changes: Apps targeting Android 12 for more details.
|
Boolean |
stopService(name: Intent!)
|
Unit |
unbindService(conn: ServiceConnection)
|
Unit |
unregisterComponentCallbacks(callback: ComponentCallbacks!)
Remove a ComponentCallbacks object that was previously registered with registerComponentCallbacks(android.content.ComponentCallbacks) .
After Build.VERSION_CODES#TIRAMISU , the ComponentCallbacks will be unregistered to the base Context , and can be only used after attachBaseContext(android.content.Context)
|
Unit |
unregisterDeviceIdChangeListener(listener: IntConsumer)
Removes a device ID changed listener from the Context. It's a no-op if the listener is not already registered.
|
Unit |
unregisterReceiver(receiver: BroadcastReceiver!)
|
Unit |
updateServiceGroup(conn: ServiceConnection, group: Int, importance: Int)
|
|
From class Context
Boolean |
bindIsolatedService(service: Intent, flags: Context.BindServiceFlags, instanceName: String, executor: Executor, conn: ServiceConnection)
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.
|
Int |
getColor(id: Int)
Returns a color associated with a particular resource ID and styled for the current theme.
|
ColorStateList |
getColorStateList(id: Int)
Returns a color state list associated with a particular resource ID and styled for the current theme.
|
Drawable? |
getDrawable(id: Int)
Returns a drawable object associated with a particular resource ID and styled for the current theme.
|
String |
getString(resId: Int)
Returns a localized string from the application's package's default string table.
|
String |
getString(resId: Int, vararg formatArgs: Any!)
Returns a localized formatted string from the application's package's default string table, substituting the format arguments as defined in java.util.Formatter and java.lang.String#format.
|
T |
getSystemService(serviceClass: Class<T>)
Return the handle to a system-level service by class.
Currently available classes are: android.view.WindowManager , android.view.LayoutInflater , android.app.ActivityManager , android.os.PowerManager , android.app.AlarmManager , android.app.NotificationManager , android.app.KeyguardManager , android.location.LocationManager , android.app.SearchManager , android.os.Vibrator , android.net.ConnectivityManager , android.net.wifi.WifiManager , android.media.AudioManager , android.media.MediaRouter , android.telephony.TelephonyManager , android.telephony.SubscriptionManager , android.view.inputmethod.InputMethodManager , android.app.UiModeManager , android.app.DownloadManager , android.os.BatteryManager , android.app.job.JobScheduler , android.app.usage.NetworkStatsManager , android.content.pm.verify.domain.DomainVerificationManager , android.view.displayhash.DisplayHashManager .
Note: System services obtained via this API may be closely associated with the Context in which they are obtained from. In general, do not share the service objects between various different contexts (Activities, Applications, Services, Providers, etc.)
Note: Instant apps, for which PackageManager#isInstantApp() returns true, don't have access to the following system services: DEVICE_POLICY_SERVICE , FINGERPRINT_SERVICE , KEYGUARD_SERVICE , SHORTCUT_SERVICE , USB_SERVICE , WALLPAPER_SERVICE , WIFI_P2P_SERVICE , WIFI_SERVICE , WIFI_AWARE_SERVICE . For these services this method will return null . Generally, if you are running as an instant app you should always check whether the result of this method is null .
|
CharSequence |
getText(resId: Int)
Return a localized, styled CharSequence from the application's package's default string table.
|
TypedArray |
obtainStyledAttributes(attrs: IntArray)
Retrieve styled attribute information in this Context's theme. See android.content.res.Resources.Theme#obtainStyledAttributes(int[]) for more information.
|
TypedArray |
obtainStyledAttributes(resid: Int, attrs: IntArray)
Retrieve styled attribute information in this Context's theme. See android.content.res.Resources.Theme#obtainStyledAttributes(int, int[]) for more information.
|
TypedArray |
obtainStyledAttributes(set: AttributeSet?, attrs: IntArray)
Retrieve styled attribute information in this Context's theme. See android.content.res.Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int) for more information.
|
TypedArray |
obtainStyledAttributes(set: AttributeSet?, attrs: IntArray, defStyleAttr: Int, defStyleRes: Int)
Retrieve styled attribute information in this Context's theme. See android.content.res.Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int) for more information.
|
Unit |
revokeSelfPermissionOnKill(permName: String)
Triggers the asynchronous revocation of a runtime permission. If the permission is not currently granted, nothing happens (even if later granted by the user).
|
Unit |
sendBroadcastWithMultiplePermissions(intent: Intent, receiverPermissions: Array<String!>)
Broadcast the given intent to all interested BroadcastReceivers, allowing an array of required permissions to be enforced. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run. No results are propagated from receivers and receivers can not abort the broadcast. If you want to allow receivers to propagate results or abort the broadcast, you must send an ordered broadcast using sendOrderedBroadcast(android.content.Intent,java.lang.String) .
See BroadcastReceiver for more information on Intent broadcasts.
|
|
From class Service
Unit |
dump(fd: FileDescriptor!, writer: PrintWriter!, args: Array<String!>!)
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.
|
Application! |
getApplication()
Return the application that owns this service.
|
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.
If there is no foregroundServiceType specified in manifest, ServiceInfo#FOREGROUND_SERVICE_TYPE_NONE is returned.
If the service is not a foreground service, ServiceInfo#FOREGROUND_SERVICE_TYPE_NONE is returned.
|
Unit |
onConfigurationChanged(newConfig: Configuration)
|
Unit |
onCreate()
Called by the system when the service is first created. Do not call this method directly.
|
Unit |
onLowMemory()
|
Unit |
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 . This will only be called if the implementation of onUnbind was overridden to return true.
|
Unit |
onStart(intent: Intent!, startId: Int)
|
Int |
onStartCommand(intent: Intent!, flags: Int, startId: Int)
Called by the system every time a client explicitly starts the service by calling android.content.Context#startService , providing the arguments it supplied and a unique integer token representing the start request. Do not call this method directly.
For backwards compatibility, the default implementation calls onStart and returns either START_STICKY or START_STICKY_COMPATIBILITY .
Note that the system calls this on your service's main thread. A service's main thread is the same thread where UI operations take place for Activities running in the same process. You should always avoid stalling the main thread's event loop. When doing long-running operations, network calls, or heavy disk I/O, you should kick off a new thread, or use android.os.AsyncTask .
|
Unit |
onTaskRemoved(rootIntent: Intent!)
This is called if the service is currently running and the user has removed a task that comes from the service's application. If you have set ServiceInfo.FLAG_STOP_WITH_TASK then you will not receive this callback; instead, the service will simply be stopped.
|
Unit |
onTimeout(startId: Int)
Callback called on timeout for ServiceInfo#FOREGROUND_SERVICE_TYPE_SHORT_SERVICE . See ServiceInfo#FOREGROUND_SERVICE_TYPE_SHORT_SERVICE for more details.
If the foreground service of type ServiceInfo#FOREGROUND_SERVICE_TYPE_SHORT_SERVICE doesn't finish even after it's timed out, the app will be declared an ANR after a short grace period of several seconds.
Starting from Android version android.os.Build.VERSION_CODES#VANILLA_ICE_CREAM , onTimeout(int,int) will also be called when a foreground service of type ServiceInfo#FOREGROUND_SERVICE_TYPE_SHORT_SERVICE times out. Developers do not need to implement both of the callbacks on android.os.Build.VERSION_CODES#VANILLA_ICE_CREAM and onwards.
Note, even though ServiceInfo#FOREGROUND_SERVICE_TYPE_SHORT_SERVICE was added on Android version android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE , it can be also used on on prior android versions (just like other new foreground service types can be used). However, because android.app.Service#onTimeout(int) did not exist on prior versions, it will never called on such versions. Because of this, developers must make sure to stop the foreground service even if android.app.Service#onTimeout(int) is not called on such versions.
|
Unit |
onTimeout(startId: Int, fgsType: Int)
Callback called when a particular foreground service type has timed out.
This callback is meant to give the app a small grace period of a few seconds to finish the foreground service of the associated type - if it fails to do so, the app will crash.
The foreground service of the associated type can be stopped within the time limit by android.app.Service#stopSelf() , android.content.Context#stopService(android.content.Intent) or their overloads. android.app.Service#stopForeground(int) can be used as well, which demotes the service to a "background" service, which will soon be stopped by the system.
The specific time limit for each type (if one exists) is mentioned in the documentation for that foreground service type. See dataSync for example.
Note: time limits are restricted to a rolling 24-hour window - for example, if a foreground service type has a time limit of 6 hours, that time counter begins as soon as the foreground service starts. This time limit will only be reset once every 24 hours or if the app comes into the foreground state.
|
Unit |
onTrimMemory(level: Int)
|
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.
|
Unit |
startForeground(id: Int, 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. By default started services are background, meaning that their process won't be given foreground CPU scheduling (unless something else in that process is foreground) and, if the system needs to kill them to reclaim more memory (such as to display a large page in a web browser), they can be killed without too much harm. You use #startForeground if killing your service would be disruptive to the user, such as if your service is performing background music playback, so the user would notice if their music stopped playing.
Note that calling this method does not put the service in the started state itself, even though the name sounds like it. You must always call startService(android.content.Intent) first to tell the system it should keep the service running, and then use this method to tell it to keep it running harder.
Apps targeting API android.os.Build.VERSION_CODES#P or later must request the permission android.Manifest.permission#FOREGROUND_SERVICE in order to use this API.
Apps built with SDK version android.os.Build.VERSION_CODES#Q or later can specify the foreground service types using attribute android.R.attr#foregroundServiceType in service element of manifest file. The value of attribute android.R.attr#foregroundServiceType can be multiple flags ORed together.
Note: Beginning with SDK Version android.os.Build.VERSION_CODES#S , apps targeting SDK Version android.os.Build.VERSION_CODES#S or higher are not allowed to start foreground services from the background. See Behavior changes: Apps targeting Android 12 for more details.
Note: Beginning with SDK Version android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE , apps targeting SDK Version android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE or higher are not allowed to start foreground services without specifying a valid foreground service type in the manifest attribute android.R.attr#foregroundServiceType . See Behavior changes: Apps targeting Android 14 for more details.
|
Unit |
startForeground(id: Int, notification: Notification, foregroundServiceType: Int)
An overloaded version of startForeground(int,android.app.Notification) with additional foregroundServiceType parameter.
Apps built with SDK version android.os.Build.VERSION_CODES#Q or later can specify the foreground service types using attribute android.R.attr#foregroundServiceType in service element of manifest file. The value of attribute android.R.attr#foregroundServiceType can be multiple flags ORed together.
The foregroundServiceType parameter must be a subset flags of what is specified in manifest attribute android.R.attr#foregroundServiceType , if not, an IllegalArgumentException is thrown. Specify foregroundServiceType parameter as android.content.pm.ServiceInfo#FOREGROUND_SERVICE_TYPE_MANIFEST to use all flags that is specified in manifest attribute foregroundServiceType.
Note: Beginning with SDK Version android.os.Build.VERSION_CODES#S , apps targeting SDK Version android.os.Build.VERSION_CODES#S or higher are not allowed to start foreground services from the background. See Behavior changes: Apps targeting Android 12 for more details.
Note: Beginning with SDK Version android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE , apps targeting SDK Version android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE or higher are not allowed to start foreground services without specifying a valid foreground service type in the manifest attribute android.R.attr#foregroundServiceType , and the parameter foregroundServiceType here must not be the ServiceInfo#FOREGROUND_SERVICE_TYPE_NONE . See Behavior changes: Apps targeting Android 14 for more details.
|
Unit |
stopForeground(removeNotification: Boolean)
Legacy version of stopForeground(int) .
|
Unit |
stopForeground(notificationBehavior: Int)
Remove this service from foreground state, allowing it to be killed if more memory is needed. This does not stop the service from running (for that you use stopSelf() or related methods), just takes it out of the foreground state.
If STOP_FOREGROUND_REMOVE is supplied, the service's associated notification will be cancelled immediately.
If STOP_FOREGROUND_DETACH is supplied, the service's association with the notification will be severed. If the notification had not yet been shown, due to foreground-service notification deferral policy, it is immediately posted when stopForeground(STOP_FOREGROUND_DETACH) is called. In all cases, the notification remains shown even after this service is stopped fully and destroyed.
If zero is passed as the argument, the result will be the legacy behavior as defined prior to Android L: the notification will remain posted until the service is fully stopped, at which time it will automatically be cancelled.
|
Unit |
stopSelf()
Stop the service, if it was previously started. This is the same as calling android.content.Context#stopService for this particular service.
|
Unit |
stopSelf(startId: Int)
Old version of stopSelfResult that doesn't return a result.
|
Boolean |
stopSelfResult(startId: Int)
Stop the service if the most recent time it was started was startId. This is the same as calling android.content.Context#stopService for this particular service but allows you to safely avoid stopping if there is a start request from a client that you haven't yet seen in onStart .
Be careful about ordering of your calls to this function.. If you call this function with the most-recently received ID before you have called it for previously received IDs, the service will be immediately stopped anyway. If you may end up processing IDs out of order (such as by dispatching them on separate threads), then you are responsible for stopping them in the same order you received them.
|
|
From class ComponentCallbacks
Unit |
onConfigurationChanged(newConfig: Configuration)
Called by the system when the device configuration changes while your component is running. Note that, unlike activities, other components are never restarted when a configuration changes: they must always deal with the results of the change, such as by re-retrieving resources.
At the time that this function has been called, your Resources object will have been updated to return resource values matching the new configuration.
For more information, read Handling Runtime Changes.
|
Unit |
onLowMemory()
This is called when the overall system is running low on memory, and actively running processes should trim their memory usage. While the exact point at which this will be called is not defined, generally it will happen when all background process have been killed. That is, before reaching the point of killing processes hosting service and foreground UI that we would like to avoid killing.
|
|
Constants
ACTION_SETTINGS_HOME
static val ACTION_SETTINGS_HOME: String
An optional activity intent action that shows additional settings for what notifications should be processed by this notification listener service. If defined, the OS may link to this activity from the system notification listener service filter settings page.
Value: "android.service.notification.action.SETTINGS_HOME"
FLAG_FILTER_TYPE_ALERTING
static val FLAG_FILTER_TYPE_ALERTING: Int
A flag value indicating that this notification listener can see altering type notifications.
Value: 2
FLAG_FILTER_TYPE_CONVERSATIONS
static val FLAG_FILTER_TYPE_CONVERSATIONS: Int
A flag value indicating that this notification listener can see conversation type notifications.
Value: 1
FLAG_FILTER_TYPE_ONGOING
static val FLAG_FILTER_TYPE_ONGOING: Int
A flag value indicating that this notification listener can see important ( > NotificationManager#IMPORTANCE_MIN
) ongoing type notifications.
Value: 8
FLAG_FILTER_TYPE_SILENT
static val FLAG_FILTER_TYPE_SILENT: Int
A flag value indicating that this notification listener can see silent type notifications.
Value: 4
HINT_HOST_DISABLE_CALL_EFFECTS
static val HINT_HOST_DISABLE_CALL_EFFECTS: Int
Listener hints
constant - the primary device UI should disable phone call sounds, but not notification sound. This does not change the interruption filter, only the effects. *
Value: 4
HINT_HOST_DISABLE_EFFECTS
static val HINT_HOST_DISABLE_EFFECTS: Int
Listener hints
constant - the primary device UI should disable notification sound, vibrating and other visual or aural effects. This does not change the interruption filter, only the effects. *
Value: 1
HINT_HOST_DISABLE_NOTIFICATION_EFFECTS
static val HINT_HOST_DISABLE_NOTIFICATION_EFFECTS: Int
Listener hints
constant - the primary device UI should disable notification sound, but not phone calls. This does not change the interruption filter, only the effects. *
Value: 2
INTERRUPTION_FILTER_ALARMS
static val INTERRUPTION_FILTER_ALARMS: Int
Interruption filter
constant - Alarms only interruption filter.
Value: 4
INTERRUPTION_FILTER_ALL
static val INTERRUPTION_FILTER_ALL: Int
Interruption filter
constant - Normal interruption filter.
Value: 1
INTERRUPTION_FILTER_NONE
static val INTERRUPTION_FILTER_NONE: Int
Interruption filter
constant - No interruptions filter.
Value: 3
INTERRUPTION_FILTER_PRIORITY
static val INTERRUPTION_FILTER_PRIORITY: Int
Interruption filter
constant - Priority interruption filter.
Value: 2
INTERRUPTION_FILTER_UNKNOWN
static val INTERRUPTION_FILTER_UNKNOWN: Int
Interruption filter
constant - returned when the value is unavailable for any reason. For example, before the notification listener is connected. {@see #onListenerConnected()}
Value: 0
static val META_DATA_DEFAULT_AUTOBIND: String
The name of the meta-data
tag containing a boolean value that is used to decide if this listener should be automatically bound by default. If the value is 'false', the listener can be bound on demand using requestRebind
An absent value means that the default is 'true'
Value: "android.service.notification.default_autobind_listenerservice"
static val META_DATA_DEFAULT_FILTER_TYPES: String
The name of the meta-data
tag containing a pipe separated list of default integer notification types or "ongoing", "conversations", "alerting", or "silent" that should be provided to this listener. See FLAG_FILTER_TYPE_ONGOING
, FLAG_FILTER_TYPE_CONVERSATIONS
, ),
Value: "android.service.notification.default_filter_types"
static val META_DATA_DISABLED_FILTER_TYPES: String
The name of the meta-data
tag containing a comma separated list of default integer notification types that this listener never wants to receive. See FLAG_FILTER_TYPE_ONGOING
, FLAG_FILTER_TYPE_CONVERSATIONS
, ),
Value: "android.service.notification.disabled_filter_types"
REASON_APP_CANCEL
static val REASON_APP_CANCEL: Int
Notification was canceled by the app canceling this specific notification.
Value: 8
REASON_APP_CANCEL_ALL
static val REASON_APP_CANCEL_ALL: Int
Notification was canceled by the app cancelling all its notifications.
Value: 9
REASON_ASSISTANT_CANCEL
static val REASON_ASSISTANT_CANCEL: Int
Notification was canceled due to an assistant adjustment update.
Value: 22
REASON_CANCEL
static val REASON_CANCEL: Int
Notification was canceled by the status bar reporting a user dismissal.
Value: 2
REASON_CANCEL_ALL
static val REASON_CANCEL_ALL: Int
Notification was canceled by the status bar reporting a user dismiss all.
Value: 3
REASON_CHANNEL_BANNED
static val REASON_CHANNEL_BANNED: Int
Notification was canceled by the user banning the channel.
Value: 17
REASON_CHANNEL_REMOVED
static val REASON_CHANNEL_REMOVED: Int
Notification was canceled due to the backing channel being deleted
Value: 20
REASON_CLEAR_DATA
static val REASON_CLEAR_DATA: Int
Notification was canceled due to the app's storage being cleared
Value: 21
REASON_CLICK
static val REASON_CLICK: Int
Notification was canceled by the status bar reporting a notification click.
Value: 1
REASON_ERROR
static val REASON_ERROR: Int
Notification was canceled by the status bar reporting an inflation error.
Value: 4
REASON_GROUP_OPTIMIZATION
static val REASON_GROUP_OPTIMIZATION: Int
Notification was canceled because it was an invisible member of a group.
Value: 13
REASON_GROUP_SUMMARY_CANCELED
static val REASON_GROUP_SUMMARY_CANCELED: Int
Notification was canceled because it was a member of a canceled group.
Value: 12
REASON_LISTENER_CANCEL
static val REASON_LISTENER_CANCEL: Int
Notification was canceled by a listener reporting a user dismissal.
Value: 10
REASON_LISTENER_CANCEL_ALL
static val REASON_LISTENER_CANCEL_ALL: Int
Notification was canceled by a listener reporting a user dismiss all.
Value: 11
REASON_LOCKDOWN
static val REASON_LOCKDOWN: Int
Notification was canceled when entering lockdown mode, which turns off Smart Lock, fingerprint unlocking, and notifications on the lock screen. All the listeners shall ensure the canceled notifications are indeed removed on their end to prevent data leaking. When the user exits the lockdown mode, the removed notifications (due to lockdown) will be restored via NotificationListeners#notifyPostedLocked()
Value: 23
REASON_PACKAGE_BANNED
static val REASON_PACKAGE_BANNED: Int
Notification was canceled by the user banning the package.
Value: 7
REASON_PACKAGE_CHANGED
static val REASON_PACKAGE_CHANGED: Int
Notification was canceled by the package manager modifying the package.
Value: 5
REASON_PACKAGE_SUSPENDED
static val REASON_PACKAGE_SUSPENDED: Int
Notification was canceled by the device administrator suspending the package.
Value: 14
REASON_PROFILE_TURNED_OFF
static val REASON_PROFILE_TURNED_OFF: Int
Notification was canceled by the owning managed profile being turned off.
Value: 15
REASON_SNOOZED
static val REASON_SNOOZED: Int
Notification was snoozed.
Value: 18
REASON_TIMEOUT
static val REASON_TIMEOUT: Int
Notification was canceled due to timeout
Value: 19
REASON_UNAUTOBUNDLED
static val REASON_UNAUTOBUNDLED: Int
Autobundled summary notification was canceled because its group was unbundled
Value: 16
REASON_USER_STOPPED
static val REASON_USER_STOPPED: Int
Notification was canceled by the owning user context being stopped.
Value: 6
SERVICE_INTERFACE
static val SERVICE_INTERFACE: String
The Intent
that must be declared as handled by the service.
Value: "android.service.notification.NotificationListenerService"
SUPPRESSED_EFFECT_SCREEN_OFF
static val SUPPRESSED_EFFECT_SCREEN_OFF: Int
Deprecated: Use the more specific visual effects in NotificationManager.Policy
.
Whether notification suppressed by DND should not interruption visually when the screen is off.
Value: 1
SUPPRESSED_EFFECT_SCREEN_ON
static val SUPPRESSED_EFFECT_SCREEN_ON: Int
Deprecated: Use the more specific visual effects in NotificationManager.Policy
.
Whether notification suppressed by DND should not interruption visually when the screen is on.
Value: 2
Public constructors
NotificationListenerService
NotificationListenerService()
Public methods
cancelAllNotifications
fun cancelAllNotifications(): Unit
Inform the notification manager about dismissal of all notifications.
Use this if your listener has a user interface that allows the user to dismiss all notifications, similar to the behavior of Android's status bar and notification panel. It should be called after the user invokes the "dismiss all" function of your UI; upon being informed, the notification manager will actually remove all active notifications and you will get multiple onNotificationRemoved(android.service.notification.StatusBarNotification)
callbacks.
The service should wait for the onListenerConnected()
event before performing this operation. {@see #cancelNotification(String, String, int)}
cancelNotification
fun cancelNotification(key: String!): Unit
Inform the notification manager about dismissal of a single notification.
Use this if your listener has a user interface that allows the user to dismiss individual notifications, similar to the behavior of Android's status bar and notification panel. It should be called after the user dismisses a single notification using your UI; upon being informed, the notification manager will actually remove the notification and you will get an onNotificationRemoved(android.service.notification.StatusBarNotification)
callback.
Note: If your listener allows the user to fire a notification's android.app.Notification#contentIntent
by tapping/clicking/etc., you should call this method at that time if the Notification in question has the android.app.Notification#FLAG_AUTO_CANCEL
flag set.
The service should wait for the onListenerConnected()
event before performing this operation.
cancelNotifications
fun cancelNotifications(keys: Array<String!>!): Unit
Inform the notification manager about dismissal of specific notifications.
Use this if your listener has a user interface that allows the user to dismiss multiple notifications at once.
The service should wait for the onListenerConnected()
event before performing this operation.
Parameters |
keys |
Array<String!>!: Notifications to dismiss, or null to dismiss all. {@see #cancelNotification(String, String, int)} |
getActiveNotifications
open fun getActiveNotifications(): Array<StatusBarNotification!>!
Request the list of outstanding notifications (that is, those that are visible to the current user). Useful when you don't know what's already been posted.
The service should wait for the onListenerConnected()
event before performing this operation.
getActiveNotifications
open fun getActiveNotifications(keys: Array<String!>!): Array<StatusBarNotification!>!
Request one or more notifications by key. Useful if you have been keeping track of notifications but didn't want to retain the bits, and now need to go back and extract more data out of those notifications.
The service should wait for the onListenerConnected()
event before performing this operation.
Parameters |
keys |
Array<String!>!: the keys of the notifications to request |
Return |
Array<StatusBarNotification!>! |
An array of notifications corresponding to the requested keys, in the same order as the key list. |
getCurrentInterruptionFilter
fun getCurrentInterruptionFilter(): Int
Gets the current notification interruption filter active on the host.
The interruption filter defines which notifications are allowed to interrupt the user (e.g. via sound & vibration) and is applied globally. Listeners can find out whether a specific notification matched the interruption filter via Ranking#matchesInterruptionFilter()
.
The current filter may differ from the previously requested filter if the notification host does not support or refuses to apply the requested filter, or if another component changed the filter in the meantime.
Listen for updates using onInterruptionFilterChanged(int)
.
The service should wait for the onListenerConnected()
event before performing this operation.
Return |
Int |
One of the INTERRUPTION_FILTER_ constants, or INTERRUPTION_FILTER_UNKNOWN when unavailable. |
getCurrentListenerHints
fun getCurrentListenerHints(): Int
Gets the set of hints representing current state.
The current state may differ from the requested state if the hint represents state shared across all listeners or a feature the notification host does not support or refuses to grant.
The service should wait for the onListenerConnected()
event before performing this operation.
Return |
Int |
Zero or more of the HINT_ constants. |
getNotificationChannelGroups
fun getNotificationChannelGroups(
pkg: String,
user: UserHandle
): MutableList<NotificationChannelGroup!>!
Returns all notification channel groups belonging to the given package for a given user.
This method will throw a security exception if you don't have access to notifications for the given user.
The caller must have device
or be the notification assistant in order to use this method.
Parameters |
pkg |
String: The package to retrieve channel groups for. This value cannot be null . |
user |
UserHandle: This value cannot be null . |
getNotificationChannels
fun getNotificationChannels(
pkg: String,
user: UserHandle
): MutableList<NotificationChannel!>!
Returns all notification channels belonging to the given package for a given user.
This method will throw a security exception if you don't have access to notifications for the given user.
The caller must have device
or be the notification assistant in order to use this method.
Parameters |
pkg |
String: The package to retrieve channels for. This value cannot be null . |
user |
UserHandle: This value cannot be null . |
migrateNotificationFilter
fun migrateNotificationFilter(
defaultTypes: Int,
disallowedPkgs: MutableList<String!>?
): Unit
Lets an app migrate notification filters from its app into the OS.
This call will be ignored if the app has already migrated these settings or the user has set filters in the UI. This method is intended for user specific settings; if an app has already specified defaults types in its manifest with META_DATA_DEFAULT_FILTER_TYPES
, the defaultTypes option will be ignored.
onBind
open fun onBind(intent: Intent!): IBinder?
This is not the lifecycle event you are looking for.
The service should wait for the onListenerConnected()
event before performing any operations.
Parameters |
intent |
Intent!: The Intent that was used to bind to this service, as given to android.content.Context#bindService. Note that any extras that were included with the Intent at that point will not be seen here. |
Return |
IBinder? |
Return an IBinder through which clients can call on to the service. |
onDestroy
open fun onDestroy(): Unit
onInterruptionFilterChanged
open fun onInterruptionFilterChanged(interruptionFilter: Int): Unit
Implement this method to be notified when the interruption filter
changed.
This method must be called on the thread that originally created this UI element. This is typically the main thread of your app.
onListenerConnected
open fun onListenerConnected(): Unit
Implement this method to learn about when the listener is enabled and connected to the notification manager. You are safe to call getActiveNotifications()
at this time.
This method must be called on the thread that originally created this UI element. This is typically the main thread of your app.
onListenerDisconnected
open fun onListenerDisconnected(): Unit
Implement this method to learn about when the listener is disconnected from the notification manager.You will not receive any events after this call, and may only call requestRebind(android.content.ComponentName)
at this time.
This method must be called on the thread that originally created this UI element. This is typically the main thread of your app.
onListenerHintsChanged
open fun onListenerHintsChanged(hints: Int): Unit
Implement this method to be notified when the Listener hints
change.
This method must be called on the thread that originally created this UI element. This is typically the main thread of your app.
onNotificationChannelGroupModified
open fun onNotificationChannelGroupModified(
pkg: String!,
user: UserHandle!,
group: NotificationChannelGroup!,
modificationType: Int
): Unit
Implement this method to learn about notification channel group modifications.
The caller must have device
in order to receive this callback.
This method must be called on the thread that originally created this UI element. This is typically the main thread of your app.
onNotificationChannelModified
open fun onNotificationChannelModified(
pkg: String!,
user: UserHandle!,
channel: NotificationChannel!,
modificationType: Int
): Unit
Implement this method to learn about notification channel modifications.
The caller must have device
in order to receive this callback.
This method must be called on the thread that originally created this UI element. This is typically the main thread of your app.
onNotificationPosted
open fun onNotificationPosted(sbn: StatusBarNotification!): Unit
Implement this method to learn about new notifications as they are posted by apps.
This method must be called on the thread that originally created this UI element. This is typically the main thread of your app.
onNotificationRankingUpdate
open fun onNotificationRankingUpdate(rankingMap: NotificationListenerService.RankingMap!): Unit
Implement this method to be notified when the notification ranking changes.
This method must be called on the thread that originally created this UI element. This is typically the main thread of your app.
onNotificationRemoved
open fun onNotificationRemoved(
sbn: StatusBarNotification!,
rankingMap: NotificationListenerService.RankingMap!,
reason: Int
): Unit
Implement this method to learn when notifications are removed and why.
NOTE: The StatusBarNotification
object you receive will be "light"; that is, the result from StatusBarNotification#getNotification
may be missing some heavyweight fields such as android.app.Notification#contentView
and android.app.Notification#largeIcon
. However, all other fields on StatusBarNotification
, sufficient to match this call with a prior call to onNotificationPosted(android.service.notification.StatusBarNotification)
, will be intact.
This method must be called on the thread that originally created this UI element. This is typically the main thread of your app.
Parameters |
sbn |
StatusBarNotification!: A data structure encapsulating at least the original information (tag and id) and source (package name) used to post the android.app.Notification that was just removed. |
rankingMap |
NotificationListenerService.RankingMap!: The current ranking map that can be used to retrieve ranking information for active notifications. |
reason |
Int: Value is android.service.notification.NotificationListenerService#REASON_CLICK , android.service.notification.NotificationListenerService#REASON_CANCEL , android.service.notification.NotificationListenerService#REASON_CANCEL_ALL , android.service.notification.NotificationListenerService#REASON_ERROR , android.service.notification.NotificationListenerService#REASON_PACKAGE_CHANGED , android.service.notification.NotificationListenerService#REASON_USER_STOPPED , android.service.notification.NotificationListenerService#REASON_PACKAGE_BANNED , android.service.notification.NotificationListenerService#REASON_APP_CANCEL , android.service.notification.NotificationListenerService#REASON_APP_CANCEL_ALL , android.service.notification.NotificationListenerService#REASON_LISTENER_CANCEL , android.service.notification.NotificationListenerService#REASON_LISTENER_CANCEL_ALL , android.service.notification.NotificationListenerService#REASON_GROUP_SUMMARY_CANCELED , android.service.notification.NotificationListenerService#REASON_GROUP_OPTIMIZATION , android.service.notification.NotificationListenerService#REASON_PACKAGE_SUSPENDED , android.service.notification.NotificationListenerService#REASON_PROFILE_TURNED_OFF , android.service.notification.NotificationListenerService#REASON_UNAUTOBUNDLED , android.service.notification.NotificationListenerService#REASON_CHANNEL_BANNED , android.service.notification.NotificationListenerService#REASON_SNOOZED , android.service.notification.NotificationListenerService#REASON_TIMEOUT , android.service.notification.NotificationListenerService#REASON_CHANNEL_REMOVED , android.service.notification.NotificationListenerService#REASON_CLEAR_DATA , android.service.notification.NotificationListenerService#REASON_ASSISTANT_CANCEL , or android.service.notification.NotificationListenerService#REASON_LOCKDOWN |
onSilentStatusBarIconsVisibilityChanged
open fun onSilentStatusBarIconsVisibilityChanged(hideSilentStatusIcons: Boolean): Unit
Implement this method to be notified when the behavior of silent notifications in the status bar changes. See NotificationManager#shouldHideSilentStatusBarIcons()
.
This method must be called on the thread that originally created this UI element. This is typically the main thread of your app.
Parameters |
hideSilentStatusIcons |
Boolean: whether or not status bar icons should be hidden for silent notifications |
requestInterruptionFilter
fun requestInterruptionFilter(interruptionFilter: Int): Unit
Sets the desired interruption filter
.
This is merely a request, the host may or may not choose to apply the requested interruption filter depending on other listener requests or other global state.
Listen for updates using onInterruptionFilterChanged(int)
.
Apps targeting Build.VERSION_CODES#VANILLA_ICE_CREAM
and above (with some exceptions, such as companion device managers) cannot modify the global interruption filter. Calling this method will instead activate or deactivate an android.app.AutomaticZenRule
associated to the app.
The service should wait for the onListenerConnected()
event before performing this operation.
Parameters |
interruptionFilter |
Int: One of the INTERRUPTION_FILTER_ constants. |
requestListenerHints
fun requestListenerHints(hints: Int): Unit
Sets the desired listener hints
.
This is merely a request, the host may or may not choose to take action depending on other listener requests or other global state.
Listen for updates using onListenerHintsChanged(int)
.
The service should wait for the onListenerConnected()
event before performing this operation.
Parameters |
hints |
Int: One or more of the HINT_ constants. |
requestRebind
open static fun requestRebind(componentName: ComponentName!): Unit
Request that the listener be rebound, after a previous call to #requestUnbind.
This method will fail for listeners that have not been granted the permission by the user.
requestUnbind
fun requestUnbind(): Unit
Request that the service be unbound.
Once this is called, you will no longer receive updates and no method calls are guaranteed to be successful, until you next receive the onListenerConnected()
event. The service will likely be killed by the system after this call.
The service should wait for the onListenerConnected()
event before performing this operation. I know it's tempting, but you must wait.
requestUnbind
open static fun requestUnbind(componentName: ComponentName): Unit
Request that the service be unbound.
This method will fail for components that are not part of the calling app.
Parameters |
componentName |
ComponentName: This value cannot be null . |
setNotificationsShown
fun setNotificationsShown(keys: Array<String!>!): Unit
Inform the notification manager that these notifications have been viewed by the user. This should only be called when there is sufficient confidence that the user is looking at the notifications, such as when the notifications appear on the screen due to an explicit user interaction.
The service should wait for the onListenerConnected()
event before performing this operation.
Parameters |
keys |
Array<String!>!: Notifications to mark as seen. |
updateNotificationChannel
fun updateNotificationChannel(
pkg: String,
user: UserHandle,
channel: NotificationChannel
): Unit
Updates a notification channel for a given package for a given user. This should only be used to reflect changes a user has made to the channel via the listener's user interface.
This method will throw a security exception if you don't have access to notifications for the given user.
The caller must have device
in order to use this method.
Parameters |
pkg |
String: The package the channel belongs to. This value cannot be null . |
user |
UserHandle: The user the channel belongs to. This value cannot be null . |
channel |
NotificationChannel: the channel to update. This value cannot be null . |
Protected methods
attachBaseContext
protected open fun attachBaseContext(base: Context!): Unit
Parameters |
base |
Context!: The new base context for this wrapper. |