commonMain.net.iriscan.sdk.BiometricSdk.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of biometric-sdk Show documentation

Biometric SDK Kotlin Multiplatform library (android + ios)

There is a newer version: 0.6.0

package net.iriscan.sdk

import net.iriscan.sdk.exception.SdkInitializationException
import net.iriscan.sdk.io.exception.IOException

/**
 * @author Slava Gornostal
 *
 * SDK Interface
 */
interface BiometricSdk {

    fun configBuilder(): BiometricSdkConfigBuilder

    /**
     * Initialized SDK, should be called before using any operations
     * */
    @Throws(SdkInitializationException::class, IOException::class)
    fun initialize(config: BiometricSdkConfig)

    /**
     * Get SDK operations
     *
     * @see BiometricSdkOperations
     * @return sdk operations instance or null if sdk is not yet initialized
     * */
    fun getInstance(): BiometricSdkOperations?
}