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.

SDCSparkScanDeserializer

@interface SDCSparkScanDeserializer : NSObject

Added in version 6.16.0

A deserializer to construct SparkScan from JSON. For most use cases it is enough to use SDCSparkScan.sparkScanFromJSONString:error: 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.

- init

- (instancetype)init

Added in version 6.16.0

Creates a new deserializer object.

delegate

@property (nonatomic, weak, nullable) id<SDCSparkScanDeserializerDelegate> delegate

Added in version 6.16.0

The object informed about deserialization events.

warnings

@property (nonatomic, readonly) NSArray<NSString *> *warnings

Added in version 6.16.0

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

- modeFromJSONString:error:

- (nullable SDCSparkScan *)modeFromJSONString:(NSString *)JSONString
                                        error:(NSError **)error

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:fromJSONString:error:

- (nullable SDCSparkScan *)updateMode:(SDCSparkScan *)sparkScan
                       fromJSONString:(NSString *)JSONString
                                error:(NSError **)error

Added in version 6.16.0

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

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

- settingsFromJSONString:error:

- (nullable SDCSparkScanSettings *)settingsFromJSONString:(NSString *)JSONString
                                                    error:(NSError **)error

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.

- updateSettings:fromJSONString:error:

- (nullable SDCSparkScanSettings *)updateSettings:(SDCSparkScanSettings *)settings
                                   fromJSONString:(NSString *)JSONString
                                            error:(NSError **)error

Added in version 6.16.0

Takes existing SparkScan 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 error is set if the provided JSON does not contain required properties or contains properties of the wrong type.