zNFC

来自于:开发者立即使用

readNDEF writeNDEF

概述

zNFC 封装对安卓下对NFC标签中的数据读写本模块由第三方模块开发者提供,使用本模块需在线云编译安装包

模块接口

readNDEF

读取NDEF格式的NFC标签

readNDEF({params}, callback(ret, err))

params

style:

  • 类型:JSON 对象
  • 描述:(可选项)模块各部分的样式,不传递本参数则选用模块默认UI布局方案

    1. {
    2. background:'#FFFFFF', //(可选项)字符串类型;页面背景色,支持 #;默认:'#FFFFFF'
    3. title:{ //(可选项)JSON对象;顶部标题栏的样式
    4. bgColor:'#AFEEEE', //(可选项)字符串类型;顶部标题栏背景色,支持 #;默认:'#000000'
    5. height:55, //(可选项)数字类型;顶部标题栏高度,支持 #;默认:50
    6. title:'nfc识别界面', //(可选项)字符串类型;顶部标题;默认:NFC
    7. titleSize: 12, //(可选项)数字类型;顶部标题字体大小;默认:25
    8. titleColor: '#FFFFFF', //(可选项)数字类型;顶部标题字体颜色,支持 #;默认:'#FFFFFF'
    9. backImg:'widget://res/nfc_back.png' //(可选项)字符串类型;左侧返回按钮配图的占位图路径(本地路径,fs://、widget://),默认:默认 图片
    10. },
    11. content:{ //(可选项)JSON对象;页面主题部分的样式
    12. text:'请将NFC标签或者贴纸靠近手机背面', //(可选项)字符串类型;说明文字;默认:请将NFC标签或者贴纸靠近手机背面
    13. textSize:14, //(可选项)数字类型;顶部标题字体大小;默认:14
    14. textColor:'#000000', //(可选项)字符串类型;说明文字字体颜色,支持 #;默认:'#000000'
    15. contentImg:'widget://res/nfc_read.png' //(可选项)字符串类型;主题部分配图的占位图路径(本地路径,fs://、widget://),默认:默认 图片
    16. }
    17. }

    callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
  1. {
  2. status: 1, //数字类型;1(读取NDEF类型数据成功)
  3. TagId: '2CA9F31D', //字符串类型;NFC标签ID
  4. data: '这是一条测试数据' //字符串类型;NFC标签内容
  5. }

err:

  • 类型:JSON对象
  • 内部字段:
  1. {
  2. status: 0, //数字类型;
  3. //错误码:
  4. //0(设备不支持NFC!),
  5. //-1(NFC未开启,请在系统设置中先启用NFC功能!)
  6. //-2(用户取消操作)
  7. //-3(不支持的卡片类型【非NDEF格式的卡片使用该方法会报该错误】)
  8. msg:'设备不支持NFC!' //字符串类型;错误信息【可根据status的错误码,自定义错误提示】
  9. }

示例代码

  1. var znfc = api.require('zNFC');
  2. znfc.readNDEF({
  3. style:{
  4. background:'#696969',
  5. titleBar:{
  6. bgColor:'#AFEEEE',
  7. height:48,
  8. title:'nfc识别界面',
  9. titleSize: 14,
  10. titleColor: '#FFFFFF',
  11. backImg:'widget://image/nfc_back.png'
  12. },
  13. content:{
  14. text:'请将NFC标签或者贴纸靠近手机背面',
  15. textSize:14,
  16. textColor:'#000000',
  17. contentImg:'widget://image/nfc_read.png'
  18. }
  19. }
  20. },function(ret,err){
  21. if(ret){
  22. alert("ret"+JSON.stringify(ret));
  23. }else{
  24. alert("err"+JSON.stringify(err));
  25. }
  26. });

可用性

Android系统

可提供的1.0.0及更高版本

writeNDEF

写入数据至NDEF格式的NFC标签

writeNDEF({params}, callback(ret, err))

params

style:

  • 类型:JSON 对象
  • 描述:(可选项)模块各部分的样式,不传递本参数则选用模块默认UI布局方案

    1. {
    2. background:'#FFFFFF', //(可选项)字符串类型;页面背景色,支持 #;默认:'#FFFFFF'
    3. title:{ //(可选项)JSON对象;顶部标题栏的样式
    4. bgColor:'#AFEEEE', //(可选项)字符串类型;顶部标题栏背景色,支持 #;默认:'#000000'
    5. height:55, //(可选项)数字类型;顶部标题栏高度,支持 #;默认:50
    6. title:'nfc识别界面', //(可选项)字符串类型;顶部标题;默认:NFC
    7. titleSize: 12, //(可选项)数字类型;顶部标题字体大小;默认:25
    8. titleColor: '#FFFFFF', //(可选项)数字类型;顶部标题字体颜色,支持 #;默认:'#FFFFFF'
    9. backImg:'widget://res/nfc_back.png' //(可选项)字符串类型;左侧返回按钮配图的占位图路径(本地路径,fs://、widget://),默认:默认 图片
    10. },
    11. content:{ //(可选项)JSON对象;页面主题部分的样式
    12. text:'请将NFC标签或者贴纸靠近手机背面', //(可选项)字符串类型;说明文字;默认:请将NFC标签或者贴纸靠近手机背面
    13. textSize:14, //(可选项)数字类型;顶部标题字体大小;默认:14
    14. textColor:'#000000', //(可选项)字符串类型;说明文字字体颜色,支持 #;默认:'#000000'
    15. contentImg:'widget://res/nfc_read.png' //(可选项)字符串类型;主题部分配图的占位图路径(本地路径,fs://、widget://),默认:默认 图片
    16. }
    17. }

    data:

  • 类型:字符串类型

  • 描述:(可选项)要写入的数据【 如:’这是一条测试数据’】,不传将写入空字符串(空字符串可以达到清空内容的功能)

    callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
  1. {
  2. status: 1, //数字类型;1(写入数据成功)
  3. data: '这是一条测试数据' //字符串类型;写入NFC标签的内容
  4. }

err:

  • 类型:JSON对象
  • 内部字段:
  1. {
  2. status: 0, //数字类型;
  3. //错误码:
  4. //0(设备不支持NFC!),
  5. //-1(NFC未开启,请在系统设置中先启用NFC功能!)
  6. //-2(用户取消操作)
  7. //-3(不支持的卡片类型【非NDEF格式的卡片使用该方法会报该错误】)
  8. //-4(写入失败)
  9. msg:'设备不支持NFC!' //字符串类型;错误信息【可根据status的错误码,自定义错误提示】
  10. }

示例代码

  1. var znfc = api.require('zNFC');
  2. var stringData="这是一条String型的测试数据";
  3. znfc.writeNDEF({
  4. style:{
  5. background:'#696969',
  6. titleBar:{
  7. bgColor:'#AFEEEE',
  8. height:48,
  9. title:'nfc识别界面',
  10. titleSize: 14,
  11. titleColor: '#FFFFFF',
  12. backImg:'widget://image/nfc_back.png'
  13. },
  14. content:{
  15. text:'请将NFC标签或者贴纸靠近手机背面',
  16. textSize:14,
  17. textColor:'#000000',
  18. contentImg:'widget://image/nfc_write.png'
  19. }
  20. },
  21. data:stringData
  22. },function(ret,err){
  23. if(ret){
  24. alert("ret"+JSON.stringify(ret));
  25. }else{
  26. alert("err"+JSON.stringify(err));
  27. }
  28. });

可用性

Android系统

可提供的1.0.0及更高版本