ID Capture Deserializer
Defined in framework ScanditIdCapture
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.
- SDCIdCaptureDeserializer
@interface SDCIdCaptureDeserializer : NSObject <SDCDataCaptureModeDeserializer>
Added in version 6.6.0
A deserializer to construct id capture from JSON. For most use cases it is enough to use SDCIdCapture.idCaptureFromJSONString: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.
- + idCaptureDeserializer
+ (
instancetype
)idCaptureDeserializerAdded in version 6.6.0
Creates a new deserializer object.
- delegate
@property (nonatomic, weak, nullable)
id
<SDCIdCaptureDeserializerDelegate> delegateAdded in version 6.6.0
The object informed about deserialization events.
- warnings
@property (nonatomic, readonly) NSArray<NSString *> *warnings
Added in version 6.6.0
The warnings produced during deserialization, for example which properties were not used during deserialization.
- - modeFromJSONString:withContext:error:
- (nullable SDCIdCapture *)modeFromJSONString:(NSString *)JSONString withContext:(SDCDataCaptureContext *)context error:(NSError **)error
Added in version 6.6.0
Deserializes id 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 SDCIdCapture *)updateMode:(SDCIdCapture *)idCapture fromJSONString:(NSString *)JSONString error:(NSError **)error
Added in version 6.22.0
Takes an existing ID capture 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 SDCIdCaptureSettings *)settingsFromJSONString:(NSString *)JSONString error:(NSError **)error
Added in version 6.6.0
Deserializes id 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 SDCIdCaptureSettings *)updateSettings:(SDCIdCaptureSettings *)settings fromJSONString:(NSString *)JSONString error:(NSError **)error
Added in version 6.6.0
Takes existing id capture 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.
- - overlayFromJSONString:withMode:error:
- (nullable SDCIdCaptureOverlay *)overlayFromJSONString:(NSString *)JSONString withMode:(SDCIdCapture *)mode error:(NSError **)error
Added in version 6.6.0
Deserializes id 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 SDCIdCaptureOverlay *)updateOverlay:(SDCIdCaptureOverlay *)overlay fromJSONString:(NSString *)JSONString error:(NSError **)error
Added in version 6.6.0
Takes existing id capture overlay 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.