CodeService

2024-11-08 01:35

IAPMiniProgram SDK calls the CodeService SPI to launch the QR code or barcode scanner. For details on how the SPI functions, refer to the CodeService workflow.

This SPI provides the scan method. The method details are as follows:

scan

IAPMiniprogram SDK calls the scan method to launch the QR code or barcode scanner.

Method signature

copy
void scan(ScannerOption scannerOption, APIContext apiContext, Callback<ScannerResult> callback)

Request parameters

Field	Data type	Description	Required
scannerOption	ScannerOption	An object that specifies the details of the scan request from the mini program. When this parameter is not specified, the default values of this parameter are used.	Yes
apiContext	APIContext	A context object, which carries the mini program runtime metadata.	Yes
callback	Callback	The callback that is executed when request processing is completed. For details, see the following section.	Yes

Callback

Field	Data type	Description	Required
result	ScannerResult	The result of the `scan` request.	Yes

Response parameters

N/A

Error codes

Error code		Error message
10	ERROR_USER_CANCEL	Users cancel the scan action.
2001	ERROR_OPERATION_FAILED	Failed to scan the code.

Samples

The following samples show how to implement the CodeService SPI to enable QR code and barcode scanning capabilities.

Create a class that implements the CodeService interface.
Implement the scan method.

Java

copy
public class CodeServiceImpl implements CodeService {
    @Override
    public void scan(ScannerOption scannerOption, APIContext apiContext, final Callback<ScannerResult> callback) {
        // to scan code
        callback.result(new ScannerResult(codeValue));
    }
}

Kotlin

copy
class CodeServiceImpl : CodeService {
    override fun scan(scannerOption: ScannerOption?, apiContext: APIContext?, callback: Callback<ScannerResult?>
            ) {
        // to scan code
        callback.result(ScannerResult(codeValue))
    }
}