Text Capture Deserializer

Defined in package com.scandit.datacapture.text.capture.serialization

Warning

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

Note

This deserializer is not thread-safe, subsequent calls for the same settings, mode or overlay have to be called on the same thread.

TextCaptureDeserializer

class TextCaptureDeserializer : DataCaptureModeDeserializer

Added in version 6.3.0

A deserializer to construct text capture from JSON. For most use cases it is enough to use TextCapture.fromJson() which internally uses this deserializer. Using the deserializer gives the advantage of being able to listen to the deserialization events as they happen and potentially influence them. Additionally warnings can be read from the deserializer that would otherwise not be available.

Related topics: Serialization.

TextCaptureDeserializer()

TextCaptureDeserializer()

Added in version 6.3.0

Creates a new deserializer object.

listener

@NonNull TextCaptureDeserializerListener getListener()
void setListener(@NonNull TextCaptureDeserializerListener value)

Added in version 6.3.0

The object informed about deserialization events.

warnings

@NonNull List<@NonNull String> getWarnings()

Added in version 6.3.0

The warnings produced during deserialization, for example which properties were not used during deserialization.

modeFromJson(dataCaptureContext, jsonData)

TextCapture modeFromJson(DataCaptureContext dataCaptureContext,
        @NonNull String jsonData)

Added in version 6.3.0

Deserializes text capture from JSON.

An exception is thrown if the provided JSON does not contain required properties or contains properties of the wrong type.

updateModeFromJson(mode, jsonData)

@NonNull TextCapture updateModeFromJson(@NonNull TextCapture mode,
        @NonNull String jsonData)

Added in version 6.3.0

Takes an existing text capture and updates it by deserializing new or changed properties from JSON. See Updating from JSON for details of how updates are being done.

An exception is thrown if the provided JSON does not contain required properties or contains properties of the wrong type.

settingsFromJson(jsonData)

@NonNull TextCaptureSettings settingsFromJson(@NonNull String jsonData)

Added in version 6.3.0

Deserializes text capture settings from JSON.

An exception is thrown if the provided JSON does not contain required properties or contains properties of the wrong type.

updateSettingsFromJson(settings, jsonData)

@NonNull TextCaptureSettings updateSettingsFromJson(
        @NonNull TextCaptureSettings settings,
        @NonNull String jsonData)

Added in version 6.3.0

Takes existing text capture settings and updates them by deserializing new or changed properties from JSON. See Updating from JSON for details of how updates are being done.

An exception is thrown if the provided JSON does not contain required properties or contains properties of the wrong type.

overlayFromJson(mode, jsonData)

@NonNull TextCaptureOverlay overlayFromJson(@NonNull TextCapture mode,
        @NonNull String jsonData)

Added in version 6.3.0

Deserializes a text capture overlay from JSON.

An exception is thrown if the provided JSON does not contain required properties or contains properties of the wrong type.

updateOverlayFromJson(overlay, jsonData)

@NonNull TextCaptureOverlay updateOverlayFromJson(
        @NonNull TextCaptureOverlay overlay,
        @NonNull String jsonData)

Added in version 6.3.0

Takes an existing text capture overlay and updates it by deserializing new or changed properties from JSON. See Updating from JSON for details of how updates are being done.

An exception is thrown if the provided JSON does not contain required properties or contains properties of the wrong type.