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

SDCBarcodeTrackingDeserializer

@interface SDCBarcodeTrackingDeserializer : NSObject <SDCDataCaptureModeDeserializer>

Added in version 6.1.0

A deserializer to construct barcode tracking from JSON. For most use cases it is enough to use SDCBarcodeTracking.barcodeTrackingFromJSONString: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.

+ barcodeTrackingDeserializer

+ (instancetype)barcodeTrackingDeserializer

Added in version 6.1.0

Creates a new deserializer object.

delegate

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

Added 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 SDCBarcodeTracking *)modeFromJSONString:(NSString *)JSONString
                                        withContext:(SDCDataCaptureContext *)context
                                              error:(NSError **)error

Added in version 6.1.0

Deserializes barcode tracking 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 SDCBarcodeTracking *)updateMode:(SDCBarcodeTracking *)barcodeTracking
                             fromJSONString:(NSString *)JSONString
                                      error:(NSError **)error

Added in version 6.1.0

Takes an existing barcode tracking 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 SDCBarcodeTrackingSettings *)
  settingsFromJSONString:(NSString *)JSONString
                   error:(NSError **)error

Added in version 6.1.0

Deserializes barcode tracking 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 SDCBarcodeTrackingSettings *)updateSettings:(SDCBarcodeTrackingSettings *)settings
                                         fromJSONString:(NSString *)JSONString
                                                  error:(NSError **)error

Added in version 6.1.0

Takes existing barcode tracking 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.

- basicOverlayFromJSONString:withMode:error:

- (nullable SDCBarcodeTrackingBasicOverlay *)
  basicOverlayFromJSONString:(NSString *)JSONString
                    withMode:(SDCBarcodeTracking *)mode
                       error:(NSError **)error

Added in version 6.1.0

Deserializes a barcode tracking 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 SDCBarcodeTrackingBasicOverlay *)
  updateBasicOverlay:(SDCBarcodeTrackingBasicOverlay *)overlay
      fromJSONString:(NSString *)JSONString
               error:(NSError **)error

Added in version 6.1.0

Takes an existing barcode tracking basic 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.

- advancedOverlayFromJSONString:withMode:error:

- (nullable SDCBarcodeTrackingAdvancedOverlay *)
  advancedOverlayFromJSONString:(NSString *)JSONString
                       withMode:(SDCBarcodeTracking *)mode
                          error:(NSError **)error

Added in version 6.3.0

Deserializes a barcode tracking 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 SDCBarcodeTrackingAdvancedOverlay *)
  updateAdvancedOverlay:(SDCBarcodeTrackingAdvancedOverlay *)overlay
         fromJSONString:(NSString *)JSONString
                  error:(NSError **)error

Added in version 6.3.0

Takes an existing barcode tracking advanced 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.