# Storage

# setItem

存储数据到手机本地 (使用本地数据库存储)

  • 支持平台
Android IOS HarmonyOS
×
  • 参数说明
参数名 类型 必填 说明
key String 存储数据 键值
value [Object,String] 需要存储的数据,键值对格式或字符串
completedCB Function 可选 请求完成回调函数,成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码
message String 调用结果信息
payload String 无结果
  • 示例代码

//存储键值对
foxsdk.storage.setItem('user', {name: 'xiaoming', age: 17}, ret => {
    console.log('storage/setItem===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

//储存字符串
foxsdk.storage.setItem('user', 'liming', ret => {
    console.log('storage/setItem===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# getItem

获取存储数据

  • 支持平台
Android IOS HarmonyOS
×
  • 参数说明
参数名 类型 必填 说明
key String 需要获取数据的键值
completedCB Function 可选 请求完成回调函数,成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码 0:成功,1:失败
message String 调用结果信息
payload String 返回查询结果
  • 示例代码
foxsdk.storage.getItem('user', ret => {
    console.log('storage/getItem===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + ret.payload);
});

# removeItem

删除存储过的数据

  • 支持平台
Android IOS HarmonyOS
×
  • 参数说明
参数名 类型 必填 说明
key String 删除存储数据 键值
completedCB Function 可选 请求完成回调函数,成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码 0:成功,1:失败
message String 调用结果信息
payload String 无结果
  • 示例代码
foxsdk.storage.removeItem('user', ret => {
    console.log('storage/removeItem===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
})

# clear

清除所有存储数据

  • 支持平台
Android IOS HarmonyOS
×
  • 参数说明
参数名 类型 必填 说明
completedCB Function 可选 请求完成回调函数,成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码 0:成功,1:失败
message String 调用结果信息
payload String 无结果
  • 示例代码
foxsdk.storage.clear(ret => {
    console.log('bindCallNative===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
})

# setAPDataStorage

存储数据到手机本地 (使用本地数据库存储)

  • 支持平台
Android IOS HarmonyOS
  • 参数说明
参数名 类型 必填 说明
key String 存储数据 键值
value [Object,String] 需要存储的数据,键值对格式或字符串
isRuntime String 是否是运行时数据,默认为'0'
encrypt String 是否进行加密,默认为'1'
completedCB Function 可选 请求完成回调函数,成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码
message String 调用结果信息
payload Object 无结果
  • 示例代码

foxsdk.storage.setAPDataStorage({key:'test',
  value:[{'key1':'value1'}],
  isRuntime:'1',
  encrypt:'1'
},ret=>{
    console.log(ret)
})

# getAPDataStorage

获取存储数据

  • 支持平台
Android IOS HarmonyOS
  • 参数说明
参数名 类型 必填 说明
key String 需要获取数据的键值
isRuntime String 是否是运行时数据,默认为'0'
encrypt String 是否进行加密,默认为'1'
completedCB Function 可选 请求完成回调函数,成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码 0:成功,1:失败
message String 调用结果信息
payload Object 返回查询结果
  • payload返回参数说明
参数名 类型 说明
value Object 结果
  • 示例代码
foxsdk.storage.getAPDataStorage(
    {key:'test',isRuntime:'1' },ret=>{
    console.log(ret)
})

# removeAPDataStorage

删除存储过的数据

  • 支持平台
Android IOS HarmonyOS
  • 参数说明
参数名 类型 必填 说明
key String 删除存储数据 键值
isRuntime String 是否是运行时数据,默认为'0'
completedCB Function 可选 请求完成回调函数,成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码 0:成功,1:失败
message String 调用结果信息
payload String 无结果
  • 示例代码
foxsdk.storage.removeAPDataStorage({key:'test',isRuntime:'1'},
        ret=>{console.log(ret)
})

# clearApData

清除所有存储数据

  • 支持平台
Android IOS HarmonyOS
  • 参数说明
参数名 类型 必填 说明
completedCB Function 可选 请求完成回调函数,成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码 0:成功,1:失败
message String 调用结果信息
payload String 无结果
  • 示例代码
foxsdk.storage.clearApData(ret=>{
    console.log(ret)
})
Last Updated: 2/29/2024, 3:57:21 PM