ALScanViewPluginConfig Class Reference
| Inherits from | NSObject |
|---|---|
| Conforms to | ALJSONStringRepresentable |
| Declared in | ALScanViewPluginConfig.h |
cutoutConfig
Configuration object for the associated cutout config
@property (nonatomic, readonly) ALCutoutConfig *cutoutConfigDeclared In
ALScanViewPluginConfig.h
scanFeedbackConfig
Configuration object for the associated scan feedback config
@property (nonatomic, readonly) ALScanFeedbackConfig *scanFeedbackConfigDeclared In
ALScanViewPluginConfig.h
scanPluginConfig
Configuration object for the associated scan plugin config
@property (nonatomic, readonly) ALScanPluginConfig *scanPluginConfigDeclared In
ALScanViewPluginConfig.h
– initWithScanPluginConfig:cutoutConfig:scanFeedbackConfig:error:
Initializes an ALScanViewPluginConfig with ScanPluginConfig, CutoutConfig, and
ScanFeedbackConfig components.
- (instancetype _Nullable)initWithScanPluginConfig:(ALScanPluginConfig *)scanPluginConfig cutoutConfig:(ALCutoutConfig *_Nullable)cutoutConfig scanFeedbackConfig:(ALScanFeedbackConfig *_Nullable)scanFeedbackConfig error:(NSError *_Nullable *_Nullable)errorParameters
scanPluginConfig |
Configuration object for the associated scan plugin config |
|---|---|
cutoutConfig |
Configuration object for the associated cutout config |
scanFeedbackConfig |
Configuration object for the associated scan feedback config |
error |
NSError object which is filled with appropriate information when initialization fails |
Return Value
the ALScanViewPluginConfig instance
Declared In
ALScanViewPluginConfig.h
– initWithScanPluginConfig:error:
Initializes the ScanViewPluginConfig with an ALScanPluginConfig instance
- (instancetype _Nullable)initWithScanPluginConfig:(ALScanPluginConfig *)scanPluginConfig error:(NSError *_Nullable *_Nullable)errorParameters
scanPluginConfig |
The ScanPluginConfig instance |
|---|---|
error |
An NSError object that is filled with the appropriate error information when initialization fails |
Return Value
the ALScanViewPluginConfig instance
Declared In
ALScanViewPluginConfig.h
– initWithJSONDictionary:error:
Initializes a ScanViewPluginConfig with an NSDictionary representing the configuration
- (instancetype _Nullable)initWithJSONDictionary:(NSDictionary *)JSONDictionary error:(NSError *_Nullable *_Nullable)errorParameters
JSONDictionary |
the JSON object representing the configuration |
|---|---|
error |
NSError object that is filled with the appropriate error information when initialization fails |
Declared In
ALScanViewPluginConfig.h
+ withScanPluginConfig:cutoutConfig:scanFeedbackConfig:
Creates a ScanViewPluginConfig with with ScanPluginConfig, CutoutConfig, and ScanFeedbackConfig components.
+ (ALScanViewPluginConfig *_Nullable)withScanPluginConfig:(ALScanPluginConfig *)scanPluginConfig cutoutConfig:(ALCutoutConfig *_Nullable)cutoutConfig scanFeedbackConfig:(ALScanFeedbackConfig *_Nullable)scanFeedbackConfigParameters
scanPluginConfig |
Configuration object for the associated scan plugin config |
|---|---|
cutoutConfig |
(Optional) Configuration object for the associated cutout config |
scanFeedbackConfig |
(Optional) Configuration object for the associated scan feedback config |
Return Value
the ALScanViewPluginConfig instance
Declared In
ALScanViewPluginConfig.h
+ withScanPluginConfig:
Creates a ScanViewPluginConfig with with ScanPluginConfig, CutoutConfig, and ScanFeedbackConfig components.
+ (ALScanViewPluginConfig *_Nullable)withScanPluginConfig:(ALScanPluginConfig *)scanPluginConfigParameters
scanPluginConfig |
Configuration object for the associated scan plugin config |
|---|
Return Value
the ALScanViewPluginConfig instance
Declared In
ALScanViewPluginConfig.h
+ withJSONDictionary:
Creates a ScanViewPluginConfig with an NSDictionary representing the configuration
+ (instancetype _Nullable)withJSONDictionary:(NSDictionary *)JSONDictionaryParameters
JSONDictionary |
the JSON object representing the configuration |
|---|
Return Value
the ALScanViewPluginConfig instance
Declared In
ALScanViewPluginConfig.h