n4.cuwo.messages.ScanBarcodesStartOperation

The ScanBarcodesStartOperation message is used to enable barcode scanning on the client.

The message has the following structure:

{
  "@type": "n4.cuwo.messages.ScanBarcodesStartOperation",
  "id": "...",
  "barcodeTypes": [
    { "@type": "n4.cuwo.messages.BarcodeType", "value": "..." },
    { "@type": "n4.cuwo.messages.BarcodeType", "value": "..." },
    ...
  ],
  "infoMessage": "..."
}

The various member provide the information necessary for the operation:

• id - The ID of the operation. Will be used as part of the acknowledgement and result messages
• barcodeTypes - An array of n4.cuwo.messages.BarcodeType values listing the types of barcodes that are allowed to be scanned. The array must always be present. When non-empty, a barcode is only accepted if it is one of the listed types. If empty, any type of barcode generally supported by the system is accepted. One of EAN13, EAN8, EAN5, EAN2, UPCE, QRCODE, CODE128, CODE39, CODE93, CODABAR, DATAMATRIX, ITF, PDF417, DATABAR, DATABAR_EXPANDED
• infoMessage - The message that will be shown by the user when they enable the native UI for manually entering the barcode.

Once barcode scanning has been enabled, the CUWO will start to receive BarcodeScanned-messages whenever the user scans a code or manually enters one (via a special native UI). To stop receiving codes, the CUWO must invoke the ScanBarcodesStopOperation operation.

Sending multiple ScanBarcodesStartOperation messages without intermediate ScanBarcodesStopOperation’s will update the allowed barcode types and the info message but a single ScanBarcodesStopOperation will still be enough to stop the barcode scanning functionality.