RemoteEntry
class RemoteEntry
An entry on the selector, denoting that the credential request will be completed on a remote device.
Once this entry is selected, the corresponding pendingIntent will be invoked. The provider can then show any activity they wish to while establishing a connection with a different device and retrieving a credential. Before finishing the activity, provider must set the final androidx.credentials.GetCredentialResponse through the PendingIntentHandler.setGetCredentialResponse helper API, or a androidx.credentials.CreateCredentialResponse through the PendingIntentHandler.setCreateCredentialResponse helper API depending on whether it is a get or create flow.
See android.service.credentials.BeginGetCredentialResponse for usage details.
| Throws | |
|---|---|
kotlin.NullPointerException |
If |
Summary
Nested types |
|---|
class RemoteEntry.BuilderA builder for |
Public companion functions |
|
|---|---|
RemoteEntry? |
fromRemoteEntry(remoteEntry: RemoteEntry)Converts a framework |
Public constructors |
|---|
RemoteEntry(pendingIntent: PendingIntent)constructs an instance of |
Public properties |
|
|---|---|
PendingIntent |
the |
Public companion functions
fromRemoteEntry
fun fromRemoteEntry(remoteEntry: RemoteEntry): RemoteEntry?
Converts a framework android.service.credentials.RemoteEntry class to a Jetpack RemoteEntry class
Note that this API is not needed in a general credential creation/retrieval flow that is implemented using this jetpack library, where you are only required to construct an instance of RemoteEntry to populate the BeginGetCredentialResponse or BeginCreateCredentialResponse.
| Parameters | |
|---|---|
remoteEntry: RemoteEntry |
the instance of framework action class to be converted |
Public constructors
RemoteEntry
RemoteEntry(pendingIntent: PendingIntent)
constructs an instance of RemoteEntry
| Parameters | |
|---|---|
pendingIntent: PendingIntent |
the |
Public properties
pendingIntent
val pendingIntent: PendingIntent
the PendingIntent that will get invoked when the user selects this authentication entry on the UI, must be created with flag PendingIntent.FLAG_MUTABLE so that the system can add the complete request to the extras of the associated intent