zNFC

来自于:开发者立即使用

概述

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

模块接口

readNDEF

读取NDEF格式的NFC标签

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

params

style:

  • 类型:JSON 对象
  • 描述:(可选项)模块各部分的样式,不传递本参数则选用模块默认UI布局方案
    {
      background:'#FFFFFF',                        //(可选项)字符串类型;页面背景色,支持 #;默认:'#FFFFFF'
      title:{                                        //(可选项)JSON对象;顶部标题栏的样式
          bgColor:'#AFEEEE',                        //(可选项)字符串类型;顶部标题栏背景色,支持 #;默认:'#000000'
          height:55,                                //(可选项)数字类型;顶部标题栏高度,支持 #;默认:50
          title:'nfc识别界面',                    //(可选项)字符串类型;顶部标题;默认:NFC
          titleSize: 12,                            //(可选项)数字类型;顶部标题字体大小;默认:25
          titleColor: '#FFFFFF',                    //(可选项)数字类型;顶部标题字体颜色,支持 #;默认:'#FFFFFF'
          backImg:'widget://res/nfc_back.png'        //(可选项)字符串类型;左侧返回按钮配图的占位图路径(本地路径,fs://、widget://),默认:默认 图片
      },
      content:{                                    //(可选项)JSON对象;页面主题部分的样式
          text:'请将NFC标签或者贴纸靠近手机背面',    //(可选项)字符串类型;说明文字;默认:请将NFC标签或者贴纸靠近手机背面
          textSize:14,                            //(可选项)数字类型;顶部标题字体大小;默认:14
          textColor:'#000000',                    //(可选项)字符串类型;说明文字字体颜色,支持 #;默认:'#000000'
          contentImg:'widget://res/nfc_read.png'    //(可选项)字符串类型;主题部分配图的占位图路径(本地路径,fs://、widget://),默认:默认 图片
      }
    }
    

    callback(ret, err)

ret:

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

err:

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

示例代码

var znfc = api.require('zNFC');
znfc.readNDEF({
    style:{
        background:'#696969',
        titleBar:{
            bgColor:'#AFEEEE',
            height:48,
            title:'nfc识别界面',
            titleSize: 14,
            titleColor: '#FFFFFF',
            backImg:'widget://image/nfc_back.png'
        },
        content:{
          text:'请将NFC标签或者贴纸靠近手机背面',
          textSize:14,
          textColor:'#000000',
          contentImg:'widget://image/nfc_read.png'
        }
    }
},function(ret,err){
    if(ret){
        alert("ret"+JSON.stringify(ret));    
    }else{
        alert("err"+JSON.stringify(err));    
    }                
});

可用性

Android系统

可提供的1.0.0及更高版本

writeNDEF

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

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

params

style:

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

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

    data:

  • 类型:字符串类型

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

    callback(ret, err)

ret:

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

err:

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

示例代码

var znfc = api.require('zNFC');
var stringData="这是一条String型的测试数据";
znfc.writeNDEF({
    style:{
        background:'#696969',
        titleBar:{
            bgColor:'#AFEEEE',
            height:48,
            title:'nfc识别界面',
            titleSize: 14,
            titleColor: '#FFFFFF',
            backImg:'widget://image/nfc_back.png'
        },
        content:{
          text:'请将NFC标签或者贴纸靠近手机背面',
          textSize:14,
          textColor:'#000000',
          contentImg:'widget://image/nfc_write.png'
        }
    },
    data:stringData
},function(ret,err){
    if(ret){
        alert("ret"+JSON.stringify(ret));    
    }else{
        alert("err"+JSON.stringify(err));    
    }                
});

可用性

Android系统

可提供的1.0.0及更高版本