io.digified.digified_library.digified

Class Digified

java.lang.Object

io.digified.digified_library.digified.Digified

public class Digified
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
void	cancelCapture() cancelling the capture request (usually will be used if capture timeout passed and you want to allow the user to cancel the capturing request)
void	capture(FragmentManager fragmentManager, int containerId, int captureType, CaptureCallback captureCallback) This method is used to capture images (ID front image, ID back image and Selfie)
void	capture(FragmentManager fragmentManager, int containerId, int captureType, int desiredWidth, int desiredHeight, CaptureCallback captureCallback) This method is used to capture images (ID front image, ID back image and Selfie)
int	getFinalStatus() Use this method to get the final status of the verification process, the final status will be on of those statuses DigifiedConstants.Status
static Digified	getInstance(Context context, String baseUrl, String apiKey) creating Digified object
int	getNextAction() Use this method to get the next action that you should let the user perform based on the predefined sequence in the SDK.
void	initialize(String warningAction, String userName, String phoneNumber, String email, InitializeCallback callback) Performs the init request of the API
void	resetSequence() rests the SDK to the initial stats
void	send(CaptureResult captureResult, FaceMatchCallback faceMatchCallback) Sending the captured selfie image (encapsulated in CaptureResult object) to the API CaptureResult will be obtained after calling capture(FragmentManager, int, int, CaptureCallback) or capture(FragmentManager, int, int, int, int, CaptureCallback)
void	send(CaptureResult captureResult, IdExtractionCallback idExtractionCallback) Sending the captured image of ID front and back (encapsulated in CaptureResult object) to the API CaptureResult will be obtained after calling capture(FragmentManager, int, int, CaptureCallback) or capture(FragmentManager, int, int, int, int, CaptureCallback)
void	setCaptureTimeout(int captureTimeoutMillis) Setting the capture time out, this controls when will CaptureCallback.onTimeout() is called
void	setMaxDimensions(int maxWidth, int maxHeight) Setting the max dimensions of images not to be exceeded after cropping the image (the exact size of the cropped image can't be set to avoid stretching the image)

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static Digified getInstance(Context context,
                                   String baseUrl,
                                   String apiKey)

creating Digified object

Parameters:

context - context

baseUrl - https url of the backend hosting Digified API

apiKey - API Key of the Digified API

Returns:

an instance of Digified Object

setMaxDimensions

public void setMaxDimensions(int maxWidth,
                             int maxHeight)

Setting the max dimensions of images not to be exceeded after cropping the image (the exact size of the cropped image can't be set to avoid stretching the image)

Parameters:

maxWidth - maximum width of the output image

maxHeight - maximum height of the output image

setCaptureTimeout

public void setCaptureTimeout(int captureTimeoutMillis)

Setting the capture time out, this controls when will CaptureCallback.onTimeout() is called

Parameters:

captureTimeoutMillis - time out in milli seconds

getFinalStatus

public int getFinalStatus()

Use this method to get the final status of the verification process, the final status will be on of those statuses DigifiedConstants.Status

Returns:

final status of the verification process

getNextAction

public int getNextAction()

Use this method to get the next action that you should let the user perform based on the predefined sequence in the SDK. Actions can be found here DigifiedConstants.Action

Returns:

the next action to be performed (the us should let the user performs)

resetSequence

public void resetSequence()

rests the SDK to the initial stats

initialize

public void initialize(@Nullable
                       String warningAction,
                       @Nullable
                       String userName,
                       @Nullable
                       String phoneNumber,
                       @Nullable
                       String email,
                       @NonNull
                       InitializeCallback callback)

Performs the init request of the API

Parameters:

warningAction - setting the warning action for the api (optional - set to null if you will not use it)

userName - name of the user (optional - set to if you will not use it)

phoneNumber - user's phone number (optional - set to null if you will not use it)

email - user's email (optional - set to null if you will not use it)

callback - callback interface to let you know the status of the request

capture

public void capture(FragmentManager fragmentManager,
                    int containerId,
                    int captureType,
                    CaptureCallback captureCallback)

This method is used to capture images (ID front image, ID back image and Selfie)

Parameters:

fragmentManager - FragmentManager that will handle the display of the fragments of the SDK

containerId - Resource Id of the view that will be replaced with the capturing fragment

captureType - Specifies what you are capturing (ID Front, ID Back or Selfie) find the types here DigifiedConstants.CaptureType

captureCallback - interface that will let you deal with the capture request

capture

public void capture(FragmentManager fragmentManager,
                    int containerId,
                    int captureType,
                    int desiredWidth,
                    int desiredHeight,
                    CaptureCallback captureCallback)

This method is used to capture images (ID front image, ID back image and Selfie)

Parameters:

fragmentManager - FragmentManager that will handle the display of the fragments of the SDK

containerId - Resource Id of the view that will be replaced with the capturing fragment

captureType - Specifies what you are capturing (ID Front, ID Back or Selfie) find the types here DigifiedConstants.CaptureType

desiredWidth - required image width (not guaranteed in order not to stretch the image, however SDK will not exceed that width)

desiredHeight - required image height (not guaranteed in order not to stretch the image, however SDK will not exceed that height)

captureCallback - interface that will let you deal with the capture request

cancelCapture

public void cancelCapture()

cancelling the capture request (usually will be used if capture timeout passed and you want to allow the user to cancel the capturing request)

send

public void send(CaptureResult captureResult,
                 IdExtractionCallback idExtractionCallback)

Sending the captured image of ID front and back (encapsulated in CaptureResult object) to the API CaptureResult will be obtained after calling capture(FragmentManager, int, int, CaptureCallback) or capture(FragmentManager, int, int, int, int, CaptureCallback)

Parameters:

captureResult - CaptureResult object containing the ID Front or ID Back image

idExtractionCallback - callback interface containing the result of the API call

send

public void send(CaptureResult captureResult,
                 FaceMatchCallback faceMatchCallback)

Sending the captured selfie image (encapsulated in CaptureResult object) to the API CaptureResult will be obtained after calling capture(FragmentManager, int, int, CaptureCallback) or capture(FragmentManager, int, int, int, int, CaptureCallback)

Parameters:

captureResult - CaptureResult object containing the Selfie image

faceMatchCallback - callback interface containing the result of the API call