未验证 提交 de107495 编写于 作者: O openharmony_ci 提交者: Gitee

!11982 update nfc docs for js apis

Merge pull request !11982 from 张秀平/master
......@@ -64,8 +64,10 @@ readNdefTag(): Promise<string>
```js
import connectedTag from '@ohos.connectedTag';
connectedTag.readNdefTag().then(result => {
console.log("promise recv ndef response: " + result);
connectedTag.readNdefTag().then((data) => {
console.log("connectedTag readNdefTag Promise data = " + data);
}).catch((err)=> {
console.log("connectedTag readNdefTag Promise err: " + err);
});
```
......@@ -73,7 +75,7 @@ connectedTag.readNdefTag().then(result => {
readNdefTag(callback: AsyncCallback<string>): void
读取有源标签内容,使用callback方式作为异步方法。
读取有源标签内容,使用AsyncCallback方式作为异步方法。
**需要权限**:ohos.permission.NFC_TAG
......@@ -90,8 +92,12 @@ readNdefTag(callback: AsyncCallback<string>): void
```js
import connectedTag from '@ohos.connectedTag';
connectedTag.readNdefTag(result => {
console.log("callback recv ndef response: " + result);
connectedTag.readNdefTag((err, data)=> {
if (err) {
console.log("connectedTag readNdefTag AsyncCallback err: " + err);
} else {
console.log("connectedTag readNdefTag AsyncCallback data: " + data);
}
});
```
......@@ -122,21 +128,19 @@ writeNdefTag(data: string): Promise<void>
```js
import connectedTag from '@ohos.connectedTag';
connectedTag.write("010203")
.then((value) => {
// 事件写入正常
console.log(`success to write event: ${value}`);
}).catch((err) => {
// 事件写入异常
console.error(`failed to write event because ${err.code}`);
});
var rawData = "010203"; // change it tobe correct.
connectedTag.writeNdefTag(rawData).then(() => {
console.log("connectedTag writeNdefTag Promise success.");
}).catch((err)=> {
console.log("connectedTag writeNdefTag Promise err: " + err);
});
```
## connectedTag.writeNdefTag
writeNdefTag(data: string, callback: AsyncCallback<void>): void
写入内容到有源标签,使用callback方式作为异步方法。
写入内容到有源标签,使用AsyncCallback方式作为异步方法。
**需要权限**:ohos.permission.NFC_TAG
......@@ -147,22 +151,20 @@ writeNdefTag(data: string, callback: AsyncCallback<void>): void
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| data | string | 是 | 有源标签内容, 长度最大是1024个字节。 |
| callback | AsyncCallback<string> | 是 | 读取有源标签内容回调函数。 |
| callback | AsyncCallback<void> | 是 | 读取有源标签内容回调函数。 |
**示例:**
```js
import connectedTag from '@ohos.connectedTag';
connectedTag.writeNdefTag("010203", (err, value) => {
var rawData = "010203"; // change it tobe correct.
connectedTag.writeNdefTag(rawData, (err)=> {
if (err) {
// 事件写入异常
console.error(`failed to write event because ${err.code}`);
return;
console.log("connectedTag writeNdefTag AsyncCallback err: " + err);
} else {
console.log("connectedTag writeNdefTag AsyncCallback success.");
}
// 事件写入正常
console.log(`success to write event: ${value}`);
});
```
......@@ -205,15 +207,33 @@ off(type: "notify", callback?: Callback<number>): void
```js
import connectedTag from '@ohos.connectedTag';
var recvNfcRfNotifyFunc = result => {
console.info("nfc rf receive state: " + result);
}
// Register event
connectedTag.on("notify", recvNfcRfNotifyFunc);
connectedTag.on("notify", (err, rfState)=> {
if (err) {
console.log("connectedTag on Callback err: " + err);
} else {
console.log("connectedTag on Callback rfState: " + rfState);
}
});
var initStatus = connectedTag.init();
console.log("connectedTag init status: " + initStatus);
// Add nfc connecected tag business oprations here...
// connectedTag.writeNdefTag(rawData)
// connectedTag.readNdefTag()
var uninitStatus = connectedTag.uninit();
console.log("connectedTag uninit status: " + uninitStatus);
// Unregister event
connectedTag.off("notify", recvNfcRfNotifyFunc);
connectedTag.off("notify", (err, rfState)=> {
if (err) {
console.log("connectedTag off Callback err: " + err);
} else {
console.log("connectedTag off Callback rfState: " + rfState);
}
});
```
## NfcRfType
......
......@@ -206,6 +206,7 @@ getIsoDep(tagInfo: [TagInfo](#taginfo)): [IsoDepTag](js-apis-nfctech.md#isoDepTa
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state of service is abnormal. |
......@@ -233,6 +234,7 @@ getNdef(tagInfo: [TagInfo](#taginfo)): [NdefTag](js-apis-nfctech.md#ndeftag9)
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state of service is abnormal. |
......@@ -258,7 +260,9 @@ getMifareClassic(tagInfo: [TagInfo](#taginfo)): [MifareClassicTag](js-apis-nfcte
| [MifareClassicTag](js-apis-nfctech.md#mifareclassictag-9) | MIFARE Classic类型Tag对象,通过该对象访问MIFARE Classic类型的相关接口。 |
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state of service is abnormal. |
......@@ -285,6 +289,7 @@ getMifareUltralight(tagInfo: [TagInfo](#taginfo)): [MifareUltralightTag](js-apis
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state of service is abnormal. |
......@@ -306,6 +311,7 @@ getNdefFormatable(tagInfo: [TagInfo](#taginfo)): [NdefFormatableTag](js-apis-nfc
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state of service is abnormal. |
......@@ -617,10 +623,12 @@ NFC服务在读取到标签时给出的对象,通过改对象属性,应用
| **名称** | **类型** | **可读** | **可写** | **说明** |
| -------- | -------- | -------- | -------- | -------- |
| uid<sup>9+</sup> | number[] | 是 | 否 | 标签的uid,每个number值是十六进制表示,范围是0x00~0xFF。 |
| uid<sup>9+</sup> | number[] | 是 | 否 | 标签的uid,每个number值是十六进制表示,范围是0x00~0xFF。|
| technology<sup>9+</sup> | number[] | 是 | 否 | 支持的技术类型,每个number值表示所支持技术类型的常量值。 |
| supportedProfiles | number[] | 是 | 否 | 支持的技术类型,从API9开始不支持,使用technology替代。 |
| supportedProfiles | number[] | 是 | 否 | 支持的技术类型,从API9开始不支持,使用[tag.TagInfo#technology](#taginfo)替代。|
| extrasData | [PacMap](js-apis-dataAbilityHelper.md#pacmap)[] | 是 | 否 | 此属性为系统属性,仅限内部使用。标签所支持技术的扩展属性值。|
| tagRfDiscId | number | 是 | 否 | 此属性为系统属性,仅限内部使用。标签发现时分配的ID值。|
| remoteTagService | [rpc.RemoteObject](js-apis-rpc.md#remoteobject) | 是 | 否 | 此属性为系统属性,仅限内部使用。NFC服务进程的远端对象,用于客户端和服务之间的接口通信。|
## NdefRecord<sup>9+</sup>
NDEF标签Record属性的定义,参考NDEF标签技术规范《NFCForum-TS-NDEF_1.0》的定义细节。
......@@ -658,12 +666,12 @@ NDEF Record的TNF(Type Name Field)类型值,参考NDEF标签技术规范《NFC
| **名称** | **值** | **说明** |
| -------- | -------- | -------- |
| TNF_EMPTY | 0x0 | Empty。|
| TNF_WELL_KNOWN | 0x01 | NFC Forum well-known type [NFC RTD]。|
| TNF_MEDIA | 0x02 | Media-type as defined in RFC 2046 [RFC 2046]。|
| TNF_ABSOLUTE_URI | 0x03 | Absolute URI as defined in RFC 3986 [RFC 3986]。|
| TNF_EXT_APP | 0x04 | NFC Forum external type [NFC RTD]。|
| TNF_UNKNOWN | 0x05 | Unknown。|
| TNF_UNCHANGED | 0x06 | Unchanged (see section 2.3.3)。|
| TNF_WELL_KNOWN | 0x1 | NFC Forum well-known type [NFC RTD]。|
| TNF_MEDIA | 0x2 | Media-type as defined in RFC 2046 [RFC 2046]。|
| TNF_ABSOLUTE_URI | 0x3 | Absolute URI as defined in RFC 3986 [RFC 3986]。|
| TNF_EXT_APP | 0x4 | NFC Forum external type [NFC RTD]。|
| TNF_UNKNOWN | 0x5 | Unknown。|
| TNF_UNCHANGED | 0x6 | Unchanged (see section 2.3.3)。|
## NDEF Record RTD类型定义
NDEF Record的RTD(Record Type Definition)类型值,参考NDEF标签技术规范《NFCForum-TS-NDEF_1.0》的定义细节。
......
......@@ -326,6 +326,7 @@ isExtendedApduSupported(): Promise&lt;boolean&gt;
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -376,6 +377,7 @@ isExtendedApduSupported(callback: AsyncCallback\<boolean>): void
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -535,6 +537,7 @@ readNdef(): Promise\<[NdefMessage](#ndefmessage9)>
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -584,6 +587,7 @@ readNdef(callback: AsyncCallback\<[NdefMessage](#ndefmessage9)>): void
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -635,6 +639,7 @@ writeNdef(msg: NdefMessage): Promise\<void>;
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -688,6 +693,7 @@ writeNdef(msg: [NdefMessage](#ndefmessage9), callback: AsyncCallback\<void>): vo
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -742,6 +748,7 @@ canSetReadOnly(): boolean
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -769,6 +776,7 @@ setReadOnly(): Promise\<void>
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -818,6 +826,7 @@ setReadOnly(callback: AsyncCallback\<void>): void
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -914,6 +923,7 @@ authenticateSector(sectorIndex: number, key: number[], isKeyA: boolean): Promise
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -968,6 +978,7 @@ authenticateSector(sectorIndex: number, key: number[], isKeyA: boolean, callback
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -1026,6 +1037,7 @@ readSingleBlock(blockIndex: number): Promise\<number[]>
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -1077,6 +1089,7 @@ readSingleBlock(blockIndex: number, callback: AsyncCallback\<number[]>): void
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -1130,6 +1143,7 @@ writeSingleBlock(blockIndex: number, data: number[]): Promise\<void>
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -1184,6 +1198,7 @@ writeSingleBlock(blockIndex: number, data: number[], callback: AsyncCallback\<vo
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -1239,6 +1254,7 @@ incrementBlock(blockIndex: number, value: number): Promise\<void>
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -1292,6 +1308,7 @@ incrementBlock(blockIndex: number, value: number, callback: AsyncCallback\<void>
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -1346,6 +1363,7 @@ decrementBlock(blockIndex: number, value: number): Promise\<void>
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -1399,6 +1417,7 @@ decrementBlock(blockIndex: number, value: number, callback: AsyncCallback\<void>
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -1452,6 +1471,7 @@ transferToBlock(blockIndex: number): Promise\<void>
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -1503,6 +1523,7 @@ transferToBlock(blockIndex: number, callback: AsyncCallback\<void>): void
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -1555,6 +1576,7 @@ restoreFromBlock(blockIndex: number): Promise\<void>
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -1606,6 +1628,7 @@ restoreFromBlock(blockIndex: number, callback: AsyncCallback\<void>): void
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -1876,6 +1899,7 @@ readMultiplePages(pageIndex: number): Promise\<number[]>
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -1928,6 +1952,7 @@ readMultiplePages(pageIndex: number, callback: AsyncCallback\<number[]>): void
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -1981,6 +2006,7 @@ writeSinglePage(pageIndex: number, data: number[]): Promise\<void>
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -2034,6 +2060,7 @@ writeSinglePage(pageIndex: number, data: number[], callback: AsyncCallback\<void
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -2119,6 +2146,7 @@ format(message: [NdefMessage](#ndefmessage9)): Promise\<void>
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......@@ -2227,6 +2255,7 @@ formatReadOnly(message: [NdefMessage](#ndefmessage9)): Promise\<void>
**错误码:**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)
| 错误码ID | 错误信息|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册