Summary: Constants | Inherited Constants | Ctors | Methods | Inherited Methods

TrustedWebActivityService

Kotlin |Java

public abstract class TrustedWebActivityService
extends Service

java.lang.Object
↳	android.content.Context
	↳	android.content.ContextWrapper
		↳	android.app.Service
			↳	androidx.browser.trusted.TrustedWebActivityService

---

The TrustedWebActivityService lives in a client app and serves requests from a Trusted Web Activity provider. At present it only serves requests to do with notifications.

When the provider receives a notification from a scope that is associated with a Trusted Web Activity client app, it will attempt to connect to a TrustedWebActivityService and forward calls. This allows the client app to display the notifications itself, meaning it is attributable to the client app and is managed by notification permissions of the client app, not the provider.

TrustedWebActivityService is usable as it is, by adding the following to your AndroidManifest:

 <service
     android:name="androidx.browser.trusted.TrustedWebActivityService"
     android:enabled="true"
     android:exported="true">

     <meta-data android:name="android.support.customtabs.trusted.SMALL_ICON"
         android:resource="@drawable/ic_notification_icon" />

     <intent-filter>
         <action android:name="android.support.customtabs.trusted.TRUSTED_WEB_ACTIVITY_SERVICE"/>
         <category android:name="android.intent.category.DEFAULT"/>
     </intent-filter>
 </service>
 
 

The SMALL_ICON resource should point to a drawable to be used for the notification's small icon.

Alternatively for greater customization, TrustedWebActivityService can be extended and overridden. In this case the manifest entry should be updated to point to the extending class.

As this is an AIDL Service, calls may come in from different Binder threads, so overriding implementations need to be thread safe [1].

For security, the TrustedWebActivityService will check that whatever connects to it matches the Token stored in the TokenStore returned by getTokenStore(). This is because we don't want to allow any app on the users device to connect to this Service be able to make it display notifications. [1]: https://developer.android.com/guide/components/aidl.html

Summary

Constants
String	ACTION_TRUSTED_WEB_ACTIVITY_SERVICE An Intent Action used by the provider to find the TrustedWebActivityService or subclass.
String	KEY_SMALL_ICON_BITMAP The key to use to store a Bitmap to return from the onGetSmallIconBitmap() method.
String	KEY_SUCCESS The key to use to store a boolean in the returns bundle of onExtraCommand(String, Bundle, TrustedWebActivityCallbackRemote) method, to indicate whether the command is executed successfully.
String	META_DATA_NAME_SMALL_ICON The Android Manifest meta-data name to specify a small icon id to use.
int	SMALL_ICON_NOT_SET Used as a return value of onGetSmallIconId() when the icon is not provided.

Inherited constants
From class android.app.Service int START_CONTINUATION_MASK int START_FLAG_REDELIVERY int START_FLAG_RETRY int START_NOT_STICKY int START_REDELIVER_INTENT int START_STICKY int START_STICKY_COMPATIBILITY int STOP_FOREGROUND_DETACH int STOP_FOREGROUND_REMOVE
From class android.content.Context String ACCESSIBILITY_SERVICE String ACCOUNT_SERVICE String ACTIVITY_SERVICE String ALARM_SERVICE String APPWIDGET_SERVICE String APP_OPS_SERVICE String APP_SEARCH_SERVICE String AUDIO_SERVICE String BATTERY_SERVICE int BIND_ABOVE_CLIENT int BIND_ADJUST_WITH_ACTIVITY int BIND_ALLOW_OOM_MANAGEMENT int BIND_AUTO_CREATE int BIND_DEBUG_UNBIND int BIND_EXTERNAL_SERVICE int BIND_IMPORTANT int BIND_INCLUDE_CAPABILITIES int BIND_NOT_FOREGROUND int BIND_NOT_PERCEPTIBLE int BIND_WAIVE_PRIORITY String BIOMETRIC_SERVICE String BLOB_STORE_SERVICE String BLUETOOTH_SERVICE String BUGREPORT_SERVICE String CAMERA_SERVICE String CAPTIONING_SERVICE String CARRIER_CONFIG_SERVICE String CLIPBOARD_SERVICE String COMPANION_DEVICE_SERVICE String CONNECTIVITY_DIAGNOSTICS_SERVICE String CONNECTIVITY_SERVICE String CONSUMER_IR_SERVICE int CONTEXT_IGNORE_SECURITY int CONTEXT_INCLUDE_CODE int CONTEXT_RESTRICTED String CROSS_PROFILE_APPS_SERVICE String DEVICE_POLICY_SERVICE String DISPLAY_HASH_SERVICE String DISPLAY_SERVICE String DOMAIN_VERIFICATION_SERVICE String DOWNLOAD_SERVICE String DROPBOX_SERVICE String EUICC_SERVICE String FILE_INTEGRITY_SERVICE String FINGERPRINT_SERVICE String GAME_SERVICE String HARDWARE_PROPERTIES_SERVICE String INPUT_METHOD_SERVICE String INPUT_SERVICE String IPSEC_SERVICE String JOB_SCHEDULER_SERVICE String KEYGUARD_SERVICE String LAUNCHER_APPS_SERVICE String LAYOUT_INFLATER_SERVICE String LOCATION_SERVICE String MEDIA_COMMUNICATION_SERVICE String MEDIA_METRICS_SERVICE String MEDIA_PROJECTION_SERVICE String MEDIA_ROUTER_SERVICE String MEDIA_SESSION_SERVICE String MIDI_SERVICE int MODE_APPEND int MODE_ENABLE_WRITE_AHEAD_LOGGING int MODE_MULTI_PROCESS int MODE_NO_LOCALIZED_COLLATORS int MODE_PRIVATE int MODE_WORLD_READABLE int MODE_WORLD_WRITEABLE String NETWORK_STATS_SERVICE String NFC_SERVICE String NOTIFICATION_SERVICE String NSD_SERVICE String PEOPLE_SERVICE String PERFORMANCE_HINT_SERVICE String POWER_SERVICE String PRINT_SERVICE int RECEIVER_VISIBLE_TO_INSTANT_APPS String RESTRICTIONS_SERVICE String ROLE_SERVICE String SEARCH_SERVICE String SENSOR_SERVICE String SHORTCUT_SERVICE String STORAGE_SERVICE String STORAGE_STATS_SERVICE String SYSTEM_HEALTH_SERVICE String TELECOM_SERVICE String TELEPHONY_IMS_SERVICE String TELEPHONY_SERVICE String TELEPHONY_SUBSCRIPTION_SERVICE String TEXT_CLASSIFICATION_SERVICE String TEXT_SERVICES_MANAGER_SERVICE String TV_INPUT_SERVICE String UI_MODE_SERVICE String USAGE_STATS_SERVICE String USB_SERVICE String USER_SERVICE String VIBRATOR_MANAGER_SERVICE String VIBRATOR_SERVICE String VPN_MANAGEMENT_SERVICE String WALLPAPER_SERVICE String WIFI_AWARE_SERVICE String WIFI_P2P_SERVICE String WIFI_RTT_RANGING_SERVICE String WIFI_SERVICE String WINDOW_SERVICE
From interface android.content.ComponentCallbacks2 int TRIM_MEMORY_BACKGROUND int TRIM_MEMORY_COMPLETE int TRIM_MEMORY_MODERATE int TRIM_MEMORY_RUNNING_CRITICAL int TRIM_MEMORY_RUNNING_LOW int TRIM_MEMORY_RUNNING_MODERATE int TRIM_MEMORY_UI_HIDDEN

Public constructors
TrustedWebActivityService()

Public methods
abstract TokenStore	getTokenStore() Returns a TokenStore that is used to determine whether the connecting package is allowed to connect to this service.
boolean	onAreNotificationsEnabled(String channelName) Checks whether notifications are enabled.
final IBinder	onBind(Intent intent)
void	onCancelNotification(String platformTag, int platformId) Cancels a notification.
void	onCreate() Called by the system when the service is first created.
Bundle	onExtraCommand(String commandName, Bundle args, TrustedWebActivityCallbackRemote callbackRemote) Contains a free form command from the browser.
Bundle	onGetSmallIconBitmap() Returns a Bundle containing a bitmap to be use as the small icon for any notifications.
int	onGetSmallIconId() Returns the Android resource id of a drawable to be used for the small icon of the notification.
boolean	onNotifyNotificationWithChannel(String platformTag, int platformId, Notification notification, String channelName) Displays a notification.
final boolean	onUnbind(Intent intent)

Inherited methods
From class android.app.Service void attachBaseContext(Context arg0) void dump(FileDescriptor arg0, PrintWriter arg1, String[] arg2) final Application getApplication() final int getForegroundServiceType() abstract IBinder onBind(Intent arg0) void onConfigurationChanged(Configuration arg0) void onCreate() void onDestroy() void onLowMemory() void onRebind(Intent arg0) void onStart(Intent arg0, int arg1) int onStartCommand(Intent arg0, int arg1, int arg2) void onTaskRemoved(Intent arg0) void onTrimMemory(int arg0) boolean onUnbind(Intent arg0) final void startForeground(int arg0, Notification arg1) final void startForeground(int arg0, Notification arg1, int arg2) final void stopForeground(int arg0) final void stopForeground(boolean arg0) final void stopSelf() final void stopSelf(int arg0) final boolean stopSelfResult(int arg0)
From class android.content.ContextWrapper void attachBaseContext(Context arg0) boolean bindIsolatedService(Intent arg0, int arg1, String arg2, Executor arg3, ServiceConnection arg4) boolean bindService(Intent arg0, int arg1, Executor arg2, ServiceConnection arg3) boolean bindService(Intent arg0, ServiceConnection arg1, int arg2) boolean bindServiceAsUser(Intent arg0, ServiceConnection arg1, int arg2, UserHandle arg3) int checkCallingOrSelfPermission(String arg0) int checkCallingOrSelfUriPermission(Uri arg0, int arg1) int[] checkCallingOrSelfUriPermissions(List<Uri> arg0, int arg1) int checkCallingPermission(String arg0) int checkCallingUriPermission(Uri arg0, int arg1) int[] checkCallingUriPermissions(List<Uri> arg0, int arg1) int checkPermission(String arg0, int arg1, int arg2) int checkSelfPermission(String arg0) int checkUriPermission(Uri arg0, String arg1, String arg2, int arg3, int arg4, int arg5) int checkUriPermission(Uri arg0, int arg1, int arg2, int arg3) int[] checkUriPermissions(List<Uri> arg0, int arg1, int arg2, int arg3) void clearWallpaper() Context createAttributionContext(String arg0) Context createConfigurationContext(Configuration arg0)