@urovotest/urovosdk-docs-mcp 1.0.1

package/docs/02-reference/general/scanner-custom.md

@@ -0,0 +1,196 @@
+---
+title: Scanner Custom API
+module: Scanner Custom
+domain: general
+tags: ["general", "scanner-custom", "scanner custom"]
+---
+# Scanner Custom
+
+共 **2** 个 API/条目，来源 `general_sdk.md`。
+
+## API 索引
+
+| 方法 | 类路径 | Demo Activity |
+|------|--------|---------------|
+| [startScan](#startscan) | `com.urovo.sdk.scanner.InnerScannerCustomImpl` | - |
+| [stopScan](#stopscan) | `com.urovo.sdk.scanner.InnerScannerCustomImpl` | - |
+
+## startScan
+
+Start scanning code.
+
+```java
+void startScan(Context context, View view, Bundle bundle,
+ScannerListener listener)
+```
+
+- **类路径：** `com.urovo.sdk.scanner.InnerScannerCustomImpl`
+- **源文档章节：** 7.1
+
+- Source section: `7.1`
+
+- Package/class path: `com.urovo.sdk.scanner.InnerScannerCustomImpl`
+
+
+
+Purpose:
+Start scanning code.
+
+
+Signature/prototype:
+```java
+void startScan(Context context, View view, Bundle bundle,
+ScannerListener listener)
+```
+
+
+Parameters:
+Input
+context: context.
+view: layout view.
+bundle : refer to com.urovo.sdk.scanner.utils.Constant.Scankey.
+*cameraId(int) - 0:front, 1:back, 2:top.
+(Refer to com.urovo.sdk.scanner.utils.Constant.CameraID)
+*timeout(int) - time out(seconds).
+codeType_disable(String[]): The code types that need to be disabled.
+(Refer to com.urovo.sdk.scanner.utils.Constant.CodeType)
+*codeType_disable(StringArray):
+(refer to com.ubx.scanner.utils.Constant.CodeType).
+
+listener - scanning result listener.
+Output
+None
+
+
+Usage notes:
+/**
+* Scanning process listener interface definition
+*/
+interface ScannerListener {
+/**
+* Code scanning successful
+* @param data
+* @param byData
+*/
+void onSuccess(String data, byte[] byData);
+/**
+* Code scanning error
+* @param error - error code
+* @param message - error description
+*/
+void onError(int error, String message);
+/**
+* Code scanning timeout*/
+void onTimeout();
+/**
+* Code scanning cancel*/
+void onCancel();
+
+}
+
+
+Source details:
+```text
+Prototype
+void startScan(Context context, View view, Bundle bundle,
+ScannerListener listener)
+Description
+Start scanning code.
+Parameters
+Input
+context: context.
+view: layout view.
+bundle : refer to com.urovo.sdk.scanner.utils.Constant.Scankey.
+*cameraId(int) - 0:front, 1:back, 2:top.
+(Refer to com.urovo.sdk.scanner.utils.Constant.CameraID)
+*timeout(int) - time out(seconds).
+codeType_disable(String[]): The code types that need to be disabled.
+(Refer to com.urovo.sdk.scanner.utils.Constant.CodeType)
+*codeType_disable(StringArray):
+(refer to com.ubx.scanner.utils.Constant.CodeType).
+
+listener - scanning result listener.
+Output
+None
+Return
+
+Remark
+/**
+* Scanning process listener interface definition
+*/
+interface ScannerListener {
+/**
+* Code scanning successful
+* @param data
+* @param byData
+*/
+void onSuccess(String data, byte[] byData);
+/**
+* Code scanning error
+* @param error - error code
+* @param message - error description
+*/
+void onError(int error, String message);
+/**
+* Code scanning timeout*/
+void onTimeout();
+/**
+* Code scanning cancel*/
+void onCancel();
+
+}
+```
+
+## stopScan
+
+Stop scanning.
+
+```java
+void stopScan()
+```
+
+- **类路径：** `com.urovo.sdk.scanner.InnerScannerCustomImpl`
+- **源文档章节：** 7.2
+
+- Source section: `7.2`
+
+- Package/class path: `com.urovo.sdk.scanner.InnerScannerCustomImpl`
+
+
+
+Purpose:
+Stop scanning.
+
+
+Signature/prototype:
+```java
+void stopScan()
+```
+
+
+Parameters:
+Input
+None
+Output
+None
+
+
+Return value:
+None
+
+
+Source details:
+```text
+Prototype
+void stopScan()
+Description
+Stop scanning.
+Parameters
+Input
+None
+Output
+None
+Return
+None
+Remark
+```

package/docs/02-reference/general/scanner.md

@@ -0,0 +1,214 @@
+---
+title: Scanner API
+module: Scanner
+domain: general
+tags: ["general", "scanner", "scanner"]
+---
+# Scanner
+
+共 **2** 个 API/条目，来源 `general_sdk.md`。
+
+## API 索引
+
+| 方法 | 类路径 | Demo Activity |
+|------|--------|---------------|
+| [startScan](#startscan) | `com.urovo.sdk.scanner.InnerScannerImpl` | ScanActivity |
+| [stopScan](#stopscan) | `com.urovo.sdk.scanner.InnerScannerImpl` | ScanActivity |
+
+## startScan
+
+Start scanning code.
+
+```java
+void startScan(Context context, Bundle bundle, int cameraId, long timeout, ScannerListener listener)
+```
+
+- **类路径：** `com.urovo.sdk.scanner.InnerScannerImpl`
+- **Demo Activity（参考）：** ScanActivity
+- **源文档章节：** 6.1
+
+- Source section: `6.1`
+
+- Package/class path: `com.urovo.sdk.scanner.InnerScannerImpl`
+
+- Demo reference: `UrovoPosSdkDemo/app/src/main/java/com/urovo/sdk/view/ScanActivity.java`
+
+
+
+Purpose:
+Start scanning code.
+
+
+Signature/prototype:
+```java
+void startScan(Context context, Bundle bundle, int cameraId, long timeout, ScannerListener listener)
+```
+
+
+Parameters:
+Input
+context - context.
+bundle: refer to com.urovo.sdk.scanner.utils.Constant.Scankey.
+*title(String).
+*upPromptString(String).
+*downPromptString(String).
+*flash_enable(boolean).
+*codeType_disable(StringArray):
+(refer to com.urovo.sdk.scanner.utils.Constant.CodeType).
+cameraId(int) - 0:front, 1:back, 2:top.
+(Refer to com.urovo.sdk.scanner.utils.Constant.CameraID)
+timeout(int) - time out(seconds).
+
+listener - scanning result listener.
+Output
+None
+
+
+Usage notes:
+/**
+* Scanning process listener interface definition
+*/
+interface ScannerListener {
+/**
+* Code scanning successful
+* @param data
+* @param byData
+*/
+void onSuccess(String data, byte[] byData);
+/**
+* Code scanning error
+* @param error - error code
+* @param message - error description
+*/
+void onError(int error, String message);
+/**
+* Code scanning timeout*/
+void onTimeout();
+/**
+* Code scanning cancel*/
+void onCancel();
+
+}
+
+
+Simplified example:
+```java
+Bundle options = new Bundle();
+InnerScannerImpl.getInstance(context).startScan(context, options, 0, 30, listener);
+```
+
+
+Source details:
+```text
+Prototype
+void startScan(Context context, Bundle bundle, int cameraId, long timeout, ScannerListener listener)
+Description
+Start scanning code.
+Parameters
+Input
+context - context.
+bundle: refer to com.urovo.sdk.scanner.utils.Constant.Scankey.
+*title(String).
+*upPromptString(String).
+*downPromptString(String).
+*flash_enable(boolean).
+*codeType_disable(StringArray):
+(refer to com.urovo.sdk.scanner.utils.Constant.CodeType).
+cameraId(int) - 0:front, 1:back, 2:top.
+(Refer to com.urovo.sdk.scanner.utils.Constant.CameraID)
+timeout(int) - time out(seconds).
+
+listener - scanning result listener.
+Output
+None
+Return
+
+Remark
+/**
+* Scanning process listener interface definition
+*/
+interface ScannerListener {
+/**
+* Code scanning successful
+* @param data
+* @param byData
+*/
+void onSuccess(String data, byte[] byData);
+/**
+* Code scanning error
+* @param error - error code
+* @param message - error description
+*/
+void onError(int error, String message);
+/**
+* Code scanning timeout*/
+void onTimeout();
+/**
+* Code scanning cancel*/
+void onCancel();
+
+}
+```
+
+## stopScan
+
+Stop scanning.
+
+```java
+void stopScan()
+```
+
+- **类路径：** `com.urovo.sdk.scanner.InnerScannerImpl`
+- **Demo Activity（参考）：** ScanActivity
+- **源文档章节：** 6.2
+
+- Source section: `6.2`
+
+- Package/class path: `com.urovo.sdk.scanner.InnerScannerImpl`
+
+- Demo reference: `UrovoPosSdkDemo/app/src/main/java/com/urovo/sdk/view/ScanActivity.java`
+
+
+
+Purpose:
+Stop scanning.
+
+
+Signature/prototype:
+```java
+void stopScan()
+```
+
+
+Parameters:
+Input
+None
+Output
+None
+
+
+Return value:
+None
+
+
+Simplified example:
+```java
+InnerScannerImpl.getInstance(context).stopScan();
+```
+
+
+Source details:
+```text
+Prototype
+void stopScan()
+Description
+Stop scanning.
+Parameters
+Input
+None
+Output
+None
+Return
+None
+Remark
+```

package/docs/02-reference/general/sdk-log-output-management.md

@@ -0,0 +1,124 @@
+---
+title: SDK log output management. API
+module: SDK log output management.
+domain: general
+tags: ["general", "sdk-log-output-management", "sdk log output management."]
+---
+# SDK log output management.
+
+共 **6** 个 API/条目，来源 `general_sdk.md`。
+
+## API 索引
+
+| 方法 | 类路径 | Demo Activity |
+|------|--------|---------------|
+| [Enable/Disable logcat.](#enable-disable-logcat) | `-` | - |
+| [Enable/Disable log file storage.](#enable-disable-log-file-storage) | `-` | - |
+| [Enable/Disable Pinpad module log.](#enable-disable-pinpad-module-log) | `-` | - |
+| [Enable/Disable EMV module log.](#enable-disable-emv-module-log) | `-` | - |
+| [logoutEnable.](#logoutenable) | `-` | - |
+| [exportLogFilesToExternalStorage.](#exportlogfilestoexternalstorage) | `-` | - |
+
+## Enable/Disable logcat.
+
+- **源文档章节：** 15.1
+
+- Source section: `15.1`
+
+
+
+Purpose:
+logfile.setLogcatOut(boolean logcatOut);
+
+
+Source details:
+```text
+logfile.setLogcatOut(boolean logcatOut);
+```
+
+## Enable/Disable log file storage.
+
+- **源文档章节：** 15.2
+
+- Source section: `15.2`
+
+
+
+Purpose:
+//path:sdcard/urovosdkLibs/Log/
+
+
+Source details:
+```text
+//path:sdcard/urovosdkLibs/Log/
+logfile.setLogFileOut(boolean logFileOut);
+```
+
+## Enable/Disable Pinpad module log.
+
+- **源文档章节：** 15.3
+
+- Source section: `15.3`
+
+
+
+Purpose:
+PinPadProviderImpl.getInstance().LogOutEnable(boolean LogOutEnable);
+
+
+Source details:
+```text
+PinPadProviderImpl.getInstance().LogOutEnable(boolean LogOutEnable);
+```
+
+## Enable/Disable EMV module log.
+
+- **源文档章节：** 15.4
+
+- Source section: `15.4`
+
+
+
+Purpose:
+//if sdk version >= V1.0.22, the log path is : data/data/packageName/files/UROPE, else the log path is: sdcard/UROPE/.
+
+
+Source details:
+```text
+//if sdk version >= V1.0.22, the log path is : data/data/packageName/files/UROPE, else the log path is: sdcard/UROPE/.
+```
+
+## logoutEnable.
+
+- **源文档章节：** 15.4.1
+
+- Source section: `15.4.1`
+
+
+
+Purpose:
+EmvNfcKernelApi.getInstance(this).LogOutEnable(int enable): //1-enable, 0-disable.
+
+
+Source details:
+```text
+EmvNfcKernelApi.getInstance(this).LogOutEnable(int enable): //1-enable, 0-disable.
+```
+
+## exportLogFilesToExternalStorage.
+
+- **源文档章节：** 15.4.2
+
+- Source section: `15.4.2`
+
+
+
+Purpose:
+//if sdk version >= V1.0.22, need to call the below function before pulling log file:
+
+
+Source details:
+```text
+//if sdk version >= V1.0.22, need to call the below function before pulling log file:
+EmvNfcKernelApi.exportLogFilesToExternalStorage(Context context).
+```