RemoteEntry

Artifact: androidx.credentials:credentials

View Source

Added in 1.2.0

---

Kotlin |Java

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
NullPointerException	If pendingIntent is null

Summary

Nested types
class RemoteEntry.Builder A builder for RemoteEntry

Public companion functions
RemoteEntry?	fromRemoteEntry(remoteEntry: RemoteEntry) Converts a framework android.service.credentials.RemoteEntry class to a Jetpack RemoteEntry class

Public constructors
RemoteEntry(pendingIntent: PendingIntent) constructs an instance of RemoteEntry

Public functions
open operator Boolean	equals(other: Any?)
open Int	hashCode()

Public properties
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

Public companion functions

fromRemoteEntry

Added in 1.3.0

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

Added in 1.2.0

RemoteEntry(pendingIntent: PendingIntent)

constructs an instance of RemoteEntry

Parameters
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

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

Public properties

pendingIntent

Added in 1.2.0

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