txBugly

来自于:AC模块工作室立即使用

概述

本模块封装了腾讯Bugly功能,腾讯Bugly,为移动开发者提供专业的异常上报和运营统计,帮助开发者快速发现并解决异常,同时掌握产品运营动态,及时跟进用户反馈。

使用此模块之前必须先配置 config 文件,配置方法如下:

     <feature name="txBugly">
       <param name="appId_iOS" value="" />
       <param name="appId_Android" value="" />
       <param name="channel" value= "6718"/>
       <param name="version" value="" />
       <param name="deviceIdentifier" value="" />
       <param name="blockMonitorEnable" value="false" />
       <param name="blockMonitorTimeout" value="1" />
       <param name="symbolicateInProcessEnable" value="true" />
       <param name="unexpectedTerminatingDetectionEnable" value="false" />
      <param name="viewControllerTrackingEnable" value="true" />
       <param name="consolelogEnable" value="true" />
       <param name="crashAbortTimeout" value="5" />
       <param name="exception" value="" />
       <param name="debug" value="" />
       <param name="reportDelay" value="" />
    </feature>
  • 字段描述:

    appId_iOS、appId_Android:注册Bugly分配的应用唯一标识,参考腾讯Bugly管理后台

    channel:设置自定义渠道标识

    version:设置自定义版本号

    deviceIdentifier:(可选项)设置自定义设备唯一标识

    blockMonitorEnable:(可选项)(仅ios有效)卡顿监控开关;默认为false

    blockMonitorTimeout:(可选项)(仅ios有效)卡顿监控判断间隔,单位为秒;默认:1

    symbolicateInProcessEnable:(可选项)(仅ios有效)进程内还原开关;默认为true
    unexpectedTerminatingDetectionEnable:(可选项)(仅ios有效)非正常退出事件记录开关;默认为false

    viewControllerTrackingEnable:(可选项)(仅ios有效)页面信息记录开关,默认开启;默认为true

    consolelogEnable:(可选项)(仅ios有效)控制台日志上报开关,默认开启;默认为true

    crashAbortTimeout:(可选项)(仅ios有效)崩溃退出超时,如果监听到崩溃后,App一直没有退出,则到达超时时间后会自动abort进程退出,当赋值为0时,则不会自动abort进程退出,单位为秒;默认:5

    exception:(可选项)(仅ios有效)需上报记录,设置后会随异常上报一起上报;默认:''

    debug:(可选项)(仅android有效)调试模式,设置为“true”时:输出详细的Bugly SDK的Log,每一条Crash都会被立即上报,自定义日志将会在Logcat中输出;默认:'false'

    reportDelay:(可选项)(仅android有效)bugly联网延时,Bugly会在启动10s后联网同步数据。若您有特别需求,可以修改这个时间;

注意:本模块 iOS 平台上最低适配系统版本为 iOS 8.0

模块接口

setUserValue

设置关键数据,随崩溃信息上报

setUserValue({params})

params

key:

  • 类型:字符串类型
  • 描述:关键数据的key

value:

  • 类型:字符串类型
  • 描述:关键数据的value

示例代码

var txBugly = api.require('txBugly');
txBugly.setUserValue({
  key:'',
  value:''
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

allUserValues

获取关键数据

allUserValues(callback(ret))

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 描述:设置的关键数据
  • 内部字段:
{

  'key':'value',
  'key':'value'          
}

示例代码

var txBugly = api.require('txBugly');
txBugly.allUserValues(function(ret){
  console.log(JSON.stringify(ret))
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setTag

设置标签

setTag({params})

params

tag:

  • 类型:数字类型
  • 描述:标签

示例代码

var txBugly = api.require('txBugly');
txBugly.setTag({
  tag:0,
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

currentTag

获取当前设置标签

currentTag(callback(ret))

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
   tag:0    //数字类型;设置的标签         
}

示例代码

var txBugly = api.require('txBugly');
txBugly.currentTag(function(ret){
  console.log(JSON.stringify(ret))
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

reportException

上报自定义异常

reportException({params})

params

name:

  • 类型:字符类型
  • 描述:(仅ios支持)异常名字

reason:

  • 类型:字符类型
  • 描述:异常原因

userInfo:

  • 类型:json对象类型
  • 描述:(可选项)(仅ios支持)异常信息
  • 示例:
{
  version:'1.0',
  id:'0'        
}

示例代码

var txBugly = api.require('txBugly');
txBugly.reportException({
  name:'',
  reason:''
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

reportError

上报错误(仅ios支持)

reportError({params})

params

domain:

  • 类型:字符类型
  • 描述:错误域

code:

  • 类型:数字类型
  • 描述:错误码

userInfo:

  • 类型:json对象类型
  • 描述:(可选项)异常信息
  • 示例:
{
  version:'1.0',
  id:'0'        
}

示例代码

var txBugly = api.require('txBugly');
txBugly.reportError({
  domain:'',
  code:0
});

可用性

iOS系统

可提供的1.0.0及更高版本

sdkVersion

获取 SDK 版本信息

sdkVersion(callback(ret))

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
   sdkVersion:''    //字符类型;SDK版本信息         
}

示例代码

var txBugly = api.require('txBugly');
txBugly.sdkVersion(function(ret){
  console.log(JSON.stringify(ret))
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

deviceId

获取设备ID(仅ios支持)

deviceId(callback(ret))

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
   deviceId:''    //字符类型;设备ID         
}

示例代码

var txBugly = api.require('txBugly');
txBugly.deviceId(function(ret){
  console.log(JSON.stringify(ret))
});

可用性

iOS系统

可提供的1.0.0及更高版本