UIFeedbackConfig

Type: object

General configuration for UI Feedback elements

root elements
Type: array

Elements inside UIFeedbackConfig.

 No Additional Items

Each item of this array must be:

root elements element
Type: object

Configuration for uiFeedback element

root elements UIFeedbackElementConfig id
Type: string

Sets the id of the element.

root elements UIFeedbackElementConfig contentType
Type: enum (of string) Default: "text"

Sets the view type of the element.

Must be one of:

  • "image"
  • "sound"
  • "text"

root elements UIFeedbackElementConfig defaultContent
Type: object

Configuration for UI Feedback content

root elements UIFeedbackElementConfig defaultContent contentValue
Type: string Default: ""

Sets the content of the element.

root elements UIFeedbackElementConfig defaultContent durationMills
Type: integer Default: 0

Sets the duration of the element.

Value must be greater or equal to 0 and lesser or equal to 1000000

root elements UIFeedbackElementConfig defaultContent priorityLevel
Type: integer Default: 1

Sets the priority of the element.

Value must be greater or equal to 0 and lesser or equal to 100

root elements UIFeedbackElementConfig clickable
Type: boolean Default: false

Sets whether the view is clickable.

root elements UIFeedbackElementConfig tag
Type: string Default: ""

Sets a tag for the element.

root elements UIFeedbackElementConfig defaultAttributes
Type: object

Configuration attributes for UI Feedback view elements

root elements UIFeedbackElementConfig defaultAttributes textAlignment
Type: enum (of string) Default: "center"

Sets the text alignment.

Must be one of:

  • "left"
  • "right"
  • "center"

root elements UIFeedbackElementConfig defaultAttributes textColor
Type: string

Sets the text color.

root elements UIFeedbackElementConfig defaultAttributes backgroundColor
Type: string

Sets the background color.

root elements UIFeedbackElementConfig defaultAttributes imageScaleType
Type: enum (of string) Default: "fit_center"

Sets the image scale type.

Must be one of:

  • "center"
  • "center_crop"
  • "fit_center"
  • "fit_xy"

root elements UIFeedbackElementConfig trigger
Type: object

Trigger configuration for UI Feedback

root elements UIFeedbackElementConfig trigger scanInfo
Type: array

Allows to watch scanInfo events.

 No Additional Items

Each item of this array must be:

root elements UIFeedbackElementConfig trigger scanInfo triggerWhenScanInfo
Type: object

Configuration for triggering UI Feedback on ScanInfo events

root elements UIFeedbackElementConfig trigger scanInfo UIFeedbackElementTriggerWhenScanInfoConfig when
Type: object

Configuration for triggering UI Feedback on ScanInfo events

root elements UIFeedbackElementConfig trigger scanInfo UIFeedbackElementTriggerWhenScanInfoConfig when applyDefaultContent
Type: boolean Default: false

Sets whether the trigger must apply defaultContent.

root elements UIFeedbackElementConfig trigger scanInfo UIFeedbackElementTriggerWhenScanInfoConfig when applyDefaultAttributes
Type: boolean Default: false

Sets whether the trigger must apply defaultAttributes.

root elements UIFeedbackElementConfig trigger scanInfo UIFeedbackElementTriggerWhenScanInfoConfig when varNameEquals
Type: string Default: ""

Sets the ScanInfo variable name to be watched.

root elements UIFeedbackElementConfig trigger scanInfo UIFeedbackElementTriggerWhenScanInfoConfig when varValueEquals
Type: string Default: ""

Sets the ScanInfo variable value to be watched.

root elements UIFeedbackElementConfig trigger runSkipped
Type: array

Allows to watch runSkipped events.

 No Additional Items

Each item of this array must be:

root elements UIFeedbackElementConfig trigger runSkipped triggerWhenRunSkipped
Type: object

Configuration for triggering UI Feedback on RunSkipped events

root elements UIFeedbackElementConfig trigger runSkipped UIFeedbackElementTriggerWhenRunSkippedConfig when
Type: object

Configuration for triggering UI Feedback on RunSkipped events

root elements UIFeedbackElementConfig trigger runSkipped UIFeedbackElementTriggerWhenRunSkippedConfig when applyDefaultContent
Type: boolean Default: false

Sets whether the trigger must apply defaultContent.

root elements UIFeedbackElementConfig trigger runSkipped UIFeedbackElementTriggerWhenRunSkippedConfig when applyDefaultAttributes
Type: boolean Default: false

Sets whether the trigger must apply defaultAttributes.

root elements UIFeedbackElementConfig trigger runSkipped UIFeedbackElementTriggerWhenRunSkippedConfig when codeEquals
Type: integer Default: "0"

Sets the runSkipped code to be watched.

root elements UIFeedbackElementConfig trigger presets
Type: array
No Additional Items

Each item of this array must be:

root elements UIFeedbackElementConfig trigger presets preset
Type: object

Configuration for uiFeedback preset.

root elements UIFeedbackElementConfig trigger presets UIFeedbackPresetConfig presetAttributes
Type: array

Attributes inside preset.

 No Additional Items

Each item of this array must be:

root elements UIFeedbackElementConfig trigger presets UIFeedbackPresetConfig presetAttributes presetAttribute
Type: object

Configuration for uiFeedback preset attribute.

root elements UIFeedbackElementConfig overlay
Type: object

Configuration for UI Feedback overlays

root elements UIFeedbackElementConfig overlay source
Type: enum (of string) Default: "cutout"

Sets the source of the overlay.

Must be one of:

  • "cutout"

root elements UIFeedbackElementConfig overlay anchor
Type: enum (of string)

Sets the anchor of the overlay.

Must be one of:

  • "top_left"
  • "top_center"
  • "top_right"
  • "center_left"
  • "center"
  • "center_right"
  • "bottom_left"
  • "bottom_center"
  • "bottom_right"

root elements UIFeedbackElementConfig overlay sizeDimension
Type: object

Sets the size dimension of the overlay.

root elements UIFeedbackElementConfig overlay sizeDimension scaleX
Type: object

Sets the scale for x axis of the overlay.

root elements UIFeedbackElementConfig overlay sizeDimension scaleX scaleValue
Type: number

Sets the scale value of the overlay.

root elements UIFeedbackElementConfig overlay sizeDimension scaleX scaleType

OverlayScaleTypeConfig

Type: enum (of string)

Sets the scale type of the overlay.

Must be one of:

  • "none"
  • "fixed_px"
  • "keep_ratio"
  • "overlay"

root elements UIFeedbackElementConfig overlay sizeDimension scaleY
Type: object

Sets the scale for y axis of the overlay.

Same definition as scaleX

root elements UIFeedbackElementConfig overlay offsetDimension
Type: object

Sets the offset dimension of the overlay.

Same definition as sizeDimension

root elements UIFeedbackElementConfig overlay presets
Type: array

Allows to use overlay presets.

 No Additional Items

Each item of this array must be:

root elements UIFeedbackElementConfig overlay presets preset
Type: object

Configuration for uiFeedback preset.

Same definition as UIFeedbackPresetConfig

root elements UIFeedbackElementConfig presets
Type: array

Allows to use element presets.

 No Additional Items

Each item of this array must be:

root elements UIFeedbackElementConfig presets preset
Type: object

Configuration for uiFeedback preset.

Same definition as UIFeedbackPresetConfig

root presetDefinitions
Type: array

Preset definitions inside UIFeedbackConfig.

 No Additional Items

Each item of this array must be:

root presetDefinitions presetDefinition
Type: object

Configuration for uiFeedback preset definition.

root presetDefinitions UIFeedbackPresetDefinitionConfig allOf item 0
Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root presetDefinitions UIFeedbackPresetDefinitionConfig allOf item 0 if
Type: object

root presetDefinitions UIFeedbackPresetDefinitionConfig allOf item 0 if type
Type: const
Specific value: "presetElementOverlay"
root presetDefinitions UIFeedbackPresetDefinitionConfig allOf item 0 then
Type: object

root presetDefinitions UIFeedbackPresetDefinitionConfig allOf item 0 then presetContent
Type: object

The following properties are required:

  • overlay
root presetDefinitions UIFeedbackPresetDefinitionConfig allOf item 1
Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root presetDefinitions UIFeedbackPresetDefinitionConfig allOf item 1 if
Type: object

root presetDefinitions UIFeedbackPresetDefinitionConfig allOf item 1 if type
Type: const
Specific value: "presetElementTrigger"
root presetDefinitions UIFeedbackPresetDefinitionConfig allOf item 1 then
Type: object

root presetDefinitions UIFeedbackPresetDefinitionConfig allOf item 1 then presetContent
Type: object

The following properties are required:

  • trigger
root presetDefinitions UIFeedbackPresetDefinitionConfig allOf item 2
Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root presetDefinitions UIFeedbackPresetDefinitionConfig allOf item 2 if
Type: object

root presetDefinitions UIFeedbackPresetDefinitionConfig allOf item 2 if type
Type: const
Specific value: "presetElement"
root presetDefinitions UIFeedbackPresetDefinitionConfig allOf item 2 then
Type: object

root presetDefinitions UIFeedbackPresetDefinitionConfig allOf item 2 then presetContent
Type: object

The following properties are required:

  • element
root presetDefinitions UIFeedbackPresetDefinitionConfig allOf item 3
Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root presetDefinitions UIFeedbackPresetDefinitionConfig allOf item 3 if
Type: object

root presetDefinitions UIFeedbackPresetDefinitionConfig allOf item 3 if type
Type: const
Specific value: "preset"
root presetDefinitions UIFeedbackPresetDefinitionConfig allOf item 3 then
Type: object

root presetDefinitions UIFeedbackPresetDefinitionConfig allOf item 3 then presetContent
Type: object

The following properties are required:

  • elements

root presetDefinitions UIFeedbackPresetDefinitionConfig name
Type: string

Sets the name of the preset definition.

root presetDefinitions UIFeedbackPresetDefinitionConfig type
Type: enum (of string)

Sets the preset definition type.

Must be one of:

  • "presetElementOverlay"
  • "presetElementTrigger"
  • "presetElement"
  • "preset"

root presetDefinitions UIFeedbackPresetDefinitionConfig attributes
Type: array

Attributes inside preset definition.

 No Additional Items

Each item of this array must be:

root presetDefinitions UIFeedbackPresetDefinitionConfig attributes presetDefinitionAttribute
Type: object

Configuration for uiFeedback preset definition attribute.

root presetDefinitions UIFeedbackPresetDefinitionConfig attributes UIFeedbackPresetDefinitionAttributeConfig elementType
Type: enum (of string)

Sets the preset definition attribute element type.

Must be one of:

  • "int"
  • "long"
  • "double"
  • "boolean"
  • "string"
  • "any"

root presetDefinitions UIFeedbackPresetDefinitionConfig presetContent

UIFeedbackPresetContentConfig

Type: object

Configuration for uiFeedback preset content definition.

root presetDefinitions UIFeedbackPresetDefinitionConfig presetContent elements
Type: array
No Additional Items

Each item of this array must be:

root presetDefinitions UIFeedbackPresetDefinitionConfig presetContent elements element
Type: object

Configuration for uiFeedback element

Same definition as UIFeedbackElementConfig

root presetDefinitions UIFeedbackPresetDefinitionConfig presetContent presets
Type: array
No Additional Items

Each item of this array must be:

root presetDefinitions UIFeedbackPresetDefinitionConfig presetContent presets preset
Type: object

Configuration for uiFeedback preset.

Same definition as UIFeedbackPresetConfig

root presets
Type: array

Allows to use presets.

 No Additional Items

Each item of this array must be:

root presets preset
Type: object

Configuration for uiFeedback preset.

Same definition as UIFeedbackPresetConfig