SparkScan Deserializer
Defined in framework ScanditBarcodeCapture
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.
- SparkScanDeserializer
open class SparkScanDeserializer : NSObject
Added in version 6.16.0
A deserializer to construct SparkScan from JSON. For most use cases it is enough to use SparkScan.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.16.0
Creates a new deserializer object.
- delegate
open weak var delegate: SparkScanDeserializerDelegate? { get, set }
Added in version 6.16.0
The object informed about deserialization events.
- warnings
open var warnings: Array<String> { get }
Added in version 6.16.0
The warnings produced during deserialization, for example which properties were not used during deserialization.
- mode
open func mode(fromJSONString JSONString: String) throws -> SparkScan
Added in version 6.16.0
Deserializes SparkScan 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(_ sparkScan: SparkScan, fromJSONString JSONString: String) throws -> SparkScan
Added in version 6.16.0
Takes an existing SparkScan 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 -> SparkScanSettings
Added in version 6.16.0
Deserializes SparkScan 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: SparkScanSettings, fromJSONString JSONString: String) throws -> SparkScanSettings
Added in version 6.16.0
Takes existing SparkScan 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.