public final class AuthenticationSDK extends MobileSDK
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
EXTRA_ERROR_CODE |
static java.lang.String |
EXTRA_ERROR_MESSAGE |
static java.lang.String |
EXTRA_SCAN_DATA |
static java.lang.String |
EXTRA_TRANSACTION_REFERENCE |
static int |
REQUEST_CODE |
Modifier and Type | Method and Description |
---|---|
void |
checkDeallocation(AuthenticationDeallocationCallback deallocationCallback)
Assign a callback to be notified as soon as the SDK is fully deallocated
|
static AuthenticationSDK |
create(android.app.Activity rootActivity,
java.lang.String apiToken,
java.lang.String apiSecret,
JumioDataCenter dataCenter)
Creates an authentication instance
|
void |
destroy()
Destroys the instance and frees all resources
|
static java.lang.String |
getDebugID()
Obtains the Jumio Analytics session ID if one already exists.
|
android.content.Intent |
getIntent()
Returns the intent to start the SDK activity
|
void |
initiate(AuthenticationCallback loadingCallback)
The result of the initiate is delivered in the
AuthenticationCallback . |
static boolean |
isSupportedPlatform(android.content.Context context)
Checks if the device platform is supported by the sdk
|
void |
setAuthenticationTransactionReference(java.lang.String authenticationTransactionReference)
Authentication transaction which has been created via the facemap server to server API
|
void |
setCallbackUrl(java.lang.String callbackUrl)
Callback URL (max.
|
void |
setEnrollmentTransactionReference(java.lang.String enrollmentTransactionReference)
The scan reference of an eligible Netverify scan has to be used as the enrollmentTransactionReference
|
void |
setUserReference(java.lang.String userReference)
Specifies how the user is registered on your system.
|
void |
start()
Starts the scan.
|
AuthenticationCustomSDKController |
start(AuthenticationCustomSDKInterface authenticationCustomSDKInterface)
Starts a custom scan.
|
getMissingPermissions, getRequiredPermissions, getSDKVersion, hasAllRequiredPermissions, hasPermissionsFor, isRooted, setCustomTheme
public static final java.lang.String EXTRA_TRANSACTION_REFERENCE
public static final java.lang.String EXTRA_SCAN_DATA
public static final java.lang.String EXTRA_ERROR_MESSAGE
public static final java.lang.String EXTRA_ERROR_CODE
public static final int REQUEST_CODE
public static AuthenticationSDK create(android.app.Activity rootActivity, java.lang.String apiToken, java.lang.String apiSecret, JumioDataCenter dataCenter) throws PlatformNotSupportedException, java.lang.NullPointerException
rootActivity
- activity which starts the authenticationapiToken
- The API token of your Jumio merchant accountapiSecret
- The corresponding API secretdataCenter
- Select the JumioDataCenter (US, EU)PlatformNotSupportedException
- if the current platform is not supported by the sdkjava.lang.NullPointerException
- the provided rootActivity must not be nullpublic static boolean isSupportedPlatform(android.content.Context context)
public static java.lang.String getDebugID()
public void destroy()
public void checkDeallocation(AuthenticationDeallocationCallback deallocationCallback)
deallocationCallback
- a AuthenticationDeallocationCallback
instancepublic void setUserReference(java.lang.String userReference)
userReference
- user referencepublic void setCallbackUrl(java.lang.String callbackUrl)
callbackUrl
- custom callback urlpublic void setEnrollmentTransactionReference(java.lang.String enrollmentTransactionReference)
enrollmentTransactionReference
- public void setAuthenticationTransactionReference(java.lang.String authenticationTransactionReference)
authenticationTransactionReference
- public void initiate(AuthenticationCallback loadingCallback) throws MissingPermissionException, java.lang.IllegalArgumentException
AuthenticationCallback
. In case of success, the SDK can be started.MissingPermissionException
- if any of the required permissions is not grantedjava.lang.IllegalArgumentException
- if the callback is nullpublic void start() throws MissingPermissionException, java.lang.RuntimeException
start
in class MobileSDK
MissingPermissionException
- if any of the required permissions is not grantedjava.lang.RuntimeException
- in case the initiate was not successfulpublic AuthenticationCustomSDKController start(AuthenticationCustomSDKInterface authenticationCustomSDKInterface) throws MissingPermissionException, java.lang.RuntimeException
authenticationCustomSDKInterface
- - implementation of the CustomScanInterfaceAuthenticationCustomSDKController
MissingPermissionException
- if any of the required permissions is not grantedjava.lang.RuntimeException
- in case the initiate was not successfulpublic android.content.Intent getIntent() throws MissingPermissionException, java.lang.RuntimeException
MissingPermissionException
- if any of the required permissions is not grantedjava.lang.RuntimeException
- in case the initiate was not successful© Jumio Corp. 268 Lambert Avenue, Palo Alto, CA 94306
The source code and software available on this website (“Software”) is provided by Jumio Corp. or its affiliated group
companies (“Jumio”) "as is” and any express or implied warranties, including, but not limited to, the implied warranties of
merchantability and fitness for a particular purpose are disclaimed. In no event shall Jumio be liable for any direct, indirect,
incidental, special, exemplary, or consequential damages (including but not limited to procurement of substitute goods or
services, loss of use, data, profits, or business interruption) however caused and on any theory of liability, whether in contract,
strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this Software, even if advised of the
possibility of such damage. In any case, your use of this Software is subject to the terms and conditions that apply to your
contractual relationship with Jumio. As regards Jumio’s privacy practices, please see our privacy notice available here: Privacy Policy.