==========
[fingerprint.basic]
==========

FingerPrint(Basic) 제품에 대한 필수 API 를 정의


------------------------------------
FingerPrint(Basic) API
------------------------------------

FingerPrint(Basic) 제품에 대한 3rd Party연동 기능을 제공한다.

안드로이드 6.0 이상 디바이스에서 동작하며, 하위버전의 경우, 지문 인증 사용 가능 여부 체크 API 호출시, NOT SUPPORT 처리 됩니다.

.. warning::  지문 인증은 내부적으로 암호화하여 작동하나, 클라이언트 단독으로 작동하므로, 보안이 필수인 경우는 3rd party 인증 제품을 사용하시기 바랍니다.

.. _statusType:

status Type
------------


============  ===================
Type          Description             
============  ===================
PROCESSING    	진행 중
SUCCESS    		정상 처리됨
FAIL     		처리 중 문제가 발생함
============  ===================



프로젝트 설정 (ver 2.1.0.6 이상)
--------------------------------------------------------
		FingerPrint(Basic) 2.1.0.6 이상버전은 AndroidX 버전으로 변환 후, 지원됩니다.
		아래 순서대로, 프로젝트를 변경 후, 적용하시기 바랍니다.

		   .. code-block:: javascript
		      
		      1. AndroidX 로 변환
		      2. gradle.properties 생성 및 코드 추가 
		      3. build.gradle dependencies 선언  



		1. AndroidX 로 변환

		.. note:: 
		  - 프로젝트를 AndroidX로 변환해야 합니다.
			
			`AndroidX로 변환 가이드 <https://developer.android.com/jetpack/androidx/migrate?hl=ko#prerequisites>`_ 

		  - AndroidX 프로젝트로 변환 시, AndroidManifest.xml 의 FileProvider 선언부분 변경 필요

			`AndroidX 적용 FileProvider <https://docs.morpheus.co.kr/client/android_ref/android.html#androidx>`_


		2. Project Root 에, gradle.properties 생성 및 아래 코드 추가 
			
		    .. code-block:: javascript
				
		        android.enableJetifier=true
		        android.useAndroidX=true

		3. build.gradle에 biometric 라이브러리 추가 

		    .. code-block:: javascript

		        dependencies {
		            implementation fileTree(dir: 'mcoreLibs', include: '*.jar', excludes: ['android-support-v4.jar', 'universal-image-loader.jar' ])

		            implementation 'androidx.legacy:legacy-support-v4:1.0.0'
		            implementation "androidx.biometric:biometric:1.1.0"
		        }

		4. 체크 사항 


		   가. AndroidManifest.xml 에 Activity 선언 
	    
		    .. code-block:: javascript

			 	<activity
					android:theme="@style/BioTranslucent.NoTitleBar"
					android:name="m.client.library.plugin.thirdparty.fingerprint.basic.BiometricActivity"
					android:configChanges="locale|keyboardHidden|orientation|screenSize"></activity>


		   나. permission 선언 	

		    .. code-block:: javascript

				<manifest.xml>
					<uses-permission android:name="android.permission.USE_FINGERPRINT"/>
					<uses-permission android:name="android.permission.USE_BIOMETRIC"/>
				</manifest>




지문 인증  
--------------

.. js:function:: M.plugin('3rd_fingerprint_basic').auth( setting )

	.. versionchanged:: 1.0.0
	
	:param Object setting: 설정 정보
	:param Function setting.callback: 결과 콜백 함수
	
	.. js:function:: callback(status, result)
		
		:param String status: API 호출에 대한 결과값 (SUCCESS / FAIL / PROCESSING)
		:param Object result.result: 3rd Party 모듈 수행 결과 값 (SUCCESS / FAIL)
		:param String result.message: 3rd Party 모듈 수행에 에러가 있을 경우 에러 메시지


Example:

    .. code-block:: javascript
        
        M.plugin('3rd_fingerprint_basic').auth({
	        callback:function(status, result) {
	            alert(JSON.stringify(result));
	        }
	});
		

지문 인증 사용 가능 여부 체크 
--------------

.. js:function:: M.plugin('3rd_fingerprint_basic').check()
	
	.. versionchanged:: 1.0.0
	
	.. js:function:: return
		
		:param String status: API 호출에 대한 결과값
		:param Object result.result: 3rd Party 모듈 수행 결과 값   
		:param String result.message: 3rd Party 모듈 수행에 에러가 있을 경우 에러 메시지


Example:

    * 동기 방식

    .. code-block:: javascript
        
        var result = M.plugin('3rd_fingerprint_basic').check();


    * 비동기 방식
	
    .. code-block:: javascript
        
        M.plugin('3rd_fingerprint_basic').check({
        	callback:function(status,result){
        		console.log(status + JSON.stringify(result));
        	}
        });


지문 설정 화면으로 이동 
--------------

.. js:function:: M.plugin('3rd_fingerprint_basic').moveSetting()

	.. versionchanged:: 1.0.0

	.. js:function:: return
		
		:param String status: API 호출에 대한 결과값


Example:

    .. code-block:: javascript
        
        var result = M.plugin('3rd_fingerprint_basic').moveSetting();