com.box.androidsdk.content.auth

Interface BoxAuthentication.AuthenticationRefreshProvider

Enclosing class:

BoxAuthentication

public static interface BoxAuthentication.AuthenticationRefreshProvider

An interface that should be implemented if using a custom authentication scheme and not the default oauth 2 based token refresh logic.

Method Summary

Modifier and Type	Method and Description
boolean	launchAuthUi(java.lang.String userId, BoxSession session) This method should launch an activity or perform necessary logic in order to authenticate a user for the first time or re-authenticate a user if necessary.
BoxAuthentication.BoxAuthenticationInfo	refreshAuthenticationInfo(BoxAuthentication.BoxAuthenticationInfo info) This method should return a refreshed authentication info object given one that is expired or nearly expired.

Method Detail

refreshAuthenticationInfo

BoxAuthentication.BoxAuthenticationInfo refreshAuthenticationInfo(BoxAuthentication.BoxAuthenticationInfo info)
                                                           throws BoxException

This method should return a refreshed authentication info object given one that is expired or nearly expired.

Parameters:

info - the expired authentication information.

Returns:

a refreshed BoxAuthenticationInfo object. The object must include the valid access token.

Throws:

BoxException - Exception that should be thrown if there was a problem fetching the information.

launchAuthUi

boolean launchAuthUi(java.lang.String userId,
                     BoxSession session)

This method should launch an activity or perform necessary logic in order to authenticate a user for the first time or re-authenticate a user if necessary. Implementers should call BoxAuthenciation.getInstance().onAuthenticated(BoxAuthenticationInfo info, Context context) to complete authentication.

Parameters:

userId - the user id that needs re-authentication if known. For a new user this will be null.

session - the session that is attempting to launch authentication ui.

Returns:

true if the ui is handled, if false the default authentication ui will be shown to authenticate the user.