BeginGetCredentialResponse.Builder

Builder()

fun addAction(action: Action): BeginGetCredentialResponse.Builder

Adds an Action to the list of actions to be displayed on the UI.

An [Action] must be used for independent user actions, such as opening the app, intenting directly into a certain app activity etc. The pending intent set with the [action] must invoke the corresponding activity.

fun addAuthenticationAction(authenticationAction: AuthenticationAction): BeginGetCredentialResponse.Builder

Add an authentication entry to be shown on the UI. Providers must set this entry if the corresponding account is locked and no underlying credentials can be returned.

When the user selects this [authenticationAction], the system invokes the corresponding pending intent. Once the authentication action activity is launched, and the user is authenticated, providers should create another response with [BeginGetCredentialResponse] using this time adding the unlocked credentials in the form of [CredentialEntry]'s.

The new response object must be set on the authentication activity's result. The result code should be set to [android.app.Activity#RESULT_OK] and the [CredentialProviderService#EXTRA_BEGIN_GET_CREDENTIAL_RESPONSE] extra should be set with the new fully populated [BeginGetCredentialResponse] object.

fun addCredentialEntry(entry: CredentialEntry): BeginGetCredentialResponse.Builder

Adds a CredentialEntry to the list of entries to be displayed on the UI.

fun build(): BeginGetCredentialResponse

Builds a BeginGetCredentialResponse instance.

fun setActions(actions: List<Action>): BeginGetCredentialResponse.Builder

Sets the list of actions to be displayed on the UI.

fun setAuthenticationActions(
    authenticationEntries: List<AuthenticationAction>
): BeginGetCredentialResponse.Builder

Sets the list of authentication entries to be displayed on the account selector UI.

fun setCredentialEntries(entries: List<CredentialEntry>): BeginGetCredentialResponse.Builder

Sets the list of credential entries to be displayed on the account selector UI.

fun setRemoteEntry(remoteEntry: RemoteEntry?): BeginGetCredentialResponse.Builder

Sets a remote credential entry to be shown on the UI. Provider must set this if they wish to get the credential from a different device.

When constructing the CredentialEntry object, the pending intent must be set such that it leads to an activity that can provide UI to fulfill the request on a remote device. When user selects this remoteEntry, the system will invoke the pending intent set on the CredentialEntry.

Once the remote credential flow is complete, the [android.app.Activity] result should be set to [android.app.Activity#RESULT_OK] and an extra with the [CredentialProviderService#EXTRA_GET_CREDENTIAL_RESPONSE] key should be populated with a [android.credentials.Credential] object.

Note that as a provider service you will only be able to set a remote entry if : - Provider service possesses the [android.Manifest.permission.PROVIDE_REMOTE_CREDENTIALS] permission. - Provider service is configured as the provider that can provide remote entries.

If the above conditions are not met, setting back BeginGetCredentialResponse on the callback from CredentialProviderService#onBeginGetCredential will throw a SecurityException.