Label Capture Deserializer
Defined in framework ScanditLabelCapture
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.
- LabelCaptureDeserializer
open class LabelCaptureDeserializer : NSObject, DataCaptureModeDeserializer
Added in version 6.4.0
A deserializer to construct label capture from JSON. For most use cases it is enough to use LabelCapture.init() 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.
- init
init()
Added in version 6.4.0
Creates a new deserializer object.
- delegate
open weak var delegate: LabelCaptureDeserializerDelegate? { get, set }
Added in version 6.4.0
The object informed about deserialization events.
- warnings
open var warnings: Array<String> { get }
Added in version 6.4.0
The warnings produced during deserialization, for example which properties were not used during deserialization.
- mode
open func mode(fromJSONString JSONString: String, with context: DataCaptureContext) throws -> LabelCapture
Added in version 6.4.0
Deserializes label capture from JSON.
An error is set if the provided JSON does not contain required properties or contains properties of the wrong type.
- updateMode
open func updateMode(_ labelCapture: LabelCapture, fromJSONString JSONString: String) throws -> LabelCapture
Added in version 6.4.0
Takes an existing label capture and updates it by deserializing new or changed properties from JSON.
An error is set if the provided JSON does not contain required properties or contains properties of the wrong type.
- settings
open func settings(fromJSONString JSONString: String) throws -> LabelCaptureSettings
Added in version 6.4.0
Deserializes label capture settings from JSON.
An error is set if the provided JSON does not contain required properties or contains properties of the wrong type.
- update
open func update(_ settings: LabelCaptureSettings, fromJSONString JSONString: String) throws -> LabelCaptureSettings
Added in version 6.4.0
Takes existing label capture settings and updates them by deserializing new or changed properties from JSON.
An error is set if the provided JSON does not contain required properties or contains properties of the wrong type.
- basicOverlay
open func basicOverlay(fromJSONString JSONString: String, withMode mode: LabelCapture) throws -> LabelCaptureBasicOverlay
Added in version 6.4.0
Deserializes a label capture overlay from JSON.
An error is set if the provided JSON does not contain required properties or contains properties of the wrong type.
- update
open func update(_ overlay: LabelCaptureBasicOverlay, fromJSONString JSONString: String) throws -> LabelCaptureBasicOverlay
Added in version 6.4.0
Takes an existing label capture overlay and updates it by deserializing new or changed properties from JSON.
An error is set if the provided JSON does not contain required properties or contains properties of the wrong type.
- advancedOverlay
open func advancedOverlay(fromJSONString JSONString: String, withMode mode: LabelCapture) throws -> LabelCaptureAdvancedOverlay
Added in version 6.16.0
Deserializes a label capture advanced overlay from JSON.
An error is set if the provided JSON does not contain required properties or contains properties of the wrong type.
- update
open func update(_ overlay: LabelCaptureAdvancedOverlay, fromJSONString JSONString: String) throws -> LabelCaptureAdvancedOverlay
Added in version 6.16.0
Takes an existing label capture advanced overlay and updates it by deserializing new or changed properties from JSON.
An error is set if the provided JSON does not contain required properties or contains properties of the wrong type.
- validationFlowOverlay
open func validationFlowOverlay(fromJSONString JSONString: String, withMode mode: LabelCapture) throws -> LabelCaptureValidationFlowOverlay
Added in version 7.5.0
Deserializes a label capture validation flow overlay from JSON.
An error is set if the provided JSON does not contain required properties or contains properties of the wrong type.
- update
open func update(_ overlay: LabelCaptureValidationFlowOverlay, fromJSONString JSONString: String) throws -> LabelCaptureValidationFlowOverlay
Added in version 7.5.0
Takes an existing label capture validation flow overlay and updates it by deserializing new or changed properties from JSON.
An error is set if the provided JSON does not contain required properties or contains properties of the wrong type.
- adaptiveRecognitionOverlay
open func adaptiveRecognitionOverlay(fromJSONString JSONString: String, withMode mode: LabelCapture) throws -> LabelCaptureAdaptiveRecognitionOverlay
Added in version 8.1.0
Deserializes a label capture adaptive recognition overlay from JSON.
An error is set if the provided JSON does not contain required properties or contains properties of the wrong type.
- update
open func update(_ overlay: LabelCaptureAdaptiveRecognitionOverlay, fromJSONString JSONString: String) throws -> LabelCaptureAdaptiveRecognitionOverlay
Added in version 8.1.0
Takes an existing label capture adaptive recognition overlay and updates it by deserializing new or changed properties from JSON.
An error is set if the provided JSON does not contain required properties or contains properties of the wrong type.