models/wrapper_session_parameters library

Classes

Aamva
Holds all encoded barcode information according to the AAMVA standard
AndroidScanViewAttributesConfig
Android-specific ScanView attributes for layout and behavior customization.
Arabic
The text parameters
Barcode
Describes barcode information
BarcodeResult
Describes result information of scanning barcodes
BodyPart
CommercialTireIdResult
Describes result information of scanning commercial tire IDs
ContainerResult
Describes result information of scanning shipping containers
CropRect
The rect information of the region that was processed within the image
Cyrillic
The text parameters
DateValue
Describes the date value of an ID field
Demo
Data contained within the QR code that's required to unlock scanning with the Showcase Apps.
EnumValues<T>
ExportedScanResult
A single scan result exported from the Anyline SDK, containing the plugin-specific result data together with the associated scan images.
ExportedScanResultImageContainer
Specifies how scan result images are delivered — either saved to a file path or encoded as base64 strings.
ExportedScanResultImageContainerEncoded
Deliver images as base64-encoded strings embedded in the result JSON.
ExportedScanResultImageContainerSaved
Deliver images as files saved to the specified directory path.
ExportedScanResultImageParameters
Output format and quality settings for scan result images.
ExportedScanResultImages
The base64-encoded image data for each image type.
FieldConfidences
The confidence values of each field
IdResult
Yields field information of the ID
JapaneseLandingPermissionResult
Describes result information of scanning japanese landing permission tickets
JapaneseLandingPermissionResultField
Provides result information for japanese landing permission fields
JlpResult
Yields field information of a japanese landing permission ticket
Latin
The text parameters
LicensePlateResult
Describes result information of scanning license plates
MeterResult
Describes result information of scanning meters
MrzResult
Describes result information of scanning MRZ
OcrResult
Describes result information of scanning general OCR
OdometerResult
Describes result information of scanning odometers
PerformanceMetrics
representing time measurements for different parts of the process.
PluginResult
The plugin-specific scan result produced by the Anyline SDK.
ScanViewInitializationParameters
Optional initialization parameters applied when the ScanView is created.
Sfdc
TextValues
Describes the text values of an ID field
TinResult
Describes result information of scanning tire identification numbers (TIN)
TireMakeResult
Describes result information of scanning tire makes
TireSizeResult
Describes result information of scanning tire size specifications
TireSizeResultField
UniversalIdResult
Describes result information of scanning different kinds of IDs
UniversalIdResultField
Describes scanned parameters of an ID field
VehicleRegistrationCertificateResult
Describes result information of scanning vehicle registration certificates
VehicleRegistrationCertificateResultField
Describes scanned parameters of a vehicle registration certificate field
VinResult
Describes result information of scanning vehicle identification numbers (VIN)
Visualization
Information about the visualization data of the scanned ID
VrcResult
Yields field information of the vehicle registration certificate
WrapperSessionExportCachedEventsResponse
Response from cached events export operation. Includes either failInfo (if export failed) or succeedInfo (if successful), corresponding to the status field.
WrapperSessionExportCachedEventsResponseFail
Populated when status is exportFailed. Contains the error that caused the failure.
WrapperSessionExportCachedEventsResponseSucceed
Populated when status is exportSucceeded. Contains the path to the exported file.
WrapperSessionParameters
Top-level schema encompassing all request and response types exchanged between the wrapper plugin and the Anyline SDK during a scanning session.
WrapperSessionScanResponse
Response indicating scan session completion status. Includes exactly one info object (failInfo, abortInfo, or succeedInfo) corresponding to the status field value.
WrapperSessionScanResponseAbort
Populated when status is scanAborted. Contains the reason for the abort.
WrapperSessionScanResponseFail
Populated when status is scanFailed. Contains the error that caused the failure.
WrapperSessionScanResponseSucceed
Populated when status is scanSucceeded. Contains an optional completion message.
WrapperSessionScanResultCallbackConfig
Deprecated. Used only by the legacy plugin. Custom callback method names for scan result and UI element click events.
WrapperSessionScanResultConfig
The result configuration that was active during the completed scan session.
WrapperSessionScanResultExtraInfo
Additional metadata about the source plugin that produced these results.
WrapperSessionScanResultsResponse
Information about the results collected during the scanning process.
WrapperSessionScanStartPlatformOptions
Platform-specific options applied when starting a scan session.
WrapperSessionScanStartRequest
Request to start a scanning session. Requires both scanViewConfigContentString (defining what to scan) and scanResultConfig (defining how to handle results). Optional scanViewInitializationParameters for workflow correlation.
WrapperSessionScanStopRequest
Request to stop the current scanning session with optional message explaining the reason for termination.
WrapperSessionScanViewConfigOptionDoneButton
Deprecated. iOS only. Button that dismisses the scan view. Use toolbarTitle instead.
WrapperSessionScanViewConfigOptionElementOffset
Optional pixel offset from the aligned corner position.
WrapperSessionScanViewConfigOptionLabel
Deprecated. iOS only. Static text label on the scan view. Use the Simple Instruction Label UI Feedback preset instead.
WrapperSessionScanViewConfigOptionRotateButton
Optional button that lets users toggle between portrait and landscape orientations.
WrapperSessionScanViewConfigOptions
UI configuration options for the scan view, controlling optional controls, orientation, and overlays.
WrapperSessionScanViewConfigOptionSegmentConfig
Optional multi-mode segment control for switching between scanning configurations.
WrapperSessionSdkInitializationCacheConfig
Optional cache settings applied during initialization.
WrapperSessionSdkInitializationRequest
General information to be used for SDK initialization.
WrapperSessionSdkInitializationResponse
Response containing SDK initialization result. Must include either failInfo (if initialization failed) or succeedInfo (if successful). The 'initialized' boolean indicates the overall status.
WrapperSessionSdkInitializationResponseInitialized
Populated when initialized is true. Contains license details from the successful initialization.
WrapperSessionSdkInitializationResponseNotInitialized
Populated when initialized is false. Contains the error that prevented SDK initialization.
WrapperSessionUcrReportRequest
Request to submit a User Corrected Result (UCR) for a previously scanned item.
WrapperSessionUcrReportResponse
Response from UCR (User Corrected Result) reporting. Must include either failInfo (if reporting failed) or succeedInfo (if successful), corresponding to the status field.
WrapperSessionUcrReportResponseFail
Populated when status is ucrReportFailed. Contains the error details.
WrapperSessionUcrReportResponseSucceed
Populated when status is ucrReportSucceeded. Contains the server confirmation message.

Enums

Area
The area information
ExportedScanResultImageFormat
Image format used when exporting scan result images.
FillType
The preset used for width fill.
PositionXAlignment
The preset locations for the button along the x-axis.
PositionYAlignment
The preset locations for the button along the y-axis.
ViewPluginType
The type of the source ViewPlugin that generated result(s).
WrapperSessionExportCachedEventsResponseStatus
The final status of the export operation.
WrapperSessionScanResponseStatus
The final status of the scan session.
WrapperSessionScanResultCleanStrategyConfig
Controls when previously generated result files are removed from storage.
WrapperSessionScanViewConfigOptionDefaultOrientation
Initial screen orientation when the scan view is presented.
WrapperSessionScanViewConfigOptionElementAlignment
Corner of the screen where the rotate button is positioned.
WrapperSessionUcrReportResponseStatus
The final status of the UCR report submission.