nfc

来自于:开发者立即使用

概述

nfc 模块概述

nfc模块仅封装在安卓下对NFC下的NDEF文本数据读写。

描述

常见错误码。

错误码 错误描述
-1 未知错误
1 您的设备不支持NFC
2 请在系统设置中开启NFC
3 取消NFC操作
4 写入数据不能为空
5 NFC Tag是只读的
6 NFC Tag的空间不足
7 该NFC标签不支持NDEF格式
8 从标签读取数据Parcelable对象为空
9 NFC数据不是NDEF文本格式数据

模块接口

initPageConfig

配置读写标签界面UI元素(不执行本接口则选用模块默认UI布局方案)

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

params

isDebug:

  • 类型:布尔型
  • 描述:开启调试模式时,不支持nfc的手机可以打开界面看UI效果。
  • 默认值:false(不开启)

backgroundColor:

  • 类型:字符串
  • 描述:页面背景色
  • 默认值:#f5f5f5

title:

  • 类型:JSON 对象
  • 描述:顶部标题样式配置
  • 默认值:见内部字段
  • 内部字段:
    {
      text : '请读卡1',       //标题  默认值:请读卡
       color : '#000000',     //标题字体颜色  默认值:#FFFFFF
       background : '#551A8B',//标题栏背景色 默认值:#48C997
       layoutHeight : 45      //标题栏高度 默认值:45
    }
    

center:

  • 类型:JSON 对象
  • 描述:页面中间提示内容样式配置
  • 默认值:见内部字段
  • 内部字段:
    {
      logo : 'widget://res/nfc_read.png', //png,jpg,gif类型的图片logo文件路径 支持fs:// widget://   存在默认图片
       text : '122221', //文字说明  默认值:请将NFC标签或者贴纸靠近手机背面
       color : '#00EE00',   //文字说明字体颜色  默认值:#000000
    }
    

callback(ret,err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true      //布尔型;true|false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    errorCode: 1 ,
    errorMessage : '您的设备不支持NFC'
}

示例代码

var demo = api.require('nfc');
demo.initPageConfig({
    isDebug : true,    //开启时,不支持nfc的手机可以打开界面看UI效果
    backgroundColor : '#FF4040',     //页面背景色
    title : {
         text : '请读卡1',     //标题
         color : '#000000',   //标题字体颜色
         background : '#551A8B',      //标题栏背景色
         layoutHeight : 45            //标题栏高度
     },
     center : {
          logo : 'widget://res/nfc_read.png', //图片logo文件路径
          text : '请将NFC标签或者贴纸靠近手机背面11', //文字说明
          color : '#00EE00',   //文字说明字体颜色
      }
},function(ret){
     alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

writeText

写NFC标签文本数据

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

params

data:

  • 类型:字符串
  • 描述:(必填项)要写入NFC的字符串内容。

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true      //布尔型;true||false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    errorCode: 3 ,
    errorMessage : '取消NFC操作'
}

示例代码

var demo = api.require('nfc');
demo.writeText({
    data : '我是测试数据12345678fffgs'
},function(ret, err){
    alert(JSON.stringify(ret) + "  " +JSON.stringify(err));
});

可用性

Android系统

可提供的1.0.0及更高版本

readText

读NFC标签文本数据

readText(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true,      //布尔型;true||false
    result : '',       //标签内容 
    tagId : '1233123'  //标签ID
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    errorCode: 3 ,
    errorMessage : '取消NFC操作'
}

示例代码

var demo = api.require('nfc');
demo.readText(function(ret, err){
    alert(JSON.stringify(ret) + "  " +JSON.stringify(err));
});

可用性

Android系统

可提供的1.0.0及更高版本