From fd227600b1b26c5f43dec3f471fc6346e785825a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=88=98=E5=98=89=E4=BC=9F?= Date: Wed, 25 May 2022 08:38:56 +0000 Subject: [PATCH] update zh-cn/application-dev/reference/apis/js-apis-nfcController.md. Signed-off-by: liujiawei --- .../reference/apis/js-apis-nfcController.md | 132 ++++++++++++++---- 1 file changed, 101 insertions(+), 31 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-nfcController.md b/zh-cn/application-dev/reference/apis/js-apis-nfcController.md index 87fc40e695..effcf1ae7a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-nfcController.md +++ b/zh-cn/application-dev/reference/apis/js-apis-nfcController.md @@ -1,6 +1,6 @@ -# 标准NFC-Tag +# 标准NFC -本模块主要用于操作及管理NFC Tag。 +本模块主要用于操作及管理NFC。 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 @@ -9,17 +9,30 @@ ## **导入模块** ``` -import tag from '@ohos.nfc.tag'; +import controller from '@ohos.nfc.controller'; ``` -## tag.getNfcATag +## controller.isNfcAvailable -getNfcATag(tagInfo: TagInfo): NfcATag +isNfcAvailable(): boolean -获取NFC A类型Tag对象，通过该对象访问NfcA技术类型的Tag。 +查询是否有NFC功能 -**需要权限**：ohos.permission.NFC_TAG +**返回值：** + +| **类型** | **说明** | +| -------- | -------- | +| boolean | true:有NFC功能， false:无NFC功能。 | + + +## controller.openNfc + +openNfc(): boolean + +打开NFC开关。 + +**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS **系统能力**：SystemCapability.Communication.NFC @@ -27,52 +40,109 @@ getNfcATag(tagInfo: TagInfo): NfcATag | **类型** | **说明** | | -------- | -------- | -| NfcATag | NFC A类型Tag对象 | +| boolean | true:打开NFC成功， false:打开NFC失败。 | -## tag.getNfcBTag +## controller.closeNfc -getNfcBTag(tagInfo: TagInfo): NfcBTag +closeNfc(): boolean -获取NFC B类型Tag对象，通过该对象访问NfcB技术类型的Tag。 +关闭NFC开关。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS **系统能力**：SystemCapability.Communication.NFC **返回值：** -| **类型** | **说明** | -| -------- | ---------------- | -| NfcBTag | NFC B类型Tag对象 | - -## tag.getNfcFTag +| **类型** | **说明** | +| -------- | ------------------------------------------- | +| boolean | true:关闭NFC成功， false:关闭NFC失败。 | -getNfcFTag(tagInfo: TagInfo): NfcFTag +## controller.isNfcOpen -获取NFC F类型Tag对象，通过该对象访问NfcF技术类型的Tag。 +isNfcOpen(): boolean -**需要权限**：ohos.permission.NFC_TAG +查询NFC是否打开。 **系统能力**：SystemCapability.Communication.NFC **返回值：** -| **类型** | **说明** | -| -------- | ---------------- | -| NfcFTag | NFC F类型Tag对象 | +| **类型** | **说明** | +| -------- | ----------------------------------- | +| boolean | true:NFC打开， false:NFC关闭。 | -## tag.getNfcVTag +## controller.getNfcState -getNfcVTag(tagInfo: TagInfo): NfcVTag +getNfcState(): boolean -获取NFC V类型Tag对象，通过该对象访问NfcV技术类型的Tag。 - -**需要权限**：ohos.permission.NFC_TAG +查询NFC是否打开。 **系统能力**：SystemCapability.Communication.NFC **返回值：** -| **类型** | **说明** | -| -------- | ---------------- | -| NfcVTag | NFC V类型Tag对象 | \ No newline at end of file +| **类型** | **说明** | +| -------- | ----------------------------------- | +| boolean | true:NFC打开， false:NFC关闭。 | + +## controller.on('nfcStateChange') + +on(type: "nfcStateChange", callback: Callback<NfcState>): void + +注册NFC开关状态事件。 + +**系统能力**：SystemCapability.Communication.NFC + +**参数** + + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 固定填"nfcStateChange"字符串 | + | callback | Callback<NfcState> | 是 | 状态改变回调函数。 | + + + +## controller.off('nfcStateChange') + +off(type: "nfcStateChange", callback?: Callback<NfcState>): void + +取消NFC开关状态事件的注册。 + +**系统能力**：SystemCapability.Communication.NFC + +**参数** + + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 固定填"nfcStateChange"字符串 | +| callback | Callback<NfcState> | 否 | 状态改变回调函数。如果callback不填，将“去注册”该事件关联的所有回调函数。 | + +**示例** + + ```js + import nfcController from '@ohos.nfcController'; + + var NFC_STATE_NOTIFY = "nfcStateChange"; + + var recvNfcStateNotifyFunc = result => { + console.info("nfc state receive state: " + result); + } + + // 注册事件 + nfcController.on(NFC_STATE_NOTIFY, recvNfcStateNotifyFunc); + + // 解注册事件 + nfcController.off(NFC_STATE_NOTIFY, recvNfcStateNotifyFunc); + ``` + +## NfcState + +表示NFC状态的枚举。 + +| 名称 | 默认值 | 说明 | +| -------- | -------- | -------- | +| STATE_OFF | 1 | NFC关闭状态 | +| STATE_TURNING_ON | 2 | NFC正在打开状态 | +| STATE_ON | 3 | NFC打开状态 | +| STATE_TURNING_OFF | 4 | NFC正在关闭状态 | -- GitLab