@urovotest/urovosdk-docs-mcp 1.0.1

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

@@ -0,0 +1,191 @@
+---
+title: MagCardReader API
+module: MagCardReader
+domain: general
+tags: ["general", "magcardreader", "magcardreader"]
+---
+# MagCardReader
+
+共 **2** 个 API/条目，来源 `general_sdk.md`。
+
+## API 索引
+
+| 方法 | 类路径 | Demo Activity |
+|------|--------|---------------|
+| [SearchCard](#searchcard) | `com.urovo.sdk.magcard.MagCardReaderImpl` | MagCardReaderActivity |
+| [stopSearch](#stopsearch) | `com.urovo.sdk.magcard.MagCardReaderImpl` | MagCardReaderActivity |
+
+## SearchCard
+
+Wait for swiping card to get card magnetic stripe data.
+
+```java
+void searchCard(int timeout, MagCardListener listener)
+```
+
+- **类路径：** `com.urovo.sdk.magcard.MagCardReaderImpl`
+- **Demo Activity（参考）：** MagCardReaderActivity
+- **源文档章节：** 8.1
+
+- Source section: `8.1`
+
+- Package/class path: `com.urovo.sdk.magcard.MagCardReaderImpl`
+
+- Demo reference: `UrovoPosSdkDemo/app/src/main/java/com/urovo/sdk/view/MagCardReaderActivity.java`
+
+
+
+Purpose:
+Wait for swiping card to get card magnetic stripe data.
+
+
+Signature/prototype:
+```java
+void searchCard(int timeout, MagCardListener listener)
+```
+
+
+Parameters:
+Input
+timeout - time out(second).
+listener - swipe card result listener.
+Output
+None
+
+
+Usage notes:
+Swip card process listener interface definition：
+interface MagCardListener {
+/**
+* Swip card successful
+* @param track - Magnetic card data
+*
+* - PAN(String) - card number
+* - TRACK1(String) - Track 1 data
+* - TRACK2(String) - Track 2 data
+* - TRACK3(String) - Track 3 data
+* - SERVICE_CODE(String) - Service card
+* - EXPIRED_DATE(String) - card expired date
+* */
+void onSuccess(in Bundle track);
+/**
+* Swipe card error
+* @param error - error code
+* @param message - error description
+*/
+void onError(int error, String message);
+/**
+* Swip card timeout */
+void onTimeout();
+}
+
+
+Simplified example:
+```java
+MagCardReaderImpl.getInstance().searchCard(30, listener);
+```
+
+
+Source details:
+```text
+Prototype
+void searchCard(int timeout, MagCardListener listener)
+Description
+Wait for swiping card to get card magnetic stripe data.
+Parameters
+Input
+timeout - time out(second).
+listener - swipe card result listener.
+Output
+None
+Return
+
+Remark
+Swip card process listener interface definition：
+interface MagCardListener {
+/**
+* Swip card successful
+* @param track - Magnetic card data
+*
+* - PAN(String) - card number
+* - TRACK1(String) - Track 1 data
+* - TRACK2(String) - Track 2 data
+* - TRACK3(String) - Track 3 data
+* - SERVICE_CODE(String) - Service card
+* - EXPIRED_DATE(String) - card expired date
+* */
+void onSuccess(in Bundle track);
+/**
+* Swipe card error
+* @param error - error code
+* @param message - error description
+*/
+void onError(int error, String message);
+/**
+* Swip card timeout */
+void onTimeout();
+}
+```
+
+## stopSearch
+
+Remove the waiting card.
+
+```java
+void stopSearch()
+```
+
+- **类路径：** `com.urovo.sdk.magcard.MagCardReaderImpl`
+- **Demo Activity（参考）：** MagCardReaderActivity
+- **源文档章节：** 8.2
+
+- Source section: `8.2`
+
+- Package/class path: `com.urovo.sdk.magcard.MagCardReaderImpl`
+
+- Demo reference: `UrovoPosSdkDemo/app/src/main/java/com/urovo/sdk/view/MagCardReaderActivity.java`
+
+
+
+Purpose:
+Remove the waiting card.
+
+
+Signature/prototype:
+```java
+void stopSearch()
+```
+
+
+Parameters:
+Input
+None
+Output
+None
+
+
+Return value:
+None
+
+
+Simplified example:
+```java
+MagCardReaderImpl.getInstance().stopSearch();
+```
+
+
+Source details:
+```text
+Prototype
+void stopSearch()
+Description
+Remove the waiting card.
+Parameters
+Input
+None
+Output
+None
+Return
+None
+Remark
+```