Differences

This shows you the differences between two versions of the page.

--- en:fingerprint_api [2018/03/15 15:34]
yjjung [Fingerprint API]
+++ en:fingerprint_api [2018/12/17 08:12]
simba
@@ Line 1: / Line 1: @@
+======Fingerprint API======
+=====scanFingerprint=====
+Request a fingerprint scan on the device.
+<code java>
+int scanFingerprint ()
+</code>
+===Return Code===
+Returns "SUCCESS" if successfully launched; returns the corresponding error code if an error occurs.
+<callout type="info" icon="true">
+The API will return immediately upon starting the fingerprint scanning service and, if a fingerprint scan is detected, the data will be passed on to the DeviceListner::onFingerprintScanCompleted callback listener.\\ The fingerprint scan progress can be checked via DeviceListner::onFingerprintScanProgress.
+</callout>
+\\
+=====cancelScanFingerprint=====
+Request that the device stop the fingerprint scan.
+<code java>
+int cancelScanFingerprint()
+</code>
+===Return Code===
+Returns "SUCCESS" if successfully launched; returns the corresponding error code if an error occurs.
+\\
+=====pauseFingerprintService=====
+Pause the device's fingerprint service.
+<code java>
+int pauseFingerprintService()
+</code>
+===Return Code===
+Returns "SUCCESS" if successfully launched; returns the corresponding error code if an error occurs.
+\\
+=====resumeFingerprintService=====
+Resume the device's fingerprint service.
+<code java>
+int resumeFingerprintService()
+</code>
+===Return Code===
+Returns "SUCCESS" if successfully launched; returns the corresponding error code if an error occurs.
+\\
+=====verifyFingerprint=====
+Compare the fingerprint template data to see if they have the same fingerprint.
+It is recommended for 1:1 fingerprint authentication requests.
+<code java>
+int verifyFingerprint(FingerList userFingers, Finger scanFinger)
+</code>
+===Parameters===
+  * ''userFingers'': list of fingerprint information for a specific user
+  * ''scanFinger'': (In) — scanned user fingerprint information requiring comparison; (Out) — successfully authenticated fingerprint information
+===Return Code===
+Returns "SUCCESS" if the fingerprints are identical; returns the corresponding error code if an error occurs.
+\\ \\
+<code java>
+int verifyFingerprint(Finger userFinger, Finger scanFinger)
+</code>
+===Parameters===
+  * ''userFinger'': fingerprint information for a specific user
+  * ''scanFinger'': (In) — scanned user fingerprint information requiring comparison; (Out) — successfully authenticated fingerprint information
+===Return Code===
+Returns "SUCCESS" if the fingerprints are identical; returns the corresponding error code if an error occurs.
+<callout type="info">
+[[references#Finger|Refer to Finger Class]]\\
+[[references#FingerList|Refer to FingerList Class]]
+</callout>
+<callout type="info" icon="true">
+The scanFinger parameter is generated and sent to the fingerprint template input by [[fingerprint_api # scanFingerprint]].\\  If verifyFingerprint is successful, the scanFinger id, index and isUpdated values are updated and delivered.\\ isUpdated means that you need to update the fingerprint template of the successfully authenticated user.\\ When isUpdated is activated, updating the user's fingerprint template of the application can maintain the authentication performance of the Suprema device at an optimal level.
+</callout>
+\\
+=====isSameFingerprint=====
+Compare two pieces of fingerprint template data with each other to see if they have the same fingerprint.
+<code java>
+int isSameFingerprint(FingerprintTemplate template1, FingerprintTemplate template2)
+</code>
+===Parameters===
+  * ''template1'': fingerprint template 1
+  * ''template2'': fingerprint template 2
+<callout type="info">
+[[references#FingerprintTemplate|Refer to FingerprintTemplate Class]]\\
+</callout>
+===Return Code===
+Returns "SUCCESS" if the fingerprints are identical; returns the corresponding error code if an error occurs.
+\\
+=====setFingerList=====
+Deliver the fingerprint information template data to be used for 1:N fingerprint authentication. It is used to set the fingerprint information for all users enrolled for the first time in the SDK after running the application.
+<code java>
+int setFingerList(FingerList fingerList)
+</code>
+===Parameters===
+  * ''fingerList'': List of fingerprint templates
+<callout type="info">
+[[references#FingerList|Refer to FingerList Class]]
+</callout>
+===Return Code===
+Returns "SUCCESS" if successfully launched; returns the corresponding error code if an error occurs.
+\\
+=====insertFinger=====
+Add the fingerprint information to be used for 1:N fingerprint authentication.
+<code java>
+int insertFinger(Finger finger)
+</code>
+===Parameters===
+  * ''finger'': fingerprint information
+<callout type="info">
+[[references#Finger|Refer to Finger Class]]
+</callout>
+===Return Code===
+Returns "SUCCESS" if successfully launched; returns the corresponding error code if an error occurs.
+\\
+=====updateFinger=====
+Update the fingerprint information to be used for 1:N fingerprint authentication.
+<code java>
+int updateFinger(Finger finger)
+</code>
+===Parameters===
+  * ''finger'': fingerprint information
+<callout type="info">
+[[references#Finger|Refer to Finger Class]]
+</callout>
+===Return Code===
+Returns "SUCCESS" if successfully launched; returns the corresponding error code if an error occurs.
+\\
+=====deleteFinger=====
+Delete the fingerprint information to be used for 1:N fingerprint authentication.
+<code java>
+int deleteFinger(Finger finger)
+</code>
+===Parameters===
+  * ''finger'': fingerprint information
+<callout type="info">
+[[references#Finger|Refer to Finger Class]]
+</callout>
+===Return Code===
+Returns "SUCCESS" if successfully launched; returns the corresponding error code if an error occurs.
+\\
+=====deleteAllFingers=====
+Deletes all fingerprint information to be used for 1:N fingerprint authentication.
+<code java>
+int deleteAllFingers()
+</code>
+===Return Code===
+Returns "SUCCESS" if successfully launched; returns the corresponding error code if an error occurs.