TrustedWebActivityService

Added in 1.2.0

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
`static final String`	`ACTION_TRUSTED_WEB_ACTIVITY_SERVICE = "android.support.customtabs.trusted.TRUSTED_WEB_ACTIVITY_SERVICE"` An Intent Action used by the provider to find the TrustedWebActivityService or subclass.
`static final String`	`KEY_SMALL_ICON_BITMAP = "android.support.customtabs.trusted.SMALL_ICON_BITMAP"` The key to use to store a Bitmap to return from the `onGetSmallIconBitmap` method.
`static final String`	`KEY_SUCCESS = "androidx.browser.trusted.SUCCESS"` The key to use to store a boolean in the returns bundle of `onExtraCommand` method, to indicate whether the command is executed successfully.
`static final String`	`META_DATA_NAME_SMALL_ICON = "android.support.customtabs.trusted.SMALL_ICON"` The Android Manifest meta-data name to specify a small icon id to use.
`static final int`	`SMALL_ICON_NOT_SET = -1` Used as a return value of `onGetSmallIconId` when the icon is not provided.

Public constructors
`TrustedWebActivityService()`

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

Inherited Constants

From android.content.ComponentCallbacks2

`static final int`	`TRIM_MEMORY_BACKGROUND = 40`
`static final int`	`TRIM_MEMORY_COMPLETE = 80` This field is deprecated.
`static final int`	`TRIM_MEMORY_MODERATE = 60` This field is deprecated.
`static final int`	`TRIM_MEMORY_RUNNING_CRITICAL = 15` This field is deprecated.
`static final int`	`TRIM_MEMORY_RUNNING_LOW = 10` This field is deprecated.
`static final int`	`TRIM_MEMORY_RUNNING_MODERATE = 5` This field is deprecated.
`static final int`	`TRIM_MEMORY_UI_HIDDEN = 20`

From android.content.Context

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

From android.app.Service

`static final int`	`START_CONTINUATION_MASK = 15`
`static final int`	`START_FLAG_REDELIVERY = 1`
`static final int`	`START_FLAG_RETRY = 2`
`static final int`	`START_NOT_STICKY = 2`
`static final int`	`START_REDELIVER_INTENT = 3`
`static final int`	`START_STICKY = 1`
`static final int`	`START_STICKY_COMPATIBILITY = 0`
`static final int`	`STOP_FOREGROUND_DETACH = 2`
`static final int`	`STOP_FOREGROUND_LEGACY = 0` This field is deprecated.
`static final int`	`STOP_FOREGROUND_REMOVE = 1`

Inherited methods

From android.content.Context

`final int`	`getColor(int id)`
`final ColorStateList`	`getColorStateList(int id)`
`final Drawable`	`getDrawable(int id)`
`final String`	`getString(int resId)`
`final T`	`<T> getSystemService(Class<T> serviceClass)`
`final CharSequence`	`getText(int resId)`
`final TypedArray`	`obtainStyledAttributes(AttributeSet set, int[] attrs)`
`void`	`revokeSelfPermissionOnKill(String permName)`
`void`	`sendBroadcastWithMultiplePermissions( Intent intent, String[] receiverPermissions )`

From android.content.ContextWrapper

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

From android.app.Service

`void`	`attachBaseContext(Context newBase)`
`void`	`dump(FileDescriptor fd, PrintWriter writer, String[] args)`
`final Application`	`getApplication()`
`final int`	`getForegroundServiceType()`
`void`	`onConfigurationChanged(Configuration newConfig)`
`void`	`onDestroy()`
`void`	`onLowMemory()` This method is deprecated.
`void`	`onRebind(Intent intent)`
`void`	`onStart(Intent intent, int startId)` This method is deprecated.
`int`	`onStartCommand(Intent intent, int flags, int startId)`
`void`	`onTaskRemoved(Intent rootIntent)`
`void`	`onTimeout(int startId)`
`void`	`onTrimMemory(int level)`
`final void`	`startForeground(int id, Notification notification)`
`final void`	`stopForeground(boolean removeNotification)` This method is deprecated.
`final void`	`stopSelf()`
`final boolean`	`stopSelfResult(int startId)`

Constants

ACTION_TRUSTED_WEB_ACTIVITY_SERVICE

Added in 1.2.0

public static final String ACTION_TRUSTED_WEB_ACTIVITY_SERVICE = "android.support.customtabs.trusted.TRUSTED_WEB_ACTIVITY_SERVICE"

An Intent Action used by the provider to find the TrustedWebActivityService or subclass.

KEY_SMALL_ICON_BITMAP

Added in 1.2.0

public static final String KEY_SMALL_ICON_BITMAP = "android.support.customtabs.trusted.SMALL_ICON_BITMAP"

The key to use to store a Bitmap to return from the onGetSmallIconBitmap method.

KEY_SUCCESS

Added in 1.3.0

public static final String KEY_SUCCESS = "androidx.browser.trusted.SUCCESS"

The key to use to store a boolean in the returns bundle of onExtraCommand method, to indicate whether the command is executed successfully.

META_DATA_NAME_SMALL_ICON

Added in 1.2.0

public static final String META_DATA_NAME_SMALL_ICON = "android.support.customtabs.trusted.SMALL_ICON"

The Android Manifest meta-data name to specify a small icon id to use.

SMALL_ICON_NOT_SET

Added in 1.2.0

public static final int SMALL_ICON_NOT_SET = -1

Used as a return value of onGetSmallIconId when the icon is not provided.

Public constructors

TrustedWebActivityService

Added in 1.2.0

public TrustedWebActivityService()

Public methods

getTokenStore

Added in 1.2.0

@BinderThread
public abstract @NonNull TokenStore getTokenStore()

Returns a TokenStore that is used to determine whether the connecting package is allowed to connect to this service.

Returns
`@NonNull TokenStore`	An `TokenStore` containing the verified provider.

onAreNotificationsEnabled

Added in 1.2.0

@BinderThread
public boolean onAreNotificationsEnabled(@NonNull String channelName)

Checks whether notifications are enabled.

Parameters
`@NonNull String channelName`	The name of the notification channel to be used on Android O+.

Returns
`boolean`	Whether notifications are enabled.

onBind

Added in 1.2.0

@MainThread
public final @Nullable IBinder onBind(@Nullable Intent intent)

onCancelNotification

Added in 1.2.0

@BinderThread
public void onCancelNotification(@NonNull String platformTag, int platformId)

Cancels a notification.

Parameters
`@NonNull String platformTag`	The notification tag, see `cancel`.
`int platformId`	The notification id, see `cancel`.

onCreate

@CallSuper
@MainThread
public void onCreate()

Called by the system when the service is first created. Do not call this method directly. Overrides must call super.onCreate().

onExtraCommand

Added in 1.3.0

@BinderThread
public @Nullable Bundle onExtraCommand(
    @NonNull String commandName,
    @NonNull Bundle args,
    @Nullable TrustedWebActivityCallbackRemote callbackRemote
)

Contains a free form command from the browser. The client and browser will need to agree on an additional API to use in advanced. This call can be used for testing or experimental purposes. A return value of null will be used to signify that the client does not know how to handle the request. As optional best practices, KEY_SUCCESS could be use to identify that command was *successfully* handled. For example, when returning a message with result:

    Bundle result = new Bundle();
    result.putString("message", message);
    if (success)
        result.putBoolean(KEY_SUCCESS, true);
    return result;

On the caller side:

    Bundle result = service.extraCommand(commandName, args);
    if (result.getBoolean(service.KEY_SUCCESS)) {
        // Command was successfully handled
    }

Parameters
`@NonNull String commandName`	Name of the command to execute.
`@NonNull Bundle args`	Arguments to the command.
`@Nullable TrustedWebActivityCallbackRemote callbackRemote`	Contains the callback that passed with the command.

Returns
`@Nullable Bundle`	The result `Bundle` or `null`.

onGetSmallIconBitmap

Added in 1.2.0

@BinderThread
public @NonNull Bundle onGetSmallIconBitmap()

Returns a Bundle containing a bitmap to be use as the small icon for any notifications.

Returns
`@NonNull Bundle`	A Bundle that may contain a Bitmap contained with key `KEY_SMALL_ICON_BITMAP`. The bundle may be empty if the client app does not provide a small icon.

onGetSmallIconId

Added in 1.2.0

@BinderThread
public int onGetSmallIconId()

Returns the Android resource id of a drawable to be used for the small icon of the notification. This is called by the provider as it is constructing the notification so a complete notification can be passed to the client. Default behaviour looks for meta-data with the name META_DATA_NAME_SMALL_ICON in service section of the manifest.

Returns
`int`	A resource id for the small icon, or `SMALL_ICON_NOT_SET` if not found.

onNotifyNotificationWithChannel

Added in 1.2.0

@RequiresPermission(value = Manifest.permission.POST_NOTIFICATIONS)
@BinderThread
public boolean onNotifyNotificationWithChannel(
    @NonNull String platformTag,
    int platformId,
    @NonNull Notification notification,
    @NonNull String channelName
)

Displays a notification.

Parameters
`@NonNull String platformTag`	The notification tag, see `notify`.
`int platformId`	The notification id, see `notify`.
`@NonNull Notification notification`	The notification to be displayed, constructed by the provider.
`@NonNull String channelName`	The name of the notification channel that the notification should be displayed on. This method gets or creates a channel from the name and modifies the notification to use that channel.

Returns
`boolean`	Whether the notification was successfully displayed (the channel/app may be blocked by the user).

onUnbind

Added in 1.2.0

@MainThread
public final boolean onUnbind(@Nullable Intent intent)