Barcode Capture 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.
- SDCBarcodeCaptureDeserializer
@interface SDCBarcodeCaptureDeserializer : NSObject <SDCDataCaptureModeDeserializer>
Added in version 6.1.0
A deserializer to construct barcode capture from JSON. For most use cases it is enough to use SDCBarcodeCapture.barcodeCaptureFromJSONString:context: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.
- + barcodeCaptureDeserializer
+ (
instancetype)barcodeCaptureDeserializerAdded in version 6.1.0
Creates a new deserializer object.
- delegate
@property (nonatomic, weak, nullable)
id<SDCBarcodeCaptureDeserializerDelegate> delegateAdded in version 6.1.0
The object informed about deserialization events.
- warnings
@property (nonatomic, readonly) NSArray<NSString *> *warnings
Added in version 6.1.0
The warnings produced during deserialization, for example which properties were not used during deserialization.
- - modeFromJSONString:withContext:error:
- (nullable SDCBarcodeCapture *)modeFromJSONString:(NSString *)JSONString withContext:(SDCDataCaptureContext *)context error:(NSError **)error
Added in version 6.1.0
Deserializes barcode capture 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 SDCBarcodeCapture *)updateMode:(SDCBarcodeCapture *)barcodeCapture fromJSONString:(NSString *)JSONString error:(NSError **)error
Added in version 6.1.0
Takes an existing barcode 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 error is set if the provided JSON does not contain required properties or contains properties of the wrong type.
- - settingsFromJSONString:error:
- (nullable SDCBarcodeCaptureSettings *) settingsFromJSONString:(NSString *)JSONString error:(NSError **)error
Added in version 6.1.0
Deserializes barcode capture 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 SDCBarcodeCaptureSettings *)updateSettings:(SDCBarcodeCaptureSettings *)settings fromJSONString:(NSString *)JSONString error:(NSError **)error
Added in version 6.1.0
Takes existing barcode 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 error is set if the provided JSON does not contain required properties or contains properties of the wrong type.
- - overlayFromJSONString:withMode:error:
- (nullable SDCBarcodeCaptureOverlay *)overlayFromJSONString:(NSString *)JSONString withMode:(SDCBarcodeCapture *)mode error:(NSError **)error
Added in version 6.1.0
Deserializes a barcode capture overlay from JSON.
An error is set if the provided JSON does not contain required properties or contains properties of the wrong type.
- - updateOverlay:fromJSONString:error:
- (nullable SDCBarcodeCaptureOverlay *)updateOverlay:(SDCBarcodeCaptureOverlay *)overlay fromJSONString:(NSString *)JSONString error:(NSError **)error
Added in version 6.1.0
Takes an existing barcode 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 error is set if the provided JSON does not contain required properties or contains properties of the wrong type.