Barcode Batch 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.

SDCBarcodeBatchDeserializer

@interface SDCBarcodeBatchDeserializer : NSObject <SDCDataCaptureModeDeserializer>

Added in version 7.0.0

A deserializer to construct Barcode Batch from JSON. For most use cases it is enough to use SDCBarcodeBatch.barcodeBatchFromJSONString: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.

+ barcodeBatchDeserializer

+ (instancetype)barcodeBatchDeserializer

Added in version 7.0.0

Creates a new deserializer object.

delegate

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

Added in version 7.0.0

The object informed about deserialization events.

warnings

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

Added in version 7.0.0

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

- modeFromJSONString:withContext:error:

- (nullable SDCBarcodeBatch *)modeFromJSONString:(NSString *)JSONString
                                     withContext:(SDCDataCaptureContext *)context
                                           error:(NSError **)error

Added in version 7.0.0

Deserializes Barcode Batch 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 SDCBarcodeBatch *)updateMode:(SDCBarcodeBatch *)barcodeBatch
                          fromJSONString:(NSString *)JSONString
                                   error:(NSError **)error

Added in version 7.0.0

Takes an existing Barcode Batch 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.

- settingsFromJSONString:error:

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

Added in version 7.0.0

Deserializes Barcode Batch 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 SDCBarcodeBatchSettings *)updateSettings:(SDCBarcodeBatchSettings *)settings
                                      fromJSONString:(NSString *)JSONString
                                               error:(NSError **)error

Added in version 7.0.0

Takes existing Barcode Batch 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.

- basicOverlayFromJSONString:withMode:error:

- (nullable SDCBarcodeBatchBasicOverlay *)
  basicOverlayFromJSONString:(NSString *)JSONString
                    withMode:(SDCBarcodeBatch *)mode
                       error:(NSError **)error

Added in version 7.0.0

Deserializes a Barcode Batch basic overlay from JSON.

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

- updateBasicOverlay:fromJSONString:error:

- (nullable SDCBarcodeBatchBasicOverlay *)updateBasicOverlay:(SDCBarcodeBatchBasicOverlay *)
                                                             overlay
                                              fromJSONString:(NSString *)JSONString
                                                       error:(NSError **)error

Added in version 7.0.0

Takes an existing Barcode Batch basic 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.

- advancedOverlayFromJSONString:withMode:error:

- (nullable SDCBarcodeBatchAdvancedOverlay *)
  advancedOverlayFromJSONString:(NSString *)JSONString
                       withMode:(SDCBarcodeBatch *)mode
                          error:(NSError **)error

Added in version 7.0.0

Deserializes a Barcode Batch advanced overlay from JSON.

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

- updateAdvancedOverlay:fromJSONString:error:

- (nullable SDCBarcodeBatchAdvancedOverlay *)
  updateAdvancedOverlay:(SDCBarcodeBatchAdvancedOverlay *)overlay
         fromJSONString:(NSString *)JSONString
                  error:(NSError **)error

Added in version 7.0.0

Takes an existing Barcode Batch 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.