harmony 鸿蒙@ohos.nfc.cardEmulation (Standard NFC Card Emulation)

2022-08-09
浏览 (839)

@ohos.nfc.cardEmulation (Standard NFC Card Emulation)

The cardEmulation module implements Near-Field Communication (NFC) card emulation. You can use the APIs provided by this module to determine the card emulation type supported and implement Host-based Card Emulation (HCE).

NOTE

The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

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

FeatureType

Enumerates the NFC card emulation types.

NOTE This parameter is supported since API version 6 and deprecated since API version 9. You are advised to use hasHceCapability.

System capability: SystemCapability.Communication.NFC.CardEmulation

Name	Value	Description
HCE	0	HCE.
UICC	1	Subscriber identity module (SIM) card emulation.
ESE	2	embedded Secure Element (eSE) emulation.

CardType⁹⁺

Enumerates the types of services used by the card emulation application.

System capability: SystemCapability.Communication.NFC.CardEmulation

Name	Value	Description
PAYMENT	“payment”	Payment type.
OTHER	“other”	Other types.

isSupported

isSupported(feature: number): boolean

Checks whether a certain type of card emulation is supported.

NOTE This parameter is supported since API version 6 and deprecated since API version 9. You are advised to use hasHceCapability.

System capability: SystemCapability.Communication.NFC.CardEmulation

Parameters

Name	Type	Mandatory	Description
feature	number	Yes	Card emulation type. For details, see FeatureType.

Return value

Type	Description
boolean	Returns true if the card emulation type is supported; returns false otherwise.

hasHceCapability⁹⁺

hasHceCapability(): boolean

Checks whether HCE is supported.

System capability: SystemCapability.Communication.NFC.CardEmulation

Required permissions: ohos.permission.NFC_CARD_EMULATION

Return value

Type	Description
boolean	Returns true if HCE is supported; returns false otherwise.

isDefaultService⁹⁺

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

Checks whether an application is the default application of the specified service type.

System capability: SystemCapability.Communication.NFC.CardEmulation

Required permissions: ohos.permission.NFC_CARD_EMULATION

Parameters

Name	Type	Mandatory	Description
elementName	ElementName	Yes	Application description, which consists of the bundle name and component name.
type	CardType	Yes	Card emulation service type.

Return value

Type	Description
boolean	Returns true if the application is the default payment application; returns false otherwise.

HceService⁸⁺

Implements HCE, including receiving Application Protocol Data Units (APDUs) from the peer card reader and sending a response. Before using HCE-related APIs, check whether the device supports HCE. This API is used only for declaration and cannot be used currently.

startHCE⁸⁺

startHCE(aidList: string[]): boolean

Starts HCE, including setting the application to be foreground preferred and dynamically registering the application identifier (AID) list. This API is used only for declaration and cannot be used currently.

NOTE This API is supported since API version 8 and deprecated since API version 9. You are advised to use start.

Required permissions: ohos.permission.NFC_CARD_EMULATION

System capability: SystemCapability.Communication.NFC.CardEmulation

Parameters

Name	Type	Mandatory	Description
aidList	string[]	Yes	AID list to register.

start⁹⁺

start(elementName: ElementName, aidList: string[]): void

Required permissions: ohos.permission.NFC_CARD_EMULATION

System capability: SystemCapability.Communication.NFC.CardEmulation

Parameters

Name	Type	Mandatory	Description
elementName	ElementName	Yes	Element name of a service capability.
aidList	string[]	Yes	AID list to register.

Error codes

For details about the error codes, see NFC Error Codes.

ID	Error Message
3100301	Card emulation running state is abnormal in service.

stopHCE⁸⁺

stopHCE(): boolean

Stops HCE, including removing the foreground preferred attribute and releasing the dynamically registered AID list. This API is used only for declaration and cannot be used currently.

NOTE This API is supported since API version 8 and deprecated since API version 9. You are advised to use stop.

Required permissions: ohos.permission.NFC_CARD_EMULATION

System capability: SystemCapability.Communication.NFC.CardEmulation

stop⁹⁺

stop(elementName: ElementName): void;

Stops HCE, including removing the foreground preferred attribute and releasing the dynamically registered AID list. This API is used only for declaration and cannot be used currently.

Required permissions: ohos.permission.NFC_CARD_EMULATION

System capability: SystemCapability.Communication.NFC.CardEmulation

Parameters

Name	Type	Mandatory	Description
elementName	ElementName	Yes	Element name of a service capability.

Error codes

For details about the error codes, see NFC Error Codes.

ID	Error Message
3100301	Card emulation running state is abnormal in service.

on⁸⁺

on(type: “hceCmd”, callback: AsyncCallback): void;

Registers a callback to receive APDUs from the peer card reader. This API is used only for declaration and cannot be used currently.

Required permissions: ohos.permission.NFC_CARD_EMULATION

System capability: SystemCapability.Communication.NFC.CardEmulation

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type to subscribe to. The value is hceCmd.
callback	AsyncCallback	Yes	Callback invoked to return the APDU, which consists of hexadecimal numbers ranging from 0x00 to 0xFF.

sendResponse⁸⁺

sendResponse(responseApdu: number[]): void;

Sends a response to the peer card reader. This API is used only for declaration and cannot be used currently.

NOTE This API is supported since API version 8 and deprecated since API version 9. You are advised to use transmit.

Required permissions: ohos.permission.NFC_CARD_EMULATION

System capability: SystemCapability.Communication.NFC.CardEmulation

Parameters

Name	Type	Mandatory	Description
responseApdu	number[]	Yes	Response APDU sent to the peer card reader. The value consists of hexadecimal numbers ranging from 0x00 to 0xFF.

transmit⁹⁺

transmit(response: number[]): Promise<void>;

Sends a response to the peer card reader. This API is used only for declaration and cannot be used currently.

Required permissions: ohos.permission.NFC_CARD_EMULATION

System capability: SystemCapability.Communication.NFC.CardEmulation

Parameters

Name	Type	Mandatory	Description
responseApdu	number[]	Yes	Response APDU sent to the peer card reader. The value consists of hexadecimal numbers ranging from 0x00 to 0xFF.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see NFC Error Codes.

ID	Error Message
3100301	Card emulation running state is abnormal in service.

transmit⁹⁺

transmit(response: number[], callback: AsyncCallback<void>): void;

Sends a response to the peer card reader. This API is used only for declaration and cannot be used currently.

Required permissions: ohos.permission.NFC_CARD_EMULATION

System capability: SystemCapability.Communication.NFC.CardEmulation

Parameters

Name	Type	Mandatory	Description
responseApdu	number[]	Yes	Response APDU sent to the peer card reader. The value consists of hexadecimal numbers ranging from 0x00 to 0xFF.
callback	AsyncCallback<void>	Yes	Callback that returns no value.

Error codes

For details about the error codes, see NFC Error Codes.

ID	Error Message
3100301	Card emulation running state is abnormal in service.

Example

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

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

let hasHceCap = cardEmulation.hasHceCapability();
if (!hasHceCap) {
    console.log('this device hasHceCapability false, ignore it.');
}

let elementName: bundleManager.ElementName = {
    bundleName : "com.example.myapplication",
    abilityName : "EntryAbility",
};
let isDefaultService = cardEmulation.isDefaultService(elementName, cardEmulation.CardType.PAYMENT);
console.log('is the app is default service for this card type: ' + isDefaultService);

你可能感兴趣的鸿蒙文章

harmony 鸿蒙APIs

harmony 鸿蒙System Common Events (To Be Deprecated Soon)

harmony 鸿蒙System Common Events

harmony 鸿蒙API Reference Document Description

harmony 鸿蒙Enterprise Device Management Overview (for System Applications Only)

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager)

harmony 鸿蒙@ohos.distributedBundle (Distributed Bundle Management)

harmony 鸿蒙@ohos.bundle (Bundle)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)

0 赞

所属分类： 后端技术
本文标签：
版权声明： 原创文章如转载，请注明本文链接: https://www.seaxiang.com/blog/9da97ecb67e349abbee2baee60dbf1a7

harmony 鸿蒙@ohos.nfc.cardEmulation (Standard NFC Card Emulation)

@ohos.nfc.cardEmulation (Standard NFC Card Emulation)

Modules to Import

FeatureType

CardType⁹⁺

isSupported

hasHceCapability⁹⁺

isDefaultService⁹⁺

HceService⁸⁺

startHCE⁸⁺

start⁹⁺

stopHCE⁸⁺

stop⁹⁺

on⁸⁺

sendResponse⁸⁺

transmit⁹⁺

transmit⁹⁺

你可能感兴趣的鸿蒙文章

热门推荐

标签云

最新文章

本文目录

harmony 鸿蒙@ohos.nfc.cardEmulation (Standard NFC Card Emulation)

@ohos.nfc.cardEmulation (Standard NFC Card Emulation)

Modules to Import

FeatureType

CardType9+

isSupported

hasHceCapability9+

isDefaultService9+

HceService8+

startHCE8+

start9+

stopHCE8+

stop9+

on8+

sendResponse8+

transmit9+

transmit9+

你可能感兴趣的鸿蒙文章

热门推荐

标签云

最新文章

本文目录

CardType⁹⁺

hasHceCapability⁹⁺

isDefaultService⁹⁺

HceService⁸⁺

startHCE⁸⁺

start⁹⁺

stopHCE⁸⁺

stop⁹⁺

on⁸⁺

sendResponse⁸⁺

transmit⁹⁺

transmit⁹⁺