@ohos.nfc.cardEmulation (标准NFC-cardEmulation)


@ohos.nfc.cardEmulation (标准NFC-cardEmulation)

本模块主要提供NFC卡模拟业务,包括判断支持哪种卡模拟类型,HCE卡模拟的业务实现等。

说明:

本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import cardEmulation from '@ohos.nfc.cardEmulation';
1

FeatureType

定义不同的NFC卡模拟类型。

系统能力: SystemCapability.Communication.NFC.CardEmulation

名称 说明
HCE 0 HCE 卡模拟。
UICC 1 SIM 卡模拟。
ESE 2 ESE卡模拟。

CardType

定义卡模拟应用是支付类型,还是非支付类型。

系统能力: SystemCapability.Communication.NFC.CardEmulation

名称 说明
PAYMENT "payment" 卡模拟应用是支付类型。
OTHER "other" 卡模拟应用是非支付类型。

cardEmulation.isSupported

isSupported(feature: number): boolean

是否支持某种类型的卡模拟。

系统能力: SystemCapability.Communication.NFC.CardEmulation

参数:

参数名 类型 必填 说明
feature number 卡模拟类型值,详细请见FeatureType枚举值。

返回值:

类型 说明
boolean true: 支持该类型卡模拟, false: 不支持该类型卡模拟。

cardEmulation.isDefaultService

isDefaultService(elementName: ElementName, type: CardType): boolean

判断指定的应用是否为默认支付应用。

系统能力: SystemCapability.Communication.NFC.CardEmulation

参数:

参数名 类型 必填 说明
elementName ElementName 应用的描述,由Bundle名称和组件名称组成。
type CardType 应用的描述,由Bundle名称和组件名称组成。

返回值:

类型 说明
boolean true: 是默认支付应用, false: 不是默认支付应用。

HceService8+

提供HCE卡模拟的实现,主要包括接收对端读卡设备的APDU数据,并响应APDU数据到对端读卡设备。使用HCE相关接口前,必须先判断设备是否支持HCE卡模拟能力。

startHCE8+

startHCE(aidList: string[]): boolean

启动HCE业务功能。包括设置当前应用为前台优先,动态注册AID列表。

需要权限: ohos.permission.NFC_CARD_EMULATION

系统能力: SystemCapability.Communication.NFC.CardEmulation

参数:

参数名 类型 必填 说明
aidList string[] 动态注册卡模拟的AID列表。

stopHCE8+

stopHCE(): boolean

停止HCE业务功能。包括退出当前应用前台优先,释放动态注册的AID列表。

需要权限: ohos.permission.NFC_CARD_EMULATION

系统能力: SystemCapability.Communication.NFC.CardEmulation

on8+

on(type: "hceCmd", callback: AsyncCallback<number[]>): void;

订阅回调,用于接收对端读卡设备发送的APDU数据。

需要权限: ohos.permission.NFC_CARD_EMULATION

系统能力: SystemCapability.Communication.NFC.CardEmulation

参数:

参数名 类型 必填 说明
type string 固定填"hceCmd"字符串。
callback AsyncCallback<number[]> 订阅的事件回调,入参是符合APDU协议的数据,每个number十六进制表示,范围是0x00~0xFF。

sendResponse8+

sendResponse(responseApdu: number[]): void;

发送APDU数据到对端读卡设备。

需要权限: ohos.permission.NFC_CARD_EMULATION

系统能力: SystemCapability.Communication.NFC.CardEmulation

参数:

参数名 类型 必填 说明
responseApdu number[] 发送到对端读卡设备的符合APDU协议的数据,每个number十六进制表示,范围是0x00~0xFF。

示例:

import cardEmulation from '@ohos.nfc.cardEmulation';

var isHceSupported = cardEmulation.isSupported(cardEmulation.FeatureType.HCE);
if (!isHceSupported) {
    console.log('this device is not supported for HCE, ignore it.');
    return;
}

var elementName = {
    "bundleName": "com.test.cardemulation",
    "abilityName": "com.test.cardemulation.MainAbility",
};
var isDefaultService = cardEmulation.isDefaultService(elementName, cardEmulation.CardType.PAYMENT);
console.log('is the app is default service for this card type: ' + isDefaultService);

// device supports HCE, transimit APDU with remote nfc reader.
var hceService = new cardEmulation.HceService();
hceService.startHCE([
    "F0010203040506", "A0000000041010"
]);

hceService.on("hceCmd", (err, res) => {
    if(err.data === 0) {
        console.log('callback => Operation hceCmd succeeded. Data: ' + JSON.stringify(res));
          hceService.sendResponse([0x00,0xa4,0x04,0x00,
          0x0e,0x32,0x50,0x41,0x59,0x2e,0x53,0x59,0x53,0x2e,0x44,0x44,
          0x46,0x30,0x31,0x00]);
    } else {
        console.log('callback => Operation hceCmd failed. Cause: ' + err.data);
    }
})

// stop HCE when the application exit the nfc card emulation.
hceService.stopHCE();
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34