Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
e78e7fb7
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
e78e7fb7
编写于
8月 12, 2022
作者:
O
openharmony_ci
提交者:
Gitee
8月 12, 2022
浏览文件
操作
浏览文件
下载
差异文件
!8025 【OpenHarmony开源贡献者计划2022】Modify nfc tags api description
Merge pull request !8025 from guoyanwen/master
上级
c2f0d634
2ca92d82
变更
3
显示空白变更内容
内联
并排
Showing
3 changed file
with
121 addition
and
98 deletion
+121
-98
zh-cn/application-dev/reference/apis/js-apis-nfcTag.md
zh-cn/application-dev/reference/apis/js-apis-nfcTag.md
+19
-19
zh-cn/application-dev/reference/apis/js-apis-nfctech.md
zh-cn/application-dev/reference/apis/js-apis-nfctech.md
+99
-77
zh-cn/application-dev/reference/apis/js-apis-tagSession.md
zh-cn/application-dev/reference/apis/js-apis-tagSession.md
+3
-2
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-nfcTag.md
浏览文件 @
e78e7fb7
...
...
@@ -7,13 +7,13 @@
## **导入模块**
```
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
```
## tag.getNfcATag
getNfcATag(tagInfo:
[
TagInfo
](
#
TagInfo
<sup>
9+
</sup>
)):
[
NfcATag
](
js-apis-nfctech.md#NfcAT
ag
)
getNfcATag(tagInfo:
[
TagInfo
](
#
taginfo9
)
):
[
NfcATag
](
js-apis-nfctech.md#nfcat
ag
)
获取NFC A类型Tag对象,通过该对象可访问NfcA技术类型的Tag。
...
...
@@ -25,11 +25,11 @@ getNfcATag(tagInfo: [TagInfo](#TagInfo<sup>9+</sup>)): [NfcATag](js-apis-nfctech
|
**类型**
|
**说明**
|
| -------- | -------- |
|
[
NfcATag
](
js-apis-nfctech.md#
NfcAT
ag
)
| NFC A类型Tag对象。 |
|
[
NfcATag
](
js-apis-nfctech.md#
nfcat
ag
)
| NFC A类型Tag对象。 |
## tag.getNfcBTag
getNfcBTag(tagInfo:
[
TagInfo
](
#
TagInfo
<sup>
9+
</sup>
)):
[
NfcBTag
](
js-apis-nfctech.md#NfcBT
ag
)
getNfcBTag(tagInfo:
[
TagInfo
](
#
taginfo9
)
):
[
NfcBTag
](
js-apis-nfctech.md#nfcbt
ag
)
获取NFC B类型Tag对象,通过该对象可访问NfcB技术类型的Tag。
...
...
@@ -41,11 +41,11 @@ getNfcBTag(tagInfo: [TagInfo](#TagInfo<sup>9+</sup>)): [NfcBTag](js-apis-nfctech
|
**类型**
|
**说明**
|
| -------- | ---------------- |
|
[
NfcBTag
](
js-apis-nfctech.md#
NfcBT
ag
)
| NFC B类型Tag对象。 |
|
[
NfcBTag
](
js-apis-nfctech.md#
nfcbt
ag
)
| NFC B类型Tag对象。 |
## tag.getNfcFTag
getNfcFTag(tagInfo:
[
TagInfo
](
#
TagInfo
<sup>
9+
</sup>
)):
[
NfcFTag
](
js-apis-nfctech.md#NfcFT
ag
)
getNfcFTag(tagInfo:
[
TagInfo
](
#
taginfo9
)
):
[
NfcFTag
](
js-apis-nfctech.md#nfcft
ag
)
获取NFC F类型Tag对象,通过该对象可访问NfcF技术类型的Tag。
...
...
@@ -57,11 +57,11 @@ getNfcFTag(tagInfo: [TagInfo](#TagInfo<sup>9+</sup>)): [NfcFTag](js-apis-nfctech
|
**类型**
|
**说明**
|
| -------- | ---------------- |
|
[
NfcFTag
](
js-apis-nfctech.md#
NfcFT
ag
)
| NFC F类型Tag对象。 |
|
[
NfcFTag
](
js-apis-nfctech.md#
nfcft
ag
)
| NFC F类型Tag对象。 |
## tag.getNfcVTag
getNfcVTag(tagInfo:
[
TagInfo
](
#
TagInfo
<sup>
9+
</sup>
)):
[
NfcVTag
](
js-apis-nfctech.md#NfcVT
ag
)
getNfcVTag(tagInfo:
[
TagInfo
](
#
taginfo9
)
):
[
NfcVTag
](
js-apis-nfctech.md#nfcvt
ag
)
获取NFC V类型Tag对象,通过该对象可访问NfcV技术类型的Tag。
...
...
@@ -73,11 +73,11 @@ getNfcVTag(tagInfo: [TagInfo](#TagInfo<sup>9+</sup>)): [NfcVTag](js-apis-nfctech
|
**类型**
|
**说明**
|
| -------- | ---------------- |
|
[
NfcVTag
](
js-apis-nfctech.md#
NfcVT
ag
)
| NFC V类型Tag对象。 |
|
[
NfcVTag
](
js-apis-nfctech.md#
nfcvt
ag
)
| NFC V类型Tag对象。 |
## tag.getIsoDepTag<sup>9+</sup>
getIsoDepTag(tagInfo:
[
TagInfo
](
#
TagInfo
<sup>
9+
</sup>
)):
[
IsoDepTag
](
js-apis-nfctech.md#IsoDepTag
)
getIsoDepTag(tagInfo:
[
TagInfo
](
#
taginfo9
)
):
[
IsoDepTag
](
js-apis-nfctech.md#isoDepTag9
)
获取IsoDep类型Tag对象,通过该对象可访问Iso Dep技术类型的Tag。
...
...
@@ -90,11 +90,11 @@ getIsoDepTag(tagInfo: [TagInfo](#TagInfo<sup>9+</sup>)): [IsoDepTag](js-apis-nfc
|
**类型**
|
**说明**
|
| ---------- | ------------------|
|
[
IsoDepTag
](
js-apis-nfctech.md#
IsoDepTag
>
)
| Iso Dep类型Tag对象。 |
|
[
IsoDepTag
](
js-apis-nfctech.md#
isodeptag9
>
)
| Iso Dep类型Tag对象。 |
## tag.getNdefTag<sup>9+</sup>
getNdefTag(tagInfo:
[
TagInfo
](
#
TagInfo
<sup>
9+
</sup>
)):
[
NdefTag
](
js-apis-nfctech.md#NdefTag-5
)
getNdefTag(tagInfo:
[
TagInfo
](
#
taginfo9
)
):
[
NdefTag
](
js-apis-nfctech.md#ndefTag9
)
获取Ndef类型Tag对象,通过该对象可访问Ndef技术类型的Tag。
...
...
@@ -107,11 +107,11 @@ getNdefTag(tagInfo: [TagInfo](#TagInfo<sup>9+</sup>)): [NdefTag](js-apis-nfctech
|
**类型**
|
**说明**
|
| ---------| -------------- |
|
[
NdefTag
](
js-apis-nfctech.md#
NdefTag
)
| Ndef类型Tag对象。|
|
[
NdefTag
](
js-apis-nfctech.md#
ndefTag9
)
| Ndef类型Tag对象。|
## tag.getMifareClassicTag<sup>9+</sup>
getMifareClassicTag(tagInfo:
[
TagInfo
](
#
TagInfo
<sup>
9+
</sup>
)):
[
MifareClassicTag
](
js-apis-nfctech.md#MifareClassicTag
)
getMifareClassicTag(tagInfo:
[
TagInfo
](
#
taginfo9
)
):
[
MifareClassicTag
](
js-apis-nfctech.md#mifareclassictag9
)
获取Mifare Classic类型Tag对象,通过该对象访问Mifare Classic技术类型的Tag。
...
...
@@ -123,11 +123,11 @@ getMifareClassicTag(tagInfo: [TagInfo](#TagInfo<sup>9+</sup>)): [MifareClassicTa
|
**类型**
|
**说明**
|
| ----------------- | ------------------------|
|
[
MifareClassicTag
](
js-apis-nfctech.md#
MifareClassicTag
)
| Mifare Classic类型Tag对象
|
|
[
MifareClassicTag
](
js-apis-nfctech.md#
mifareclassictag9
)
| Mifare Classic类型Tag对象。
|
## tag.getMifareUltralightTag<sup>9+</sup>
getMifareUltralightTag(tagInfo:
[
TagInfo
](
#
TagInfo
<sup>
9+
</sup>
)):
[
MifareUltralightTag
](
js-apis-nfctech.md#MifareUltralightTag
)
getMifareUltralightTag(tagInfo:
[
TagInfo
](
#
taginfo9
)
):
[
MifareUltralightTag
](
js-apis-nfctech.md#mifareultralighttag9
)
获取Mifare Ultralight类型Tag对象,通过该对象可访问Mifare Ultralight技术类型的Tag。
...
...
@@ -139,11 +139,11 @@ getMifareUltralightTag(tagInfo: [TagInfo](#TagInfo<sup>9+</sup>)): [MifareUltral
|
**类型**
|
**说明**
|
| -------------------- | ---------------------------|
|
[
MifareUltralightTag
](
js-apis-nfctech.md#
MifareUltralightTag
)
| Mifare Ultralight类型Tag对象
|
|
[
MifareUltralightTag
](
js-apis-nfctech.md#
mifareultralighttag9
)
| Mifare Ultralight类型Tag对象。
|
## tag.getNdefFormatableTag<sup>9+</sup>
getNdefFormatableTag(tagInfo:
[
TagInfo
](
#
TagInfo
<sup>
9+
</sup>
)):
[
NdefFormatableTag
](
js-apis-nfctech.md#NdefFormatableTag
)
getNdefFormatableTag(tagInfo:
[
TagInfo
](
#
taginfo9
)
):
[
NdefFormatableTag
](
js-apis-nfctech.md#ndefformatabletag9
)
获取Ndef Formatable类型Tag对象,通过该对象可访问Ndef Formatable技术类型的Tag。
...
...
@@ -155,7 +155,7 @@ getNdefFormatableTag(tagInfo: [TagInfo](#TagInfo<sup>9+</sup>)): [NdefFormatable
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
|
[
NdefFormatableTag
](
js-apis-nfctech.md#
NdefFormatableT
ag
)
| Ndef Formatable类型Tag对象。 |
|
[
NdefFormatableTag
](
js-apis-nfctech.md#
ndefformatablet
ag
)
| Ndef Formatable类型Tag对象。 |
## TagInfo<sup>9+</sup>
...
...
zh-cn/application-dev/reference/apis/js-apis-nfctech.md
浏览文件 @
e78e7fb7
...
...
@@ -7,15 +7,15 @@
## **导入模块**
```
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
```
## NfcATag
### 继承 TagSession
NfcATag 提供 NFC-A(ISO 14443-3A)技术的属性和I/O操作的访问,继承自TagSession。
t
agSession是所有Nfc tag 技术类型的基类, 提供建立连接和发送数据等共同接口。具体请参见
[
TagSession
](
js-apis-tagSession.md
)
。
T
agSession是所有Nfc tag 技术类型的基类, 提供建立连接和发送数据等共同接口。具体请参见
[
TagSession
](
js-apis-tagSession.md
)
。
以下是NfcATag的独有接口。
...
...
@@ -73,9 +73,9 @@ console.log("atqa:" +atqa);
## NfcBTag
### 继承 TagSession
NfcBTag 提供对NFC-B(ISO 14443-3B)技术的属性和I/O操作的访问,继承自TagSession。
tagSession是所有Nfc tag 技术类型的基类,
提供建立连接和发送数据等共同接口。具体请参见
[
TagSession
](
js-apis-tagSession.md
)
。
TagSession是所有Nfc tag 技术类型的基类,
提供建立连接和发送数据等共同接口。具体请参见
[
TagSession
](
js-apis-tagSession.md
)
。
以下是NfcBTag的独有接口。
...
...
@@ -133,9 +133,9 @@ console.log("appData:" +protocol);
## NfcFTag
### 继承 TagSession
NfcFTag 提供对NFC-F(JIS 6319-4)技术的属性和I/O操作的访问,继承自TagSession。
t
agSession是所有Nfc tag 技术类型的基类, 提供建立连接和发送数据等共同接口。具体请参见
[
TagSession
](
js-apis-tagSession.md
)
。
T
agSession是所有Nfc tag 技术类型的基类, 提供建立连接和发送数据等共同接口。具体请参见
[
TagSession
](
js-apis-tagSession.md
)
。
以下是NfcFTag的独有接口。
...
...
@@ -182,6 +182,7 @@ getPmm(): number[]
| number[] | NfcF 标签的PMm信息。|
**示例:**
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
...
...
@@ -192,9 +193,9 @@ console.log("pmm:" +pmm);
## NfcVTag
### 继承 TagSession
NfcVTag 提供对NFC-V(ISO 15693)技术的属性和I/O操作的访问,继承自TagSession。
t
agSession是所有Nfc tag 技术类型的基类, 提供建立连接和发送数据等共同接口。具体请参见
[
TagSession
](
js-apis-tagSession.md
)
。
T
agSession是所有Nfc tag 技术类型的基类, 提供建立连接和发送数据等共同接口。具体请参见
[
TagSession
](
js-apis-tagSession.md
)
。
以下是NfcVTag的独有接口。
...
...
@@ -250,11 +251,11 @@ let dsfId = tag.getNfcVTag(taginfo).getDsfId();
console
.
log
(
"
dsfId:
"
+
dsfId
);
```
## IsoDepTag
<sup>9+</sup>
## IsoDepTag<sup>9+</sup>
### 继承 TagSession
IsoDepTag 提供对ISO-DEP(ISO 14443-4)技术的属性和I/O操作的访问,继承自TagSession。
t
agSession是所有Nfc tag 技术类型的基类, 提供建立连接和发送数据等共同接口。具体请参见
[
TagSession
](
js-apis-tagSession.md
)
。
T
agSession是所有Nfc tag 技术类型的基类, 提供建立连接和发送数据等共同接口。具体请参见
[
TagSession
](
js-apis-tagSession.md
)
。
以下是IsoDepTag的独有接口。
...
...
@@ -363,17 +364,17 @@ tag.getIsoDepTag(taginfo).isExtendedApduSupported(function (error, has) {
})
```
## NdefTag
<sup>9+</sup>
## NdefTag<sup>9+</sup>
### 继承 TagSession
提供对已格式化为NDEF的NFC标签的数据和操作的访问,继承自TagSession。
t
agSession是所有Nfc tag 技术类型的基类, 提供建立连接和发送数据等共同接口。具体请参见
[
TagSession
](
js-apis-tagSession.md
)
。
T
agSession是所有Nfc tag 技术类型的基类, 提供建立连接和发送数据等共同接口。具体请参见
[
TagSession
](
js-apis-tagSession.md
)
。
以下是NdefTag的独有接口。
### NdefTag.createNdefMessage<sup>9+</sup>
createNdefMessage(data: string):
[
NdefMessage
](
#
NdefMessage
<sup>
9+
</sup>
)
createNdefMessage(data: string):
[
NdefMessage
](
#
ndefmessage9
)
使用原始字节创建ndef消息。
...
...
@@ -391,7 +392,7 @@ createNdefMessage(data: string): [NdefMessage](#NdefMessage<sup>9+</sup>)
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
|
[
NdefMessage
](
#
NdefMessage
<sup>
9+
</sup>
) | Ndef消息 |
|
[
NdefMessage
](
#
ndefmessage9
)
| Ndef消息 |
**示例:**
...
...
@@ -406,7 +407,7 @@ let NdefMessage = tag.NdefTag(taginfo).createNdefMessage(data);
### NdefMessage.getNdefRecords<sup>9+</sup>
getNdefRecords():
[
NdefRecord
](
#
NdefRecord
<sup>
9+
</sup>
)[ ]
getNdefRecords():
[
NdefRecord
](
#
ndefrecord9
)[
]
获取ndef消息的所有记录。
...
...
@@ -418,7 +419,7 @@ getNdefRecords(): [NdefRecord](#NdefRecord<sup>9+</sup>)[ ]
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
|
[
NdefRecord
](
#
NdefRecord
<sup>
9+
</sup>
)[ ] | Ndef消息所包含的所有记录。 |
|
[
NdefRecord
](
#
ndefrecord9
)[
]
| Ndef消息所包含的所有记录。 |
**示例:**
...
...
@@ -434,7 +435,7 @@ let NdefRecord = tag.NdefTag(taginfo).getNdefRecords();
|
**参数名**
|
**类型**
|
**说明**
|
| -------- | -------- | -------- |
| tnf | number | 标签的uid。 |
|
[
rtdType
](
#
RtdType
<sup>
9+
</sup>
) | string | 支持的技术类型。 |
|
[
rtdType
](
#
rtdtype9
)
| string | 支持的技术类型。 |
| id | string | 标签的额外信息。 |
| payload | string | 标签的RF discovery id。 |
...
...
@@ -447,7 +448,7 @@ let NdefRecord = tag.NdefTag(taginfo).getNdefRecords();
### NdefTag.createNdefMessage<sup>9+</sup>
createNdefMessage(ndefRecords: NdefRecord
[
]): [NdefMessage
](
#
NdefMessage
<sup>
9+
</sup>
)
createNdefMessage(ndefRecords: NdefRecord
[
]): [NdefMessage
](
#
ndefmessage9
)
使用记录列表创建ndef消息。
...
...
@@ -458,13 +459,13 @@ createNdefMessage(ndefRecords: NdefRecord[]): [NdefMessage](#NdefMessage<sup>9+<
**参数:**
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| ndefRecords |
[
NdefRecord
](
#
NdefRecord
<sup>
9+
</sup>
)[] | 是 | NdefRecord记录列表
|
| ndefRecords |
[
NdefRecord
](
#
ndefrecord9
)[]
| 是 | NdefRecord记录列表。
|
**返回值:**
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
|
[
NdefMessage
](
#
NdefMessage
<sup>
9+
</sup>
) | Ndef消息。|
|
[
NdefMessage
](
#
ndefmessage9
)
| Ndef消息。|
**示例:**
...
...
@@ -489,7 +490,7 @@ getNdefTagType(): NfcForumType
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
|
[
NfcForumType
](
#
NfcForumType
<sup>
9+
</sup>
) | Ndef标签类型。|
|
[
NfcForumType
](
#
nfcforumtype9
)
| Ndef标签类型。|
**示例:**
...
...
@@ -514,7 +515,7 @@ getNdefMessage(): NdefMessage
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
|
[
NdefMessage
](
#
NdefMessage
<sup>
9+
</sup>
) | Ndef消息。|
|
[
NdefMessage
](
#
ndefmessage9
)
| Ndef消息。|
**示例:**
...
...
@@ -551,6 +552,7 @@ tag.NdefTag(taginfo).isNdefWritable().then(function (has) {
console
.
log
(
JSON
.
stringify
(
has
))
})
```
### NdefTag.isNdefWritable<sup>9+</sup>
isNdefWritable(callback: AsyncCallback
<
boolean
>
): void;
...
...
@@ -593,7 +595,7 @@ readNdef(): Promise\<NdefMessage>
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
| Promise
\<
NdefMessage
> | 以Promise形式返回从标签中读取到的NdefMessage信息。|
| Promise
\<
[
NdefMessage
](
#ndefmessage9
)
> | 以Promise形式返回从标签中读取到的NdefMessage信息。|
**示例:**
...
...
@@ -605,9 +607,10 @@ tag.NdefTag(taginfo).readNdef().then(function (ndefMessage) {
console
.
log
(
JSON
.
stringify
(
ndefMessage
))
})
```
### NdefTag.readNdef<sup>9+</sup>
readNdef(callback: AsyncCallback
\<
NdefMessage
>): void
readNdef(callback: AsyncCallback
\<
[
NdefMessage
](
#ndefmessage9
)
>): void
读取标签上的ndef消息,使用callback方式作为异步方法。
...
...
@@ -619,7 +622,7 @@ readNdef(callback: AsyncCallback\<NdefMessage>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback
\<
[
NdefMessage
](
#
NdefMessage
<sup>
9+
</sup>
)> | 是 | 回调函数。|
| callback | AsyncCallback
\<
[
NdefMessage
](
#
ndefmessage9
)
> | 是 | 回调函数。|
**示例:**
...
...
@@ -632,6 +635,7 @@ tag.NdefTag(taginfo).readNdef(function (error, ndefMessage) {
console
.
log
(
'
ndefMessage:
'
+
ndefMessage
)
})
```
### NdefTag.writeNdef<sup>9+</sup>
writeNdef(msg: NdefMessage): Promise
\<
number>;
...
...
@@ -664,6 +668,7 @@ NdefTag.writeNdef(msg).then(function (netHandle) {
console
.
log
(
JSON
.
stringify
(
netHandle
))
})
```
### NdefTag.writeNdef<sup>9+</sup>
writeNdef(msg: NdefMessage, callback: AsyncCallback
\<
number>): void
...
...
@@ -692,6 +697,7 @@ tag.NdefTag(taginfo).write(msg,function (error, has) {
console
.
log
(
'
has:
'
+
has
)
})
```
### NdefTag.canSetReadOnly<sup>9+</sup>
canSetReadOnly(): Promise
\<
boolean>
...
...
@@ -718,6 +724,7 @@ tag.NdefTag(taginfo).canSetReadOnly().then(function (has) {
console
.
log
(
JSON
.
stringify
(
has
))
})
```
### NdefTag.canSetReadOnly<sup>9+</sup>
isNdefWritable(callback: AsyncCallback
<
boolean
>
): void;
...
...
@@ -745,6 +752,7 @@ tag.NdefTag(taginfo).canSetReadOnly(function (error, has) {
console
.
log
(
'
has:
'
+
has
)
})
```
### NdefTag.setReadOnly<sup>9+</sup>
setReadOnly(): Promise
\<
number>
...
...
@@ -771,6 +779,7 @@ tag.NdefTag(taginfo).setReadOnly().then(function (errcode) {
console
.
log
(
JSON
.
stringify
(
errcode
))
})
```
### NdefTag.setReadOnly<sup>9+</sup>
setReadOnly(callback: AsyncCallback
<number>
): void
...
...
@@ -798,9 +807,10 @@ tag.NdefTag(taginfo).setReadOnly(function (error, errcode) {
console
.
log
(
'
has:
'
+
errcode
)
})
```
### NdefTag.getNdefTagTypeString<sup>9+</sup>
getNdefTagTypeString(type:
[
NfcForumType
](
#
NfcForumType
<sup>
9+
</sup>
)): string
getNdefTagTypeString(type:
[
NfcForumType
](
#
nfcforumtype9
)
): string
将Nfc论坛类型转换为Nfc论坛中定义的字节数组。
...
...
@@ -812,7 +822,7 @@ getNdefTagTypeString(type: [NfcForumType](#NfcForumType<sup>9+</sup>)): string
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| type |
[
NfcForumType
](
#
NfcForumType
<sup>
9+
</sup>
) | 是 | NfcForum论坛类型。 |
| type |
[
NfcForumType
](
#
nfcforumtype9
)
| 是 | NfcForum论坛类型。 |
**返回值:**
...
...
@@ -841,9 +851,9 @@ let ndefTypeString= tag.NdefTag(taginfo).getNdefTagTypeString(type);
## MifareClassicTag <sup>9+</sup>
### 继承 TagSession
MifareClassicTag提供对MIFARE经典属性和I/O操作的访问,继承自TagSession。
t
agSession是所有Nfc tag 技术类型的基类, 提供建立连接和发送数据等共同接口。具体请参见
[
TagSession
](
js-apis-tagSession.md
)
。
T
agSession是所有Nfc tag 技术类型的基类, 提供建立连接和发送数据等共同接口。具体请参见
[
TagSession
](
js-apis-tagSession.md
)
。
以下是MifareClassicTag的独有接口。
...
...
@@ -946,6 +956,7 @@ tag.MifareClassicTag(taginfo).readSingleBlock(blockIndex).then(function (data){
console
.
log
(
'
data:
'
+
data
)
})
```
### MifareClassicTag.readSingleBlock<sup>9+</sup>
readSingleBlock(blockIndex: number, callback: AsyncCallback
\<
string>): void
...
...
@@ -975,6 +986,7 @@ tag.MifareClassicTag(taginfo).readSingleBlock(blockIndex, function (error, data)
console
.
log
(
'
data:
'
+
data
)
})
```
### MifareClassicTag.writeSingleBlock<sup>9+</sup>
writeSingleBlock(blockIndex: number, data: string): Promise
\<
number>
...
...
@@ -1192,7 +1204,9 @@ transferToBlock(blockIndex: number): Promise\<number>
| Promise
\<
number> | 执行复制操作返回的错误代码。如果返回0,表示成功;否则返回错误码。|
**示例:**
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
// tagInfo is an Object given by nfc service when tag is dispatched.
...
...
@@ -1253,7 +1267,9 @@ restoreFromBlock(blockIndex: number): Promise\<number>
| Promise
\<
number> | 执行复制操作返回的错误代码。如果返回0,表示成功;否则返回错误码。|
**示例:**
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
// tagInfo is an Object given by nfc service when tag is dispatched.
...
...
@@ -1349,7 +1365,7 @@ let blockNumber = tag.MifareClassicTag(taginfo).getBlockCountInSector(sectorInde
### MifareClassicTag.getType<sup>9+</sup>
getType():
[
MifareClassicType
](
#
MifareClassicType
<sup>
9+
</sup>
)
getType():
[
MifareClassicType
](
#
mifareclassictype9
)
获取MifareClassic标签的类型。
...
...
@@ -1361,7 +1377,7 @@ getType(): [MifareClassicType](#MifareClassicType<sup>9+</sup>)
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
|
[
MifareClassicType
](
#
MifareClassicType
<sup>
9+
</sup>
) | MifareClassic标签的类型。|
|
[
MifareClassicType
](
#
mifareclassictype9
)
| MifareClassic标签的类型。|
**示例:**
...
...
@@ -1376,7 +1392,7 @@ let type = tag.MifareClassicTag(taginfo).getType();
getTagSize(): number
获取标签的大小(字节),具体请参见
[
MifareTagSize
](
#
MifareTagSize
<sup>
9+
</sup>
)。
获取标签的大小(字节),具体请参见
[
MifareTagSize
](
#
mifaretagsize9
)
。
**需要权限**
:ohos.permission.NFC_TAG
...
...
@@ -1386,7 +1402,7 @@ getTagSize(): number
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
| number | 标签的大小,单位为字节,请参见
[
MifareTagSize
](
#
MifareTagSize
<sup>
9+
</sup>
)。|
| number | 标签的大小,单位为字节,请参见
[
MifareTagSize
](
#
mifaretagsize9
)
。|
**示例:**
...
...
@@ -1437,7 +1453,7 @@ isEmulatedTag(): boolean
import
tag
from
'
@ohos.nfc.tag
'
;
// tagInfo is an Object given by nfc service when tag is dispatched.
let
isEmulated
=
tag
.
MifareClassicTag
(
taginfo
).
isEmulatedTag
()
()
;
let
isEmulated
=
tag
.
MifareClassicTag
(
taginfo
).
isEmulatedTag
();
```
### MifareClassicTag.getBlockIndex<sup>9+</sup>
...
...
@@ -1470,6 +1486,7 @@ import tag from '@ohos.nfc.tag';
// tagInfo is an Object given by nfc service when tag is dispatched.
let
index
=
tag
.
MifareClassicTag
(
taginfo
).
getBlockIndex
(
sectorIndex
);
```
### MifareClassicTag.getSectorIndex<sup>9+</sup>
getSectorIndex(blockIndex: number): number
...
...
@@ -1501,11 +1518,11 @@ import tag from '@ohos.nfc.tag';
let
index
=
tag
.
MifareClassicTag
(
taginfo
).
getSectorIndex
(
blockIndex
);
```
## MifareUltralightTag
<sup>9+</sup>
## MifareUltralightTag
<sup>9+</sup>
### 继承 TagSession
MifareUltralightTag 提供对MIFARE超轻属性和I/O操作的访问,继承自TagSession。
t
agSession是所有Nfc tag 技术类型的基类, 提供建立连接和发送数据等共同接口。具体请参见
[
TagSession
](
js-apis-tagSession.md
)
。
T
agSession是所有Nfc tag 技术类型的基类, 提供建立连接和发送数据等共同接口。具体请参见
[
TagSession
](
js-apis-tagSession.md
)
。
以下是MifareUltralightTag的独有接口。
...
...
@@ -1532,7 +1549,9 @@ readMultiplePages(pageIndex: number): Promise\<string>
| Promise
\<
string> | 读取的4页的数据。 |
**示例:**
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
// tagInfo is an Object given by nfc service when tag is dispatched.
...
...
@@ -1594,6 +1613,7 @@ writeSinglePages(pageIndex: number, data: string): Promise\<number>
| Promise
\<
number> | 执行写入操作返回的错误代码。如果返回0,则表示成功。 |
**示例:**
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
...
...
@@ -1637,7 +1657,7 @@ tag.MifareUltralightTag(taginfo).writeSinglePages(pageIndex, data, function (err
getType(): MifareUltralightType
获取MifareUltralight标签的类型,以字节形式返回,具体请参见
[
MifareUltralightType
](
#
MifareUltralightType
<sup>
9+
</sup>
)。
获取MifareUltralight标签的类型,以字节形式返回,具体请参见
[
MifareUltralightType
](
#
mifareultralighttype9
)
。
**需要权限**
:ohos.permission.NFC_TAG
...
...
@@ -1647,7 +1667,7 @@ getType(): MifareUltralightType
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
| MifareUltralightType | MifareUltralight标签的类型, 具体请参见
[
MifareUltralightType
](
#
MifareUltralightType
<sup>
9+
</sup>
)。|
| MifareUltralightType | MifareUltralight标签的类型, 具体请参见
[
MifareUltralightType
](
#
mifareultralighttype9
)
。|
**示例:**
...
...
@@ -1666,17 +1686,17 @@ let type = tag.MifareUltralightType(taginfo).getType();
| TYPE_ULTRALIGHT | 1 | Mifare Ultralight类型。|
| TYPE_ULTRALIGHT_C | 2 | Mifare UltralightC 类型。 |
## NdefFormatableTag
<sup>9+</sup>
## NdefFormatableTag<sup>9+</sup>
### 继承 TagSession
NdefFormatableTag为NDEF formattable的标签提供格式化操作,继承自TagSession。
t
agSession是所有Nfc tag 技术类型的基类, 提供建立连接和发送数据等共同接口。具体请参见
[
TagSession
](
js-apis-tagSession.md
)
。
T
agSession是所有Nfc tag 技术类型的基类, 提供建立连接和发送数据等共同接口。具体请参见
[
TagSession
](
js-apis-tagSession.md
)
。
以下是NdefFormatableTag的独有接口。
### NdefFormatableTag.format<sup>9+</sup>
format(message:
[
NdefMessage
](
#
NdefMessage
<sup>
9+
</sup>
)): Promise
\<
number>
format(message:
[
NdefMessage
](
#
ndefmessage9
)
): Promise
\<
number>
将标签格式化为NDEF标签,然后将NDEF消息写入NDEF标签。使用promise方式作为异步方法。
...
...
@@ -1688,7 +1708,7 @@ format(message: [NdefMessage](#NdefMessage<sup>9+</sup>)): Promise\<number>
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| message |
[
NdefMessage
](
#
NdefMessage
<sup>
9+
</sup>
) | 是 | 格式化成功时要写入的Ndef消息。可以为null,为null时仅格式化标签,不写入内容。 |
| message |
[
NdefMessage
](
#
ndefmessage9
)
| 是 | 格式化成功时要写入的Ndef消息。可以为null,为null时仅格式化标签,不写入内容。 |
**返回值:**
...
...
@@ -1697,6 +1717,7 @@ format(message: [NdefMessage](#NdefMessage<sup>9+</sup>)): Promise\<number>
| Promise
\<
number> | 执行操作后返回的错误代码。如果返回0,则表示成功。 |
**示例:**
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
...
...
@@ -1708,7 +1729,7 @@ tag.NdefFormatableTag(taginfo).format(message).then(function (errcode){
### NdefFormatableTag.format<sup>9+</sup>
format(message:
[
NdefMessage
](
#
NdefMessage
<sup>
9+
</sup>
), callback: AsyncCallback
\<
number>): void
format(message:
[
NdefMessage
](
#
ndefmessage9
)
, callback: AsyncCallback
\<
number>): void
将标签格式化为NDEF标签,然后将NDEF消息写入NDEF标签。使用callback方式作为异步方法。
...
...
@@ -1720,7 +1741,7 @@ format(message: [NdefMessage](#NdefMessage<sup>9+</sup>), callback: AsyncCallbac
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| message |
[
NdefMessage
](
#
NdefMessage
<sup>
9+
</sup>
) | 是 | 格式化成功时要写入的Ndef消息。可以为null,为null时仅格式化标签,不写入内容。 |
| message |
[
NdefMessage
](
#
ndefmessage9
)
| 是 | 格式化成功时要写入的Ndef消息。可以为null,为null时仅格式化标签,不写入内容。 |
| callback: AsyncCallback
\<
number> | 回调函数。 |
**示例:**
...
...
@@ -1737,7 +1758,7 @@ tag.NdefFormatableTag(taginfo).format(message, function (error, errcode) {
### NdefFormatableTag.formatReadOnly<sup>9+</sup>
formatReadOnly(message:
[
NdefMessage
](
#
NdefMessage
<sup>
9+
</sup>
)): Promise
\<
number>
formatReadOnly(message:
[
NdefMessage
](
#
ndefmessage9
)
): Promise
\<
number>
将标签格式化为NDEF标签,然后将NDEF消息写入NDEF标签,之后将标签设置为只读。使用promise方式作为异步方法。
...
...
@@ -1749,7 +1770,7 @@ formatReadOnly(message: [NdefMessage](#NdefMessage<sup>9+</sup>)): Promise\<numb
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| message |
[
NdefMessage
](
#
NdefMessage
<sup>
9+
</sup>
) | 是 | 格式化成功时要写入的Ndef消息。可以为null,为null时仅格式化标签,不写入内容。 |
| message |
[
NdefMessage
](
#
ndefmessage9
)
| 是 | 格式化成功时要写入的Ndef消息。可以为null,为null时仅格式化标签,不写入内容。 |
**返回值:**
...
...
@@ -1758,6 +1779,7 @@ formatReadOnly(message: [NdefMessage](#NdefMessage<sup>9+</sup>)): Promise\<numb
| Promise
\<
number> | 执行操作后返回的错误代码。如果返回0,则表示成功。 |
**示例:**
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
...
...
@@ -1769,7 +1791,7 @@ tag.NdefFormatableTag(taginfo).formatReadOnly(message).then(function (errcode){
### NdefFormatableTag.formatReadOnly<sup>9+</sup>
formatReadOnly(message:
[
NdefMessage
](
#
NdefMessage
<sup>
9+
</sup>
), callback: AsyncCallback
\<
number>): void
formatReadOnly(message:
[
NdefMessage
](
#
ndefmessage9
)
, callback: AsyncCallback
\<
number>): void
将标签格式化为NDEF标签,然后将NDEF消息写入NDEF标签,之后将标签设置为只读。使用callback方式作为异步方法。
...
...
@@ -1781,7 +1803,7 @@ formatReadOnly(message: [NdefMessage](#NdefMessage<sup>9+</sup>), callback: Asyn
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| message |
[
NdefMessage
](
#
NdefMessage
<sup>
9+
</sup>
) | 是 | 格式化成功时要写入的Ndef消息。可以为null,为null时仅格式化标签,不写入内容。|
| message |
[
NdefMessage
](
#
ndefmessage9
)
| 是 | 格式化成功时要写入的Ndef消息。可以为null,为null时仅格式化标签,不写入内容。|
| callback: AsyncCallback
\<
number> | 回调函数。 |
**示例:**
...
...
zh-cn/application-dev/reference/apis/js-apis-tagSession.md
浏览文件 @
e78e7fb7
...
...
@@ -7,7 +7,7 @@
## **导入模块**
```
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
```
...
...
@@ -24,6 +24,7 @@ tagSession是所有[Nfc tag 技术类型](js-apis-nfctech.md)的基类, 提供
connectTag(): boolean;
和标签建立连接;
在从标签读取数据或将数据写入标签之前,必须调用此方法。
**需要权限**
:ohos.permission.NFC_TAG
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录