CredentialProviderEventsService

Artifact: androidx.credentials.providerevents:providerevents

Kotlin |Java

public abstract class CredentialProviderEventsService extends Service

java.lang.Object
↳	android.content.Context
	↳	android.content.ContextWrapper
		↳	android.app.Service
			↳	androidx.credentials.providerevents.service.CredentialProviderEventsService

A base service for credential providers to receive advanced requests from androidx.credentials.CredentialManager.

This service builds upon the functionality of CredentialProviderService by enabling support for more advanced credential requests, such as conditional creation.

Note that this service is distinct from CredentialProviderService, which handles basic credential saving and retrieval requests.

This service is bound only during the duration of an API call. To receive requests, users must enable the corresponding CredentialProviderService from within the same package, in Android Settings.

Basic Usage

The interaction between Credential Manager and this service typically involves:

A client application invokes an advanced API in androidx.credentials.CredentialManager, such as a conditional credential creation request using androidx.credentials.CreatePublicKeyCredentialRequest.isConditional.
The Android system forwards the request to enabled credential providers that support the requested feature.
Credential providers receive the request, process it, and return an appropriate response.
Depending on the requested feature, providers may display UI elements such as notifications.
The Android system sends the result back to the client application.

This flow is designed to minimize the service's lifecycle. Calls to the service are stateless. If a service requires maintaining state between calls, it must implement its own state management. Note that the service's process may be terminated by the Android System when unbound, such as during low-memory conditions.

Service Registration

To enable Credential Manager to send requests to a provider service, the provider must:

Extend this class and implement the required methods.
Declare the name of this service class within the metadata of the corresponding CredentialProviderService. This is done using the android.service.credentials.CredentialProviderService.SERVICE_META_DATA key. The service class name should be specified along with supported capabilities.

For example: ``xml <credential-provider xmlns:android="http://schemas.android.com/apk/res/android" android:settingsActivity="xyz"> <capabilities> <capability name="android.credentials.TYPE_PASSWORD_CREDENTIAL" /> <capability name="androidx.credentials.TYPE_PUBLIC_KEY_CREDENTIAL" /> </capabilities> <events-service class-name="MyCredentialProviderEventsService" /> </credential-provider> ``

Summary

Public constructors
`CredentialProviderEventsService()`

Public methods
`IBinder`	`onBind(Intent intent)`
`void`	`onCreateCredentialRequest( @NonNull ProviderCreateCredentialRequest request, @NonNull CancellationSignal cancellationSignal, @NonNull OutcomeReceiverCompat<@NonNull CreateCredentialResponse, @NonNull CreateCredentialException> callback )` Called when a credential provider should create a credential.

Inherited methods

From android.content.Context

`boolean`	`bindIsolatedService( @NonNull Intent p0, @NonNull Context.BindServiceFlags p1, @NonNull String p2, @NonNull Executor p3, @NonNull ServiceConnection p4 )`
`final int`	`getColor(int p0)`
`final @NonNull ColorStateList`	`getColorStateList(int p0)`
`final @Nullable Drawable`	`getDrawable(int p0)`
`final @NonNull String`	`getString(int p0)`
`final @NonNull String`	`getString(int p0, @NonNull Object p1)`
`final @NonNull T`	`<T extends Object> getSystemService(@NonNull Class<@NonNull T> p0)`
`final @NonNull CharSequence`	`getText(int p0)`
`final @NonNull TypedArray`	`obtainStyledAttributes(@NonNull int[] p0)`
`final @NonNull TypedArray`	`obtainStyledAttributes(@Nullable AttributeSet p0, @NonNull int[] p1)`
`final @NonNull TypedArray`	`obtainStyledAttributes(int p0, @NonNull int[] p1)`
`final @NonNull TypedArray`	`obtainStyledAttributes( @Nullable AttributeSet p0, @NonNull int[] p1, int p2, int p3 )`
`void`	`revokeSelfPermissionOnKill(@NonNull String p0)`
`void`	`sendBroadcastWithMultiplePermissions( @NonNull Intent p0, @NonNull String[] p1 )`

From android.content.ContextWrapper

`boolean`	`bindIsolatedService( @NonNull Intent p0, int p1, @NonNull String p2, @NonNull Executor p3, @NonNull ServiceConnection p4 )`
`boolean`	`bindService( @NonNull Intent p0, @NonNull ServiceConnection p1, @NonNull Context.BindServiceFlags p2 )`
`boolean`	`bindService(@NonNull Intent p0, @NonNull ServiceConnection p1, int p2)`
`boolean`	`bindService( @NonNull Intent p0, @NonNull Context.BindServiceFlags p1, @NonNull Executor p2, @NonNull ServiceConnection p3 )`
`boolean`	`bindService( @NonNull Intent p0, int p1, @NonNull Executor p2, @NonNull ServiceConnection p3 )`
`boolean`	`bindServiceAsUser( @NonNull Intent p0, @NonNull ServiceConnection p1, @NonNull Context.BindServiceFlags p2, @NonNull UserHandle p3 )`
`boolean`	`bindServiceAsUser( @NonNull Intent p0, @NonNull ServiceConnection p1, int p2, @NonNull UserHandle p3 )`
`int`	`checkCallingOrSelfPermission(@NonNull String p0)`
`int`	`checkCallingOrSelfUriPermission(@NonNull Uri p0, int p1)`
`@NonNull int[]`	`checkCallingOrSelfUriPermissions(@NonNull List<@NonNull Uri> p0, int p1)`
`int`	`checkCallingPermission(@NonNull String p0)`
`int`	`checkCallingUriPermission(@NonNull Uri p0, int p1)`
`@NonNull int[]`	`checkCallingUriPermissions(@NonNull List<@NonNull Uri> p0, int p1)`
`int`	`checkContentUriPermissionFull(@NonNull Uri p0, int p1, int p2, int p3)`
`int`	`checkPermission(@NonNull String p0, int p1, int p2)`
`int`	`checkSelfPermission(@NonNull String p0)`
`int`	`checkUriPermission(@NonNull Uri p0, int p1, int p2, int p3)`
`int`	`checkUriPermission( @Nullable Uri p0, @Nullable String p1, @Nullable String p2, int p3, int p4, int p5 )`
`@NonNull int[]`	`checkUriPermissions(@NonNull List<@NonNull Uri> p0, int p1, int p2, int p3)`
`void`	`clearWallpaper()` This method is deprecated. Deprecated in Java
`@NonNull Context`	`createAttributionContext(@Nullable String p0)`
`@NonNull Context`	`createConfigurationContext(@NonNull Configuration p0)`
`@NonNull Context`	`createContext(@NonNull ContextParams p0)`
`@NonNull Context`	`createContextForSplit(@NonNull String p0)`
`@NonNull Context`	`createDeviceContext(int p0)`
`@NonNull Context`	`createDeviceProtectedStorageContext()`
`@NonNull Context`	`createDisplayContext(@NonNull Display p0)`
`@NonNull Context`	`createPackageContext(@NonNull String p0, int p1)`
`@NonNull Context`	`createWindowContext(int p0, @Nullable Bundle p1)`
`@NonNull Context`	`createWindowContext(@NonNull Display p0, int p1, @Nullable Bundle p2)`
`@NonNull String[]`	`databaseList()`
`boolean`	`deleteDatabase(@NonNull String p0)`
`boolean`	`deleteFile(@NonNull String p0)`
`boolean`	`deleteSharedPreferences(@NonNull String p0)`
`void`	`enforceCallingOrSelfPermission(@NonNull String p0, @Nullable String p1)`
`void`	`enforceCallingOrSelfUriPermission( @NonNull Uri p0, int p1, @NonNull String p2 )`
`void`	`enforceCallingPermission(@NonNull String p0, @Nullable String p1)`
`void`	`enforceCallingUriPermission(@NonNull Uri p0, int p1, @NonNull String p2)`
`void`	`enforcePermission(@NonNull String p0, int p1, int p2, @Nullable String p3)`
`void`	`enforceUriPermission( @NonNull Uri p0, int p1, int p2, int p3, @NonNull String p4 )`
`void`	`enforceUriPermission( @Nullable Uri p0, @Nullable String p1, @Nullable String p2, int p3, int p4, int p5, @Nullable String p6 )`
`@NonNull String[]`	`fileList()`
`@NonNull Context`	`getApplicationContext()`
`@NonNull ApplicationInfo`	`getApplicationInfo()`
`@NonNull AssetManager`	`getAssets()`
`@NonNull AttributionSource`	`getAttributionSource()`
`@Nullable String`	`getAttributionTag()`
`@NonNull Context`	`getBaseContext()`
`@NonNull File`	`getCacheDir()`
`@NonNull ClassLoader`	`getClassLoader()`
`@NonNull File`	`getCodeCacheDir()`
`@NonNull ContentResolver`	`getContentResolver()`
`@NonNull File`	`getDataDir()`
`@NonNull File`	`getDatabasePath(@NonNull String p0)`
`int`	`getDeviceId()`
`@NonNull File`	`getDir(@NonNull String p0, int p1)`
`@Nullable Display`	`getDisplay()`
`@Nullable File`	`getExternalCacheDir()`
`@NonNull File[]`	`getExternalCacheDirs()`
`@Nullable File`	`getExternalFilesDir(@Nullable String p0)`
`@NonNull File[]`	`getExternalFilesDirs(@NonNull String p0)`
`@NonNull File[]`	`getExternalMediaDirs()`
`@NonNull File`	`getFileStreamPath(@NonNull String p0)`
`@NonNull File`	`getFilesDir()`
`@NonNull Executor`	`getMainExecutor()`
`@NonNull Looper`	`getMainLooper()`
`@NonNull File`	`getNoBackupFilesDir()`
`@NonNull File`	`getObbDir()`
`@NonNull File[]`	`getObbDirs()`
`@NonNull String`	`getOpPackageName()`
`@NonNull String`	`getPackageCodePath()`
`@NonNull PackageManager`	`getPackageManager()`
`@NonNull String`	`getPackageName()`
`@NonNull String`	`getPackageResourcePath()`
`@Nullable ContextParams`	`getParams()`
`@NonNull Resources`	`getResources()`
`@NonNull SharedPreferences`	`getSharedPreferences(@NonNull String p0, int p1)`
`@NonNull Object`	`getSystemService(@NonNull String p0)`
`String`	`getSystemServiceName(@NonNull Class<@NonNull ?> p0)`
`@NonNull Resources.Theme`	`getTheme()`
`@NonNull Drawable`	`getWallpaper()` This method is deprecated. Deprecated in Java
`int`	`getWallpaperDesiredMinimumHeight()` This method is deprecated. Deprecated in Java
`int`	`getWallpaperDesiredMinimumWidth()` This method is deprecated. Deprecated in Java
`void`	`grantUriPermission(@NonNull String p0, @NonNull Uri p1, int p2)`
`boolean`	`isDeviceProtectedStorage()`
`boolean`	`isRestricted()`
`boolean`	`isUiContext()`
`boolean`	`moveDatabaseFrom(@NonNull Context p0, @NonNull String p1)`
`boolean`	`moveSharedPreferencesFrom(@NonNull Context p0, @NonNull String p1)`
`@NonNull FileInputStream`	`openFileInput(@NonNull String p0)`
`@NonNull FileOutputStream`	`openFileOutput(@NonNull String p0, int p1)`
`@NonNull SQLiteDatabase`	`openOrCreateDatabase( @NonNull String p0, int p1, @NonNull SQLiteDatabase.CursorFactory p2 )`
`@NonNull SQLiteDatabase`	`openOrCreateDatabase( @NonNull String p0, int p1, @NonNull SQLiteDatabase.CursorFactory p2, @Nullable DatabaseErrorHandler p3 )`
`@NonNull Drawable`	`peekWallpaper()` This method is deprecated. Deprecated in Java
`void`	`registerComponentCallbacks(@NonNull ComponentCallbacks p0)`
`void`	`registerDeviceIdChangeListener( @NonNull Executor p0, @NonNull IntConsumer p1 )`
`Intent`	`registerReceiver(@Nullable BroadcastReceiver p0, @NonNull IntentFilter p1)`
`Intent`	`registerReceiver( @Nullable BroadcastReceiver p0, @NonNull IntentFilter p1, int p2 )`
`Intent`	`registerReceiver( @Nullable BroadcastReceiver p0, @NonNull IntentFilter p1, @Nullable String p2, @Nullable Handler p3 )`
`Intent`	`registerReceiver( @Nullable BroadcastReceiver p0, @NonNull IntentFilter p1, @Nullable String p2, @Nullable Handler p3, int p4 )`
`void`	`removeStickyBroadcast(@NonNull Intent p0)` This method is deprecated. Deprecated in Java
`void`	`removeStickyBroadcastAsUser(@NonNull Intent p0, @NonNull UserHandle p1)` This method is deprecated. Deprecated in Java
`void`	`revokeSelfPermissionsOnKill(@NonNull Collection<@NonNull String> p0)`
`void`	`revokeUriPermission(@NonNull Uri p0, int p1)`
`void`	`revokeUriPermission(@NonNull String p0, @NonNull Uri p1, int p2)`
`void`	`sendBroadcast(@NonNull Intent p0)`
`void`	`sendBroadcast(@NonNull Intent p0, @Nullable String p1)`
`void`	`sendBroadcast(@NonNull Intent p0, @Nullable String p1, @Nullable Bundle p2)`
`void`	`sendBroadcastAsUser(@NonNull Intent p0, @NonNull UserHandle p1)`
`void`	`sendBroadcastAsUser(@NonNull Intent p0, @NonNull UserHandle p1, String p2)`
`void`	`sendOrderedBroadcast(@NonNull Intent p0, @Nullable String p1)`
`void`	`sendOrderedBroadcast( @NonNull Intent p0, @Nullable String p1, @Nullable Bundle p2 )`
`void`	`sendOrderedBroadcast( @NonNull Intent p0, @Nullable String p1, @Nullable BroadcastReceiver p2, @Nullable Handler p3, int p4, @Nullable String p5, @Nullable Bundle p6 )`
`void`	`sendOrderedBroadcast( @NonNull Intent p0, @Nullable String p1, @Nullable Bundle p2, @Nullable BroadcastReceiver p3, @Nullable Handler p4, int p5, @Nullable String p6, @Nullable Bundle p7 )`
`void`	`sendOrderedBroadcast( @NonNull Intent p0, @Nullable String p1, @Nullable String p2, @Nullable BroadcastReceiver p3, @Nullable Handler p4, int p5, @Nullable String p6, @Nullable Bundle p7 )`
`void`	`sendOrderedBroadcast( @NonNull Intent p0, int p1, @Nullable String p2, @Nullable String p3, @Nullable BroadcastReceiver p4, @Nullable Handler p5, @Nullable String p6, @Nullable Bundle p7, @Nullable Bundle p8 )`
`void`	`sendOrderedBroadcastAsUser( @NonNull Intent p0, @NonNull UserHandle p1, @Nullable String p2, @Nullable BroadcastReceiver p3, @Nullable Handler p4, int p5, @Nullable String p6, @Nullable Bundle p7 )`
`void`	`sendStickyBroadcast(@NonNull Intent p0)` This method is deprecated. Deprecated in Java
`void`	`sendStickyBroadcast(@NonNull Intent p0, @Nullable Bundle p1)` This method is deprecated. Deprecated in Java
`void`	`sendStickyBroadcastAsUser(@NonNull Intent p0, @NonNull UserHandle p1)` This method is deprecated. Deprecated in Java
`void`	`sendStickyOrderedBroadcast( @NonNull Intent p0, @Nullable BroadcastReceiver p1, @Nullable Handler p2, int p3, @Nullable String p4, @Nullable Bundle p5 )` This method is deprecated. Deprecated in Java
`void`	`sendStickyOrderedBroadcastAsUser( @NonNull Intent p0, @NonNull UserHandle p1, @Nullable BroadcastReceiver p2, @Nullable Handler p3, int p4, @Nullable String p5, @Nullable Bundle p6 )` This method is deprecated. Deprecated in Java
`void`	`setTheme(int p0)`
`void`	`setWallpaper(@NonNull Bitmap p0)` This method is deprecated. Deprecated in Java
`void`	`setWallpaper(@NonNull InputStream p0)` This method is deprecated. Deprecated in Java
`void`	`startActivities(@NonNull Intent[] p0)`
`void`	`startActivities(@NonNull Intent[] p0, @Nullable Bundle p1)`
`void`	`startActivity(@NonNull Intent p0)`
`void`	`startActivity(@NonNull Intent p0, @Nullable Bundle p1)`
`@Nullable ComponentName`	`startForegroundService(@NonNull Intent p0)`
`boolean`	`startInstrumentation( @NonNull ComponentName p0, @Nullable String p1, @Nullable Bundle p2 )`
`void`	`startIntentSender( @NonNull IntentSender p0, @Nullable Intent p1, int p2, int p3, int p4 )`
`void`	`startIntentSender( @NonNull IntentSender p0, @Nullable Intent p1, int p2, int p3, int p4, @Nullable Bundle p5 )`
`@Nullable ComponentName`	`startService(@NonNull Intent p0)`
`boolean`	`stopService(@NonNull Intent p0)`
`void`	`unbindService(@NonNull ServiceConnection p0)`
`void`	`unregisterComponentCallbacks(@NonNull ComponentCallbacks p0)`
`void`	`unregisterDeviceIdChangeListener(@NonNull IntConsumer p0)`
`void`	`unregisterReceiver(@NonNull BroadcastReceiver p0)`
`void`	`updateServiceGroup(@NonNull ServiceConnection p0, int p1, int p2)`

From android.app.Service

`void`	`attachBaseContext(@NonNull Context p0)`
`void`	`dump( @NonNull FileDescriptor p0, @NonNull PrintWriter p1, @NonNull String[] p2 )`
`final @NonNull Application`	`getApplication()`
`final int`	`getForegroundServiceType()`
`void`	`onConfigurationChanged(@NonNull Configuration p0)`
`void`	`onCreate()`
`void`	`onDestroy()`
`void`	`onLowMemory()` This method is deprecated.
`void`	`onRebind(@NonNull Intent p0)`
`void`	`onStart(@NonNull Intent p0, int p1)` This method is deprecated. Deprecated in Java
`int`	`onStartCommand(@NonNull Intent p0, int p1, int p2)`
`void`	`onTaskRemoved(@NonNull Intent p0)`
`void`	`onTimeout(int p0)`
`void`	`onTimeout(int p0, int p1)`
`void`	`onTrimMemory(int p0)`
`boolean`	`onUnbind(@NonNull Intent p0)`
`final void`	`startForeground(int p0, @NonNull Notification p1)`
`final void`	`startForeground(int p0, @NonNull Notification p1, int p2)`
`final void`	`stopForeground(boolean p0)` This method is deprecated. Deprecated in Java
`final void`	`stopForeground(int p0)`
`final void`	`stopSelf()`
`final void`	`stopSelf(int p0)`
`final boolean`	`stopSelfResult(int p0)`

Public constructors

CredentialProviderEventsService

Added in 1.0.0-alpha01

public CredentialProviderEventsService()

Public methods

onBind

Added in 1.0.0-alpha01

public IBinder onBind(Intent intent)

onCreateCredentialRequest

Added in 1.0.0-alpha01

public void onCreateCredentialRequest(
    @NonNull ProviderCreateCredentialRequest request,
    @NonNull CancellationSignal cancellationSignal,
    @NonNull OutcomeReceiverCompat<@NonNull CreateCredentialResponse, @NonNull CreateCredentialException> callback
)

Called when a credential provider should create a credential.

This method should be extended by credential providers to receive credential creation requests. Note that for now, a credential provider will only receive conditional passkey creation requests through this endpoint (after certain internal conditions are met), and all other regular credential creation requests will still come through CredentialProviderService.onBeginCreateCredential API.

The difference between CredentialProviderService.onBeginCreateCredential and this API is that in the former, providers return entries that are shown on the UI, whereas in this one, providers simply create the passkey and return the response.

Because there is no UI from the system in the conditional passkey creation flow, it is required that providers fulfill certain conditions before creating the passkey:

Check that the user has a credential stored with the provider already that has been recently used.
Show a notification to notify the user after creating the passkey.

Note that the credential provider must be selected as the preferred service for them to receive the conditional passkey create request. When they do receive the request, they must check if the request is of type androidx.credentials.CreatePublicKeyCredentialRequest and that androidx.credentials.CreatePublicKeyCredentialRequest.isConditional is set to true.

Parameters
`@NonNull ProviderCreateCredentialRequest request`	The request for creating a credential.
`@NonNull CancellationSignal cancellationSignal`	A signal to cancel the operation.
`@NonNull OutcomeReceiverCompat<@NonNull CreateCredentialResponse, @NonNull CreateCredentialException> callback`	The callback to receive the result of the credential creation.