getPrefs

获取偏好设置值

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

params

sync:

  • 类型:布尔
  • 默认值:false
  • 描述:执行结果的返回方式。为false时通过callback返回,为true时直接返回。

key:

  • 类型:字符串
  • 默认值:无
  • 描述:键

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. value:"" //值
  3. }

示例代码

  1. //异步返回结果:
  2. api.getPrefs({
  3. key: 'userName'
  4. }, function(ret, err) {
  5. var userName = ret.value;
  6. });
  7. //同步返回结果:
  8. var userName = api.getPrefs({
  9. sync: true,
  10. key: 'userName'
  11. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本