抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • JS API 列表
  • 基础
  • TTML
  • 网络
  • 媒体
  • 地图
  • 文件
  • 数据缓存
  • 本地数据缓存说明
  • tt.getStorage
  • tt.getStorageSync
  • tt.setStorage
  • tt.setStorageSync
  • tt.removeStorage
  • tt.removeStorageSync
  • tt.clearStorage
  • tt.clearStorageSync
  • tt.getStorageInfo
  • tt.getStorageInfoSync
  • 地理位置
  • 设备
  • 画布
  • 界面
  • 页面导航
  • 开放接口
  • 行业开放
  • 第三方平台
  • 其它
  • 生活服务
  • tt.setStorage
    收藏
    我的收藏

    基础库 1.0.0 开始支持本方法,这是一个异步方法。

    以「键值对」的形式设置本地缓存数据。

    前提条件
    业务背景
    使用限制

    单个 key 数据最大 1M,总体容量最大 10M,超出后会回调失败。

    注意事项
    • 将数据存储在本地缓存中指定的 key 中,会覆盖掉原来该 key 对应的内容;
    • 缓存被清除的时机有且仅有三个:1. 用户在平台 app(头条或抖音)内退出登录; 2. 用户在系统中清除 app 的缓存; 3. 小程序长时间没用,触发了缓存清理机制;
    支持沙盒
    相关教程

    语法

    tt.setStorage(options)

    参数说明

    options 为 object 类型,属性如下:

    属性名类型默认值必填说明最低支持版本
    datastring | object | number | boolean | null | array
    键名对应的数据
    1.0.0
    keystring
    键名
    1.0.0
    successfunction
    接口调用成功的回调函数
    1.0.0
    failfunction
    接口调用失败的回调函数
    1.0.0
    completefunction
    接口调用结束的回调函数(调用成功、失败都会执行)
    1.0.0

    回调成功

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring
    "setStorage:ok"
    1.0.0

    回调失败

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring
    "setStorage:fail" + 详细错误信息
    1.0.0

    错误码

    errorCodeerrMsgerrorType说明最低支持版本
    117799setStorage:fail params.key should be string,setStorage:fail the length of params.key should be greater than or equal to 1D
    参数校验未通过
    1.0.0
    117703setStorage:fail set storage failF
    小程序框架内部错误,有需要请拉客服咨询
    1.0.0
    117784setStorage:fail unregistered APIF
    小程序框架内部错误,有需要请拉客服咨询
    1.0.0
    117701setStorage:fail exceed storage item max lengthD
    存储大小超出单次限制

    请调整单次存储大小

    1.0.0
    117702setStorage:fail exceed storage max size 10MbD
    存储大小超出整体限制

    请调整整体的存储大小。适时清理存储

    1.0.0

    扫码体验

    请使用字节宿主APP扫码

    代码示例