ID Capture Deserializer Listener

Defined in package com.scandit.datacapture.id.deserializer.capture.serialization

Warning

The deserialization API is not yet stable and will still change over the coming releases.

IdCaptureDeserializerListener

interface IdCaptureDeserializerListener

Added in version 6.6.0

The listener for the id capture deserializer.

A deserialization that reports a failure stops at the failure point, so a Started callback is not always followed by its Finished counterpart. Deserializing a new mode from JSON deserializes the settings before the mode exists, so the settings callbacks fire before OnModeDeserializationStarted; updating an existing mode fires them between the mode callbacks.

onModeDeserializationStarted(deserializer, mode, json)

fun onModeDeserializationStarted(deserializer: IdCaptureDeserializer,
        mode: IdCapture,
        json: JsonValue)

Added in version 6.6.0

Called before the deserialization of id capture started. This is the point to overwrite defaults before the deserialization is performed.

onModeDeserializationFinished(deserializer, mode, json)

fun onModeDeserializationFinished(deserializer: IdCaptureDeserializer,
        mode: IdCapture,
        json: JsonValue)

Added in version 6.6.0

Called when the deserialization of id capture finished. This is the point to do additional deserialization.

onSettingsDeserializationStarted(deserializer, settings, json)

fun onSettingsDeserializationStarted(deserializer: IdCaptureDeserializer,
        settings: IdCaptureSettings,
        json: JsonValue)

Added in version 6.6.0

Called before the deserialization of the id capture settings started. This is the point to overwrite defaults before the deserialization is performed.

onSettingsDeserializationFinished(deserializer, settings, json)

fun onSettingsDeserializationFinished(deserializer: IdCaptureDeserializer,
        settings: IdCaptureSettings,
        json: JsonValue)

Added in version 6.6.0

Called when the deserialization of the id capture settings finished. This is the point to do additional deserialization.

onOverlayDeserializationStarted(deserializer, overlay, json)

fun onOverlayDeserializationStarted(deserializer: IdCaptureDeserializer,
        overlay: IdCaptureOverlay,
        json: JsonValue)

Added in version 6.6.0

Called before the deserialization of the id capture overlay started. This is the point to overwrite defaults before the deserialization is performed.

onOverlayDeserializationFinished(deserializer, overlay, json)

fun onOverlayDeserializationFinished(deserializer: IdCaptureDeserializer,
        overlay: IdCaptureOverlay,
        json: JsonValue)

Added in version 6.6.0

Called when the deserialization of the id capture overlay finished. This is the point to do additional deserialization.