NotificationCompatSideChannelService

Added in 1.1.0

Kotlin |Java

abstract class NotificationCompatSideChannelService : Service

kotlin.Any
↳	android.content.Context
	↳	android.content.ContextWrapper
		↳	android.app.Service
			↳	androidx.core.app.NotificationCompatSideChannelService

Abstract service to receive side channel notifications sent from androidx.core.app.NotificationManagerCompat.

To receive side channel notifications, extend this service and register it in your android manifest with an intent filter for the BIND_NOTIFICATION_SIDE_CHANNEL action. Note: you must also have an enabled android.service.notification.NotificationListenerService within your package.

Example AndroidManifest.xml addition:

<service android:name="com.example.NotificationSideChannelService">
    <intent-filter>
        <action android:name="android.support.BIND_NOTIFICATION_SIDE_CHANNEL" />
    </intent-filter>
</service>

Summary

Public constructors
`NotificationCompatSideChannelService()`

Public functions
`abstract Unit`	`cancel(packageName: String!, id: Int, tag: String!)` Handle a side-channelled notification being cancelled.
`abstract Unit`	`cancelAll(packageName: String!)` Handle the side-channelled cancelling of all notifications for a package.
`abstract Unit`	`notify(packageName: String!, id: Int, tag: String!, notification: Notification!)` Handle a side-channeled notification being posted.
`IBinder!`	`@DeprecatedSinceApi(api = 19, message = "SDKs past 19 have no need for side channeling.") onBind(intent: Intent!)`

Inherited Constants

From android.content.ComponentCallbacks2

`const Int`	`TRIM_MEMORY_BACKGROUND = 40`
`const Int`	`TRIM_MEMORY_COMPLETE = 80`
`const Int`	`TRIM_MEMORY_MODERATE = 60`
`const Int`	`TRIM_MEMORY_RUNNING_CRITICAL = 15`
`const Int`	`TRIM_MEMORY_RUNNING_LOW = 10`
`const Int`	`TRIM_MEMORY_RUNNING_MODERATE = 5`
`const Int`	`TRIM_MEMORY_UI_HIDDEN = 20`

From android.content.Context

`const String!`	`ACCESSIBILITY_SERVICE = "accessibility"`
`const String!`	`ACCOUNT_SERVICE = "account"`
`const String!`	`ACTIVITY_SERVICE = "activity"`
`const String!`	`ALARM_SERVICE = "alarm"`
`const String!`	`APPWIDGET_SERVICE = "appwidget"`
`const String!`	`APP_OPS_SERVICE = "appops"`
`const String!`	`APP_SEARCH_SERVICE = "app_search"`
`const String!`	`AUDIO_SERVICE = "audio"`
`const String!`	`BATTERY_SERVICE = "batterymanager"`
`const Int`	`BIND_ABOVE_CLIENT = 8`
`const Int`	`BIND_ADJUST_WITH_ACTIVITY = 128`
`const Int`	`BIND_ALLOW_ACTIVITY_STARTS = 512`
`const Int`	`BIND_ALLOW_OOM_MANAGEMENT = 16`
`const Int`	`BIND_AUTO_CREATE = 1`
`const Int`	`BIND_DEBUG_UNBIND = 2`
`const Int`	`BIND_EXTERNAL_SERVICE = -2147483648`
`const Long`	`BIND_EXTERNAL_SERVICE_LONG = 4611686018427387904`
`const Int`	`BIND_IMPORTANT = 64`
`const Int`	`BIND_INCLUDE_CAPABILITIES = 4096`
`const Int`	`BIND_NOT_FOREGROUND = 4`
`const Int`	`BIND_NOT_PERCEPTIBLE = 256`
`const Int`	`BIND_SHARED_ISOLATED_PROCESS = 8192`
`const Int`	`BIND_WAIVE_PRIORITY = 32`
`const String!`	`BIOMETRIC_SERVICE = "biometric"`
`const String!`	`BLOB_STORE_SERVICE = "blob_store"`
`const String!`	`BLUETOOTH_SERVICE = "bluetooth"`
`const String!`	`BUGREPORT_SERVICE = "bugreport"`
`const String!`	`CAMERA_SERVICE = "camera"`
`const String!`	`CAPTIONING_SERVICE = "captioning"`
`const String!`	`CARRIER_CONFIG_SERVICE = "carrier_config"`
`const String!`	`CLIPBOARD_SERVICE = "clipboard"`
`const String!`	`COMPANION_DEVICE_SERVICE = "companiondevice"`
`const String!`	`CONNECTIVITY_DIAGNOSTICS_SERVICE = "connectivity_diagnostics"`
`const String!`	`CONNECTIVITY_SERVICE = "connectivity"`
`const String!`	`CONSUMER_IR_SERVICE = "consumer_ir"`
`const Int`	`CONTEXT_IGNORE_SECURITY = 2`
`const Int`	`CONTEXT_INCLUDE_CODE = 1`
`const Int`	`CONTEXT_RESTRICTED = 4`
`const String!`	`CREDENTIAL_SERVICE = "credential"`
`const String!`	`CROSS_PROFILE_APPS_SERVICE = "crossprofileapps"`
`const Int`	`DEVICE_ID_DEFAULT = 0`
`const Int`	`DEVICE_ID_INVALID = -1`
`const String!`	`DEVICE_LOCK_SERVICE = "device_lock"`
`const String!`	`DEVICE_POLICY_SERVICE = "device_policy"`
`const String!`	`DISPLAY_HASH_SERVICE = "display_hash"`
`const String!`	`DISPLAY_SERVICE = "display"`
`const String!`	`DOMAIN_VERIFICATION_SERVICE = "domain_verification"`
`const String!`	`DOWNLOAD_SERVICE = "download"`
`const String!`	`DROPBOX_SERVICE = "dropbox"`
`const String!`	`EUICC_SERVICE = "euicc"`
`const String!`	`FILE_INTEGRITY_SERVICE = "file_integrity"`
`const String!`	`FINGERPRINT_SERVICE = "fingerprint"`
`const String!`	`GAME_SERVICE = "game"`
`const String!`	`GRAMMATICAL_INFLECTION_SERVICE = "grammatical_inflection"`
`const String!`	`HARDWARE_PROPERTIES_SERVICE = "hardware_properties"`
`const String!`	`HEALTHCONNECT_SERVICE = "healthconnect"`
`const String!`	`INPUT_METHOD_SERVICE = "input_method"`
`const String!`	`INPUT_SERVICE = "input"`
`const String!`	`IPSEC_SERVICE = "ipsec"`
`const String!`	`JOB_SCHEDULER_SERVICE = "jobscheduler"`
`const String!`	`KEYGUARD_SERVICE = "keyguard"`
`const String!`	`LAUNCHER_APPS_SERVICE = "launcherapps"`
`const String!`	`LAYOUT_INFLATER_SERVICE = "layout_inflater"`
`const String!`	`LOCALE_SERVICE = "locale"`
`const String!`	`LOCATION_SERVICE = "location"`
`const String!`	`MEDIA_COMMUNICATION_SERVICE = "media_communication"`
`const String!`	`MEDIA_METRICS_SERVICE = "media_metrics"`
`const String!`	`MEDIA_PROJECTION_SERVICE = "media_projection"`
`const String!`	`MEDIA_ROUTER_SERVICE = "media_router"`
`const String!`	`MEDIA_SESSION_SERVICE = "media_session"`
`const String!`	`MIDI_SERVICE = "midi"`
`const Int`	`MODE_APPEND = 32768`
`const Int`	`MODE_ENABLE_WRITE_AHEAD_LOGGING = 8`
`const Int`	`MODE_MULTI_PROCESS = 4` This property is deprecated.
`const Int`	`MODE_NO_LOCALIZED_COLLATORS = 16`
`const Int`	`MODE_PRIVATE = 0`
`const Int`	`MODE_WORLD_READABLE = 1` This property is deprecated.
`const Int`	`MODE_WORLD_WRITEABLE = 2` This property is deprecated.
`const String!`	`NETWORK_STATS_SERVICE = "netstats"`
`const String!`	`NFC_SERVICE = "nfc"`
`const String!`	`NOTIFICATION_SERVICE = "notification"`
`const String!`	`NSD_SERVICE = "servicediscovery"`
`const String!`	`OVERLAY_SERVICE = "overlay"`
`const String!`	`PEOPLE_SERVICE = "people"`
`const String!`	`PERFORMANCE_HINT_SERVICE = "performance_hint"`
`const String!`	`POWER_SERVICE = "power"`
`const String!`	`PRINT_SERVICE = "print"`
`const Int`	`RECEIVER_EXPORTED = 2`
`const Int`	`RECEIVER_NOT_EXPORTED = 4`
`const Int`	`RECEIVER_VISIBLE_TO_INSTANT_APPS = 1`
`const String!`	`RESTRICTIONS_SERVICE = "restrictions"`
`const String!`	`ROLE_SERVICE = "role"`
`const String!`	`SEARCH_SERVICE = "search"`
`const String!`	`SENSOR_SERVICE = "sensor"`
`const String!`	`SHORTCUT_SERVICE = "shortcut"`
`const String!`	`STATUS_BAR_SERVICE = "statusbar"`
`const String!`	`STORAGE_SERVICE = "storage"`
`const String!`	`STORAGE_STATS_SERVICE = "storagestats"`
`const String!`	`SYSTEM_HEALTH_SERVICE = "systemhealth"`
`const String!`	`TELECOM_SERVICE = "telecom"`
`const String!`	`TELEPHONY_IMS_SERVICE = "telephony_ims"`
`const String!`	`TELEPHONY_SERVICE = "phone"`
`const String!`	`TELEPHONY_SUBSCRIPTION_SERVICE = "telephony_subscription_service"`
`const String!`	`TEXT_CLASSIFICATION_SERVICE = "textclassification"`
`const String!`	`TEXT_SERVICES_MANAGER_SERVICE = "textservices"`
`const String!`	`TV_INPUT_SERVICE = "tv_input"`
`const String!`	`TV_INTERACTIVE_APP_SERVICE = "tv_interactive_app"`
`const String!`	`UI_MODE_SERVICE = "uimode"`
`const String!`	`USAGE_STATS_SERVICE = "usagestats"`
`const String!`	`USB_SERVICE = "usb"`
`const String!`	`USER_SERVICE = "user"`
`const String!`	`VIBRATOR_MANAGER_SERVICE = "vibrator_manager"`
`const String!`	`VIBRATOR_SERVICE = "vibrator"` This property is deprecated.
`const String!`	`VIRTUAL_DEVICE_SERVICE = "virtualdevice"`
`const String!`	`VPN_MANAGEMENT_SERVICE = "vpn_management"`
`const String!`	`WALLPAPER_SERVICE = "wallpaper"`
`const String!`	`WIFI_AWARE_SERVICE = "wifiaware"`
`const String!`	`WIFI_P2P_SERVICE = "wifip2p"`
`const String!`	`WIFI_RTT_RANGING_SERVICE = "wifirtt"`
`const String!`	`WIFI_SERVICE = "wifi"`
`const String!`	`WINDOW_SERVICE = "window"`

From android.app.Service

`const Int`	`START_CONTINUATION_MASK = 15`
`const Int`	`START_FLAG_REDELIVERY = 1`
`const Int`	`START_FLAG_RETRY = 2`
`const Int`	`START_NOT_STICKY = 2`
`const Int`	`START_REDELIVER_INTENT = 3`
`const Int`	`START_STICKY = 1`
`const Int`	`START_STICKY_COMPATIBILITY = 0`
`const Int`	`STOP_FOREGROUND_DETACH = 2`
`const Int`	`STOP_FOREGROUND_LEGACY = 0` This property is deprecated.
`const Int`	`STOP_FOREGROUND_REMOVE = 1`

Inherited functions

From android.content.Context

`Int`	`getColor(id: Int)`
`ColorStateList!`	`getColorStateList(id: Int)`
`Drawable!`	`getDrawable(id: Int)`
`String!`	`getString(resId: Int)`
`T!`	`<T> getSystemService(serviceClass: Class<T!>!)`
`CharSequence!`	`getText(resId: Int)`
`TypedArray!`	`obtainStyledAttributes(attrs: IntArray!)`
`Unit`	`revokeSelfPermissionOnKill(permName: String!)`
`Unit`	`sendBroadcastWithMultiplePermissions( intent: Intent!, receiverPermissions: Array<String!>! )`

From android.content.ContextWrapper

`Boolean`	`bindIsolatedService( service: Intent!, flags: Int, instanceName: String!, executor: Executor!, conn: ServiceConnection! )`
`Boolean`	`bindService(service: Intent!, conn: ServiceConnection!, flags: Int)`
`Boolean`	`bindServiceAsUser( service: Intent!, conn: ServiceConnection!, flags: Int, user: UserHandle! )`
`Int`	`checkCallingOrSelfPermission(permission: String!)`
`Int`	`checkCallingOrSelfUriPermission(uri: Uri!, modeFlags: Int)`
`IntArray<Int>!`	`checkCallingOrSelfUriPermissions( uris: (Mutable)List<Uri!>!, modeFlags: Int )`
`Int`	`checkCallingPermission(permission: String!)`
`Int`	`checkCallingUriPermission(uri: Uri!, modeFlags: Int)`
`IntArray<Int>!`	`checkCallingUriPermissions(uris: (Mutable)List<Uri!>!, modeFlags: Int)`
`Int`	`checkPermission(permission: String!, pid: Int, uid: Int)`
`Int`	`checkSelfPermission(permission: String!)`
`Int`	`checkUriPermission(uri: Uri!, pid: Int, uid: Int, modeFlags: Int)`
`IntArray<Int>!`	`checkUriPermissions( uris: (Mutable)List<Uri!>!, pid: Int, uid: Int, modeFlags: Int )`
`Unit`	`clearWallpaper()` This function is deprecated.
`Context!`	`createAttributionContext(attributionTag: String!)`
`Context!`	`createConfigurationContext(overrideConfiguration: Configuration!)`
`Context!`	`createContext(contextParams: ContextParams!)`
`Context!`	`createContextForSplit(splitName: String!)`
`Context!`	`createDeviceContext(deviceId: Int)`
`Context!`	`createDeviceProtectedStorageContext()`
`Context!`	`createDisplayContext(display: Display!)`
`Context!`	`createPackageContext(packageName: String!, flags: Int)`
`Context!`	`createWindowContext(type: Int, options: Bundle!)`
`Array<String!>!`	`databaseList()`
`Boolean`	`deleteDatabase(name: String!)`
`Boolean`	`deleteFile(name: String!)`
`Boolean`	`deleteSharedPreferences(name: String!)`
`Unit`	`enforceCallingOrSelfPermission(permission: String!, message: String!)`
`Unit`	`enforceCallingOrSelfUriPermission( uri: Uri!, modeFlags: Int, message: String! )`
`Unit`	`enforceCallingPermission(permission: String!, message: String!)`
`Unit`	`enforceCallingUriPermission(uri: Uri!, modeFlags: Int, message: String!)`
`Unit`	`enforcePermission(permission: String!, pid: Int, uid: Int, message: String!)`
`Unit`	`enforceUriPermission( uri: Uri!, pid: Int, uid: Int, modeFlags: Int, message: String! )`
`Array<String!>!`	`fileList()`
`Context!`	`getApplicationContext()`
`ApplicationInfo!`	`getApplicationInfo()`
`AssetManager!`	`getAssets()`
`AttributionSource!`	`getAttributionSource()`
`String!`	`getAttributionTag()`
`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()`
`File!`	`getExternalCacheDir()`
`Array<File!>!`	`getExternalCacheDirs()`
`File!`	`getExternalFilesDir(type: String!)`
`Array<File!>!`	`getExternalFilesDirs(type: String!)`
`Array<File!>!`	`getExternalMediaDirs()` This function is deprecated.
`File!`	`getFileStreamPath(name: String!)`
`File!`	`getFilesDir()`
`Executor!`	`getMainExecutor()`
`Looper!`	`getMainLooper()`
`File!`	`getNoBackupFilesDir()`
`File!`	`getObbDir()`
`Array<File!>!`	`getObbDirs()`
`String!`	`getOpPackageName()`
`String!`	`getPackageCodePath()`
`PackageManager!`	`getPackageManager()`
`String!`	`getPackageName()`
`String!`	`getPackageResourcePath()`
`ContextParams!`	`getParams()`
`Resources!`	`getResources()`
`SharedPreferences!`	`getSharedPreferences(name: String!, mode: Int)`
`Any!`	`getSystemService(name: String!)`
`String!`	`getSystemServiceName(serviceClass: Class<Any!>!)`
`Resources.Theme!`	`getTheme()`
`Drawable!`	`getWallpaper()` This function is deprecated.
`Int`	`getWallpaperDesiredMinimumHeight()` This function is deprecated.
`Int`	`getWallpaperDesiredMinimumWidth()` This function is deprecated.
`Unit`	`grantUriPermission(toPackage: String!, uri: Uri!, modeFlags: Int)`
`Boolean`	`isDeviceProtectedStorage()`
`Boolean`	`isRestricted()`
`Boolean`	`isUiContext()`
`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! )`
`Drawable!`	`peekWallpaper()` This function is deprecated.
`Unit`	`registerComponentCallbacks(callback: ComponentCallbacks!)`
`Unit`	`registerDeviceIdChangeListener(executor: Executor!, listener: IntConsumer!)`
`Intent!`	`registerReceiver(receiver: BroadcastReceiver!, filter: IntentFilter!)`
`Unit`	`removeStickyBroadcast(intent: Intent!)` This function is deprecated.
`Unit`	`removeStickyBroadcastAsUser(intent: Intent!, user: UserHandle!)` This function is deprecated.
`Unit`	`revokeSelfPermissionsOnKill(permissions: (Mutable)Collection<String!>!)`
`Unit`	`revokeUriPermission(uri: Uri!, modeFlags: Int)`
`Unit`	`sendBroadcast(intent: Intent!)`
`Unit`	`sendBroadcastAsUser(intent: Intent!, user: UserHandle!)`
`Unit`	`sendOrderedBroadcast(intent: Intent!, receiverPermission: String!)`
`Unit`	`sendOrderedBroadcastAsUser( intent: Intent!, user: UserHandle!, receiverPermission: String!, resultReceiver: BroadcastReceiver!, scheduler: Handler!, initialCode: Int, initialData: String!, initialExtras: Bundle! )`
`Unit`	`sendStickyBroadcast(intent: Intent!)` This function is deprecated.
`Unit`	`sendStickyBroadcastAsUser(intent: Intent!, user: UserHandle!)` This function is deprecated.
`Unit`	`sendStickyOrderedBroadcast( intent: Intent!, resultReceiver: BroadcastReceiver!, scheduler: Handler!, initialCode: Int, initialData: String!, initialExtras: Bundle! )` This function is deprecated.
`Unit`	`sendStickyOrderedBroadcastAsUser( intent: Intent!, user: UserHandle!, resultReceiver: BroadcastReceiver!, scheduler: Handler!, initialCode: Int, initialData: String!, initialExtras: Bundle! )` This function is deprecated.
`Unit`	`setTheme(resid: Int)`
`Unit`	`setWallpaper(bitmap: Bitmap!)` This function is deprecated.
`Unit`	`startActivities(intents: Array<Intent!>!)`
`Unit`	`startActivity(intent: Intent!)`
`ComponentName!`	`startForegroundService(service: Intent!)`
`Boolean`	`startInstrumentation( className: ComponentName!, profileFile: String!, arguments: Bundle! )`
`Unit`	`startIntentSender( intent: IntentSender!, fillInIntent: Intent!, flagsMask: Int, flagsValues: Int, extraFlags: Int )`
`ComponentName!`	`startService(service: Intent!)`
`Boolean`	`stopService(name: Intent!)`
`Unit`	`unbindService(conn: ServiceConnection!)`
`Unit`	`unregisterComponentCallbacks(callback: ComponentCallbacks!)`
`Unit`	`unregisterDeviceIdChangeListener(listener: IntConsumer!)`
`Unit`	`unregisterReceiver(receiver: BroadcastReceiver!)`
`Unit`	`updateServiceGroup(conn: ServiceConnection!, group: Int, importance: Int)`

From android.app.Service

`Unit`	`attachBaseContext(newBase: Context!)`
`Unit`	`dump(fd: FileDescriptor!, writer: PrintWriter!, args: Array<String!>!)`
`Application!`	`getApplication()`
`Int`	`getForegroundServiceType()`
`Unit`	`onConfigurationChanged(newConfig: Configuration!)`
`Unit`	`onCreate()`
`Unit`	`onDestroy()`
`Unit`	`onLowMemory()`
`Unit`	`onRebind(intent: Intent!)`
`Unit`	`onStart(intent: Intent!, startId: Int)` This function is deprecated.
`Int`	`onStartCommand(intent: Intent!, flags: Int, startId: Int)`
`Unit`	`onTaskRemoved(rootIntent: Intent!)`
`Unit`	`onTimeout(startId: Int)`
`Unit`	`onTrimMemory(level: Int)`
`Boolean`	`onUnbind(intent: Intent!)`
`Unit`	`startForeground(id: Int, notification: Notification!)`
`Unit`	`stopForeground(removeNotification: Boolean)` This function is deprecated.
`Unit`	`stopSelf()`
`Boolean`	`stopSelfResult(startId: Int)`

Public constructors

NotificationCompatSideChannelService

Added in 1.1.0

NotificationCompatSideChannelService()

Public functions

cancel

Added in 1.1.0

abstract fun cancel(packageName: String!, id: Int, tag: String!): Unit

Handle a side-channelled notification being cancelled.

cancelAll

Added in 1.1.0

abstract fun cancelAll(packageName: String!): Unit

Handle the side-channelled cancelling of all notifications for a package.

notify

Added in 1.1.0

abstract fun notify(packageName: String!, id: Int, tag: String!, notification: Notification!): Unit

Handle a side-channeled notification being posted.

onBind

Added in 1.1.0

@DeprecatedSinceApi(api = 19, message = "SDKs past 19 have no need for side channeling.")
fun onBind(intent: Intent!): IBinder!