Label Capture Validation Flow Settings
Defined under the namespace Scandit.Datacapture.Label.Ui
- LabelCaptureValidationFlowSettings
class LabelCaptureValidationFlowSettingsAdded in version 7.4.0
- create()
static create(): Promise<LabelCaptureValidationFlowSettings>
Added in version 7.4.0
Create a Label Capture Validation Flow Settings object with default values.
- setManualInputButtonText(text)
setManualInputButtonText(text: string): Promise<
void>Added in version 7.4.0
Set the text shown in the button that allows the user to start the flow by inputting values manually for the label fields.
- getManualInputButtonText()
getManualInputButtonText(): Promise<string>
Added in version 7.4.0
Get the text shown in the button that allows the user to start the flow by inputting values manually for the label fields.
Defaults to “Input Manually”.
- getRequiredFieldErrorText()
getRequiredFieldErrorText(): Promise<string>
Added in version 7.4.0
Get the text shown below an empty, required field when an attempt to finalize the validation flow has been made.
Defaults to “This field is required”.
- setRequiredFieldErrorText(text)
setRequiredFieldErrorText(text: string): Promise<
void>Added in version 7.4.0
Set the text shown below an empty, required field when an attempt to finalize the validation flow has been made.
- setValidationErrorText(text)
setValidationErrorText(text: string): Promise<
void>Added in version 7.4.0
Set the text shown below a field that holds an invalid value. This may happen due to either a bad scan or an incorrect manual input.
Defaults to “Invalid input”.
- getValidationErrorText()
getValidationErrorText(): Promise<string>
Added in version 7.4.0
Get the text shown below a field that holds an invalid value. This may happen due to either a bad scan or an incorrect manual input.
Defaults to “Invalid input”.
- setValidationHintText(text)
setValidationHintText(text: string): Promise<
void>Added in version 7.4.0
Set the text in the hint that is shown to the user when a scanning phase has finished. It informs them of how many fields have been successfully scanned so far
- getValidationHintText()
getValidationHintText(): Promise<string>
Added in version 7.4.0
Get the text in the hint that is shown to the user when a scanning phase has finished. It informs them of how many fields have been successfully scanned so far
Defaults to “X/Y label fields captured”, where X and Y are the number of captured and expected fields respectively.
- getMissingFieldsHintText()
getMissingFieldsHintText(): Promise<string>
Added in version 7.4.0
Get the text in the hint that is shown to the user when an attempt is made to validate a label while there are still empty fields where LabelField.isRequired is true.
Defaults to “Please fill in missing fields”.
- setMissingFieldsHintText(text)
setMissingFieldsHintText(text: string): Promise<
void>Added in version 7.4.0
Set the text in the hint that is shown to the user when an attempt is made to validate a label while there are still empty fields where LabelField.isRequired is true.
Defaults to “Please fill in missing fields”.
- setStandbyHintText(text)
setStandbyHintText(text: string): Promise<
void>Added in version 7.4.0
Set the text in the hint that is shown to the user when more than 10 seconds have passed during a scanning phase with no scan made, and the flow is paused until further user interaction.
- getStandbyHintText()
getStandbyHintText(): Promise<string>
Added in version 7.4.0
Get the text in the hint that is shown to the user when more than 10 seconds have passed during a scanning phase with no scan made, and the flow is paused until further user interaction.
Defaults to “Scanning paused to conserve battery”.