分类： API

wx.getBackgroundFetchData(object object)

基础库 2.8.0 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：支持

微信小程序插件：不支持

微信 鸿蒙 OS 版：支持

相关文档: 周期性更新、数据预拉取

功能描述

拉取 backgroundFetch 客户端缓存数据。 当调用接口时，若当次请求未结束，会先返回本地的旧数据（之前打开微信小程序时请求的），如果本地没有旧数据，安卓上会返回fail，不会等待请求完成，iOS上会返回success但fetchedData为空，也不会等待请求完成。建议和 wx.onBackgroundFetchData 配合使用。

参数

object object

属性 类型 默认值 必填 说明
fetchType String 是 缓存数据类别，取值为 periodic 或 pre
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数
Object res
属性 类型 说明
fetchedData String 缓存数据
timeStamp Number 客户端拿到缓存数据的时间戳 ms。(iOS 时间戳存在异常，8.0.27 修复)
path String 微信小程序页面路径
query String 传给页面的 query 参数
scene Number 进入微信小程序的场景值

wx.getBackgroundFetchToken(Object object)

基础库 2.8.0 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：支持

微信小程序插件：不支持

微信 鸿蒙 OS 版：支持

相关文档: 周期性更新、数据预拉取

功能描述

获取设置过的自定义登录态。若无，则返回 fail。

参数

Object object

属性 类型 默认值 必填 说明
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数
Object res
属性 类型 说明
token String 自定义的登录态
errMsg String 接口调用结果

wx.onBackgroundFetchData(function listener)

基础库 2.8.0 开始支持，低版本需做兼容处理。

微信小程序插件：不支持

相关文档: 周期性更新、数据预拉取

功能描述

监听收到 backgroundFetch 数据事件。如果监听时请求已经完成，则事件不会触发。建议和 wx.getBackgroundFetchData 配合使用

参数

function listener

收到 backgroundFetch 数据事件的监听函数

参数

Object res
属性 类型 说明
fetchType string 缓存数据类别，取值为 periodic 或 pre
fetchedData string 缓存数据
timeStamp number 客户端拿到缓存数据的时间戳
path String 微信小程序页面路径
query String 传给页面的 query 参数
scene Number 进入微信小程序的场景值

wx.setBackgroundFetchToken(object object)

基础库 2.8.0 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：支持

微信小程序插件：不支持

微信 鸿蒙 OS 版：支持

相关文档: 周期性更新、数据预拉取

功能描述

设置自定义登录态，在周期性拉取数据时带上，便于第三方服务器验证请求合法性

参数

object object

属性 类型 默认值 必填 说明
token String 是 自定义的登录态。上限 1024 字符。
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

wx.batchGetStorage(Object object)

基础库 2.25.0 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：支持

微信小程序插件：不支持

微信 鸿蒙 OS 版：支持

相关文档: 存储策略

功能描述

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

参数

Object object

属性 类型 默认值 必填 说明
keyList Array.<string> 是 本地缓存中指定的 keyList
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

示例代码

wx.batchGetStorage({
  keyList: ['key'],
  success (res) {
    console.log(res)
  }
})

wx.batchGetStorageSync(Array. keyList)

基础库 2.25.0 开始支持，低版本需做兼容处理。

微信小程序插件：不支持

微信 鸿蒙 OS 版：支持

相关文档: 存储策略

功能描述

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

参数

Array. keyList

本地缓存中指定的 key 数组

返回值

Array.

key对应的内容

示例代码

try {
  var valueList = wx.batchGetStorageSync(['key'])
  if (valueList) {
    // Do something with return value
  }
} catch (e) {
  // Do something when catch error
}

对于多个key的读取, 批量读取在性能上优于多次getStorageSync读取

wx.batchSetStorage(Object object)

基础库 2.25.0 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：支持

微信小程序插件：不支持

微信 鸿蒙 OS 版：支持

相关文档: 存储策略

功能描述

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

参数

Object object

属性 类型 默认值 必填 说明
kvList Array 是 [{ key, value }]
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

示例代码

wx.setStorage({
  key:"key",
  data:"value"
})

// 开启加密存储
wx.batchSetStorage({
  kvList: [{
    key: 'key',
    value: 'value',
  }],
})

wx.batchSetStorageSync(Array. kvList)

基础库 2.25.0 开始支持，低版本需做兼容处理。

微信小程序插件：不支持

微信 鸿蒙 OS 版：支持

相关文档: 存储策略

功能描述

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

参数

Array. kvList
属性 类型 默认值 必填 说明
key string 是 key 本地缓存中指定的 key
value any 是 data 需要存储的内容。只支持原生类型、Date、及能够通过JSON.stringify序列化的对象。

示例代码

try {
  wx.batchSetStorageSync([{key: 'key', value: 'value'}])
} catch (e) { }

wx.clearStorage(Object object)

以 Promise 风格 调用：支持

微信小程序插件：不支持

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 存储策略

功能描述

清理本地数据缓存。

参数

Object object

属性 类型 默认值 必填 说明
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

示例代码

wx.clearStorage()

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

wx.clearStorageSync()

以 Promise 风格 调用：支持

微信小程序插件：不支持

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 存储策略

功能描述

wx.clearStorage 的同步版本

示例代码

wx.clearStorage()

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