WARNING

💡 模块名:GameHelper.DiskStorage

描述

硬盘缓存依赖于渠道自身文件操作能力，一般渠道对文件读写的能力限制较为宽松，可以保存更多数据。

WARNING

💡 注意:

• 缓存的值，如果玩家清除了缓存，或者删除了游戏就会丢失。

保留字段

注意，部分 SDK 模块使用到了硬盘缓存的功能，占用了一些字段，故游戏内注意不要使用如下的保留字段：

保留字	使用模块
GameHelperPrivacyStatus	隐私模块
recordEnterTime	审核模块
isAreaLimit	审核模块
sh	审核模块
STATV3_EVENTS	统计模块
STATV3_ACT_DURA	统计模块
CommAudio	声音模块
CCLoginOpenId	登录模块
CCLoginTouristId	登录模块

方法

获取硬盘内缓存 key 对应的数据,支持传入单个 key 或者 key 数组。

传入单 key，返回 key 对应的 value。

传入 key 数组，返回与传入数据顺序对应的 value 数组。

参数

参数	类型	默认值	是否必填	说明
key	string | string[]	/	是	缓存的 key

返回值

类型	说明
string | string[]	缓存的值

示例

//获取单个key的value
let value = GameHelper.DiskStorage.getItem("cache1");
//获取多个key的value
let arrValue = GameHelper.DiskStorage.getItem(["cache2", "cache3"]);

---

设置缓存，支持单键值对和多键值对的对象。

传入两个参数，表示缓存单个数据，前者为 key，后者为 value。

传入单个参数对象，对象的属性与值对应需要缓存的键值对。

参数

参数	类型	默认值	是否必填	说明
key	string | object	/	是	缓存的 key
value	string	/	否	缓存的 value

返回值

无

示例

//传入单个key,value形式保存数据
GameHelper.DiskStorage.setItem("cache1", "hello diskStorage");

//传入对象形式保留数据
let obj = {
  cache2: "objectvalue_1",
  cache3: "objectvalue_2",
  cache4: "objectvalue_3",
};
GameHelper.DiskStorage.setItem(obj);

---

删除指定 key 的缓存，可以传入一个字符串数组，表示数组内所有的 key。

参数

参数	类型	默认值	是否必填	说明
key	string | string[]	/	是	缓存的 key

返回值

无

示例

//删除单个key对应的数据
GameHelper.DiskStorage.removeItem("cache1");

//删除多个key对应的数据
GameHelper.DiskStorage.removeItem(["cache2", "cache3", "cache4"]);