抖音开放平台Logo
控制台

tt.setStorage
收藏
我的收藏

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

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

前提条件
业务背景
使用限制
注意事项
  • 将数据存储在本地缓存中指定的 key 中,会覆盖掉原来该 key 对应的内容。
  • 用户在平台 app(头条或抖音)内退出登录,或者在系统中清除 app 的缓存可清除数据。
  • 单个 key 数据最大 1M,总体容量最大 10M,超出后会回调失败。
相关教程

语法

tt.setStorage(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
keystring

键名

1.0.0
datastring | object | number | boolean | null | undefined | array

本地缓存数据类型,键名对应的数据

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

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

tt.setStorage({
  key: "didShownAd",
  data: true,
  success(res) {
    console.log(`set seen ad flag`);
  },
  fail(res) {
    console.log(`setStorage调用失败`);
  },
});