com.microsoft.identity.client

Interface IPublicClientApplication.DeviceCodeFlowCallback

Enclosing interface:

IPublicClientApplication

public static interface IPublicClientApplication.DeviceCodeFlowCallback

Callback object used in Device Code Flow. This callback provides the following methods for communicating with the protocol. 1). Receiving authentication information (user_code, verification_uri, and instruction message) via onUserCodeReceived(String, String, String, Date). 2). Receiving a successful authentication result containing a fresh access token via onTokenReceived(AuthenticationResult). 3). Receiving an exception detailing what went wrong in the protocol via onError(MsalException).

Refer to IPublicClientApplication.acquireTokenWithDeviceCode(String[], DeviceCodeFlowCallback).

Method Summary

Modifier and Type	Method and Description
void	onError(MsalException error) Invoked if an error is encountered during the device code flow and passes the exception object.
void	onTokenReceived(AuthenticationResult authResult) Invoked once token is received and passes the AuthenticationResult object.
void	onUserCodeReceived(java.lang.String vUri, java.lang.String userCode, java.lang.String message, java.util.Date sessionExpirationDate) Invoked to display verification uri, user code, and instruction message during device code flow.

Method Detail

onUserCodeReceived

void onUserCodeReceived(java.lang.String vUri,
                        java.lang.String userCode,
                        java.lang.String message,
                        java.util.Date sessionExpirationDate)

Invoked to display verification uri, user code, and instruction message during device code flow.

Parameters:

vUri - verification uri

userCode - user code

message - instruction message

sessionExpirationDate - the expiration date of DCF session to be displayed to the user ONLY. When the session expires, onError() will return an exception with DEVICE_CODE_FLOW_EXPIRED_TOKEN_ERROR_CODE. Please rely on that exception for non-UX purposes.

onTokenReceived

void onTokenReceived(AuthenticationResult authResult)

Invoked once token is received and passes the AuthenticationResult object.

Parameters:

authResult - the authentication result

onError

void onError(MsalException error)

Invoked if an error is encountered during the device code flow and passes the exception object.

Parameters:

error - error exception