接入指南 API 工具 其他

数据

qg.setStorage(Object object)

将数据存储在本地缓存中指定的 key 中。会覆盖掉原来该 key 对应的内容。除非用户主动删除或因存储空间原因被系统清理,否则数据都一直可用。单个 key 允许存储的最大数据长度为 1MB,所有数据存储上限为 10MB。

参数

Object object

属性类型默认值必填说明
keyString本地缓存中指定的 key
dataany需要存储的内容。只支持原生类型、Date、及能够通过 JSON.stringify 序列化的对象。
encryptBooleanfalse是否开启加密存储。只有异步的 getStorage 接口支持开启加密存储。开启后,将会对 data 使用 AES128 解密,接口回调耗时将会增加。若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true
successFunction接口调用成功的回调函数
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

qg.getStorage(Object object)

从本地缓存中异步获取指定 key 的内容。

参数

Object object

属性类型默认值必填说明
keyString本地缓存中指定的 key
encryptBooleanfalse是否开启加密存储。只有异步的 getStorage 接口支持开启加密存储。开启后,将会对 data 使用 AES128 解密,接口回调耗时将会增加。若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true
successFunction接口调用成功的回调函数
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)
object.success(Object res) 回调函数
属性类型说明
dataanykey 对应的内容

示例代码

// 开启加密存储
qg.setStorage({
  key: "key",
  data: "value",
  success() {
    qg.getStorage({
      key: "key",
      success(res) {
        console.log(res.data);
      }
    });
  }
});

qg.clearStorage(Object object)

清理本地数据缓存。

参数

Object object

属性类型默认值必填说明
successFunction接口调用成功的回调函数
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

示例代码

try {
  qg.clearStorage({
    success(res) {
      console.log(res);
    },
    fail(res) {
      console.log(res);
    },
    complete(res) {
      console.log(res);
    }
  });
} catch (e) {
  // Do something when catch error
}

qg.removeStorage(Object object)

从本地缓存中移除指定 key。

参数

Object object

属性类型默认值必填说明
keyString本地缓存中指定的 key
successFunction接口调用成功的回调函数
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

示例代码

try {
  qg.removeStorage({
      key:'key',
      success(res) {
        console.log(res)
      },
      fail(res) {
        console.log(res)
      },
      complete(res) {
        console.log(res)
      },
  })
} catch (e) {
  // Do something when catch error
}

qg.setStorageSync(String key, any data)

将数据存储在本地缓存中指定的 key 中。会覆盖掉原来该 key 对应的内容。除非用户主动删除或因存储空间原因被系统清理,否则数据都一直可用。单个 key 允许存储的最大数据长度为 1MB,所有数据存储上限为 10MB。

参数

String key

本地缓存中指定的 key

any data

需要存储的内容。只支持原生类型、Date、及能够通过 JSON.stringify 序列化的对象。

注意 storage 应只用来进行数据的持久化存储,不应用于运行时的数据传递或全局状态管理。启动过程中过多的同步读写存储,会显著影响启动耗时

示例代码

try {
  qg.setStorageSync("key", "value");
} catch (e) {}

qg.getStorageSync(String key)

从本地缓存中同步获取指定 key 的内容。

参数 String key

本地缓存中指定的 key

返回值 any

key 对应的内容

注意 storage 应只用来进行数据的持久化存储,不应用于运行时的数据传递或全局状态管理。启动过程中过多的同步读写存储,会显著影响启动耗时

示例代码

try {
  var value = qg.getStorageSync("key");
  if (value) {
    // Do something with return value
  }
} catch (e) {
  // Do something when catch error
}

qg.clearStorageSync()

qg.clearStorage 的同步版本

示例代码

try {
  qg.clearStorageSync();
} catch (e) {
  // Do something when catch error
}

qg.removeStorageSync(String key)

qg.removeStorage 的同步版本

参数 String key

本地缓存中指定的 key

示例代码

try {
  qg.removeStorageSync("key");
} catch (e) {
  // Do something when catch error
}

qg.getStorageInfo(Object object)

异步获取当前 storage 的相关信息。

参数

Object object

属性类型默认值必填说明
successFunction接口调用成功的回调函数
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)
object.success(Object res) 回调函数
属性类型说明
keysArray当前 storage 中所有的 key
currentSizeNumber当前占用的空间大小,单位 KB
limitSizeNumber限制的空间大小,单位 KB

示例代码

qg.getStorageInfo({
  success(res) {
    console.log(res.keys);
    console.log(res.currentSize);
    console.log(res.limitSize);
  }
});

Object qg.getStorageInfoSync()

qg.getStorageInfo 的同步版本

返回值

Object object

属性类型说明
keysArray当前 storage 中所有的 key
currentSizeNumber当前占用的空间大小,单位 KB
limitSizeNumber限制的空间大小,单位 KB

示例代码

try {
  const res = qg.getStorageInfoSync();
  console.log(res.keys);
  console.log(res.currentSize);
  console.log(res.limitSize);
} catch (e) {
  // Do something when catch error
}

条匹配 "" 的结果

    没有搜索到与 "" 相关的内容