Package com.android.identity

Class DeviceRetrievalHelper.Builder

java.lang.Object

com.android.identity.DeviceRetrievalHelper.Builder

Enclosing class:

DeviceRetrievalHelper

public static class DeviceRetrievalHelper.Builder
extends java.lang.Object

Builder for DeviceRetrievalHelper.

Constructor Summary

Constructors

Constructor	Description
Builder(android.content.Context context, DeviceRetrievalHelper.Listener listener, java.util.concurrent.Executor executor, PresentationSession session)	Create a new Builder for DeviceRetrievalHelper.

Method Summary

Modifier and Type	Method	Description
DeviceRetrievalHelper.Builder	addAlternateForwardEngagement(byte[] deviceEngagement, byte[] handover)	Tells the helper about secondary/alternate engagement mechanisms.
DeviceRetrievalHelper	build()	Builds the DeviceRetrievalHelper and starts presentation.
DeviceRetrievalHelper.Builder	useForwardEngagement(DataTransport transport, byte[] deviceEngagement, byte[] handover)	Configures the helper to use normal engagement.
DeviceRetrievalHelper.Builder	useReverseEngagement(DataTransport transport, byte[] readerEngagement, java.util.List<OriginInfo> originInfos)	Configures the helper to use reverse engagement.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(@NonNull
               android.content.Context context,
               @Nullable
               DeviceRetrievalHelper.Listener listener,
               @Nullable
               java.util.concurrent.Executor executor,
               @NonNull
               PresentationSession session)

Create a new Builder for DeviceRetrievalHelper.

Use useForwardEngagement(DataTransport, byte[], byte[]) or useReverseEngagement(DataTransport, byte[], List) to specifiy which kind of engagement will be used. At least one of these must be used.

Parameters:

context - The context.

listener - the listener or null to stop listening.

executor - a Executor to do the call in or null if listener is null.

session - a PresentationSession.

Throws:

java.lang.IllegalStateException - if Executor is null for a non-null listener.

Method Detail

useForwardEngagement

@NonNull
public DeviceRetrievalHelper.Builder useForwardEngagement(@NonNull
                                                          DataTransport transport,
                                                          @NonNull
                                                          byte[] deviceEngagement,
                                                          @NonNull
                                                          byte[] handover)

Configures the helper to use normal engagement.

Applications can use this together with QrEngagementHelper and NfcEngagementHelper.

Parameters:

transport - the transport the mdoc reader used to connect with.

deviceEngagement - the bytes of the DeviceEngagement CBOR.

handover - the bytes of the Handover CBOR.

Returns:

the builder.

addAlternateForwardEngagement

@NonNull
public DeviceRetrievalHelper.Builder addAlternateForwardEngagement(@Nullable
                                                                   byte[] deviceEngagement,
                                                                   @Nullable
                                                                   byte[] handover)

Tells the helper about secondary/alternate engagement mechanisms.

This is useful if using multiple forward engagement mechanisms at the same time, for example QR and NFC.

Parameters:

deviceEngagement - the bytes of the DeviceEngagement CBOR.

handover - the bytes of the Handover CBOR.

Returns:

the builder

useReverseEngagement

@NonNull
public DeviceRetrievalHelper.Builder useReverseEngagement(@NonNull
                                                          DataTransport transport,
                                                          @Nullable
                                                          byte[] readerEngagement,
                                                          java.util.List<OriginInfo> originInfos)

Configures the helper to use reverse engagement.

Parameters:

transport - the transport to use.

readerEngagement - the bytes of the ReaderEngagement CBOR.

originInfos - a set of origin infos describing how reader engagement was obtained.

Returns:

the builder.

build

@NonNull
public DeviceRetrievalHelper build()

Builds the DeviceRetrievalHelper and starts presentation.

Returns:

the helper, ready to be used.