blinkid-core/com.microblink.blinkid.core/BlinkIdSdkSettings

BlinkIdSdkSettings

data class BlinkIdSdkSettings @JvmOverloads constructor(val licenseKey: String, val licensee: String? = null, val downloadResources: Boolean = true, val resourceDownloadUrl: String = defaultResourceDownloadUrl, val resourceLocalFolder: String = defaultResourcesLocalFolder, val resourceRequestTimeout: RequestTimeout = RequestTimeout.DEFAULT, val microblinkProxyUrl: String? = null) : Parcelable

Settings for initialization of the BlinkID SDK.

Constructors

BlinkIdSdkSettings

@JvmOverloads

constructor(licenseKey: String, licensee: String? = null, downloadResources: Boolean = true, resourceDownloadUrl: String = defaultResourceDownloadUrl, resourceLocalFolder: String = defaultResourcesLocalFolder, resourceRequestTimeout: RequestTimeout = RequestTimeout.DEFAULT, microblinkProxyUrl: String? = null)

Properties

downloadResources

val downloadResources: Boolean = true

Whether resources required for on-device image processing should be downloaded and cached on first initialization of the SDK. If set to false, you need to package all the required resources in your application's assets.

licensee

val licensee: String? = null

Optional licensee String if the provided license key is not tied to the single application ID.

licenseKey

val licenseKey: String

License key String for the native SDK.

microblinkProxyUrl

val microblinkProxyUrl: String? = null

Set a custom HTTPS URL to be used as a proxy for Ping and license checks. The proxy URL will be applied only if the license has the appropriate rights. The URL must use the HTTPS protocol. Example: https://your-proxy.com/ If this value is defined, SDK initialization will not be successful in the following cases: - if the URL does not use HTTPS or if the URL is invalid (IllegalArgumentException) - if the license does not allow proxy usage (InvalidLicenseException)

resourceDownloadUrl

val resourceDownloadUrl: String

If resources are to be downloaded, the following is the URL where the resources are hosted.

resourceLocalFolder

val resourceLocalFolder: String

Local folder name where resources will be downloaded and cached. If resources are being downloaded, this defines the name of the folder within your application's cache folder where resources will be cached. If resources downloading is disabled, this defines the path in your application's assets where the resources could be found.

resourceRequestTimeout

val resourceRequestTimeout: RequestTimeout

Timeout settings for resource downloads.

Functions

describeContents

abstract fun describeContents(): Int

writeToParcel

abstract fun writeToParcel(p0: Parcel, p1: Int)