upStorageModule 通用数据存储模块

模块概述

H5需要Native存储、读取数据，或者H5、native需要共享存储数据，通用数据存储模块实现H5、native通用数据的存储、读取。

方法列表

• putIntegerValue（存储int类型值）
• putFloatValue （存储float类型值）
• putBooleanValue （存储boolean类型值）
• putStringValue （存储string类型值）
• putLongValue （存储long类型值）
• putDoubleValue （存储double类型值）
• getIntegerValue（获取int类型值）
• getFloatValue （获取float类型值）
• getBooleanValue （获取boolean类型值）
• getStringValue （获取string类型值）
• getLongValue （获取long类型值）
• getDoubleValue （获取double类型值）
• getIntegerSubNodes（根据父节点获取int类型所有叶子节点存储值）
• getFloatSubNodes（根据父节点获取float类型所有叶子节点存储值）
• getBooleanSubNodes（根据父节点获取boolean类型所有叶子节点存储值）
• getStringSubNodes（根据父节点获取String类型所有叶子节点存储值）
• getLongSubNodes（根据父节点获取long类型所有叶子节点存储值）
• getDoubleSubNodes（根据父节点获取double类型所有叶子节点存储值）
• deleteNode（删除存储节点）
• setTemporaryStorage (set临时存储)
• getTemporaryStorage (get临时存储)
• deleteTemporaryStorage (删除临时存储)
• clearTemporaryStorage (清空临时存储)
• addDataListener (添加临时存储数据变化监听)
• removeDataListener (移除临时存储数据变化监听)
• addNodeListener (添加节点数据变化监听)
• removeNodeListener (移除节点数据变化监听)

公共数据

• 所有数据均以 JSON 结构返回，由代码，信息和数据三部分组成

  {
    "retCode": "000000", //接口状态标识码,错误标识码以33开头
    "retInfo": "操作成功",//接口信息说明
    "retData": null //业务数据
  }
  

具体定义：返回数据通用

模块变更记录

• V4.0.0（容器底层实现接口变化，对外接口不变）
  • 新增：
    • addDataListener (添加临时存储数据变化监听)
    • removeDataListener (移除临时存储数据变化监听)
    • addNodeListener (添加节点数据变化监听)
    • removeNodeListener (移除节点数据变化监听)
• V3.7.0
  • 新增：通用存储常用字段汇总列表。列表中新增字段如下：
    • 获取App当前语言 app_current_lan_key
    • 设置App的语言 user_setted_lan_key
    • 控制语音按钮文案是否显示 AiAssistantIsOn
• V3.1.0
  • 新增upStorageModule模块

方法说明

• putIntegerValue（存储int类型值）

  putIntegerValue({params})

适用性

params 输入参数：

错误返回 retCode说明：

按照通用

正确返回 retData说明：

无

示例

调用方式

uplusapi.upStorageModule.putIntegerValue({
  storageName:'a/a'，
  storageValue: 12
}).then(
  (result) =>console.log('result',result),
  (error) =>console.log('error',error)
);

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "存储成功",
  "retData": ''
  }
}

• putFloatValue（存储float类型值）

  putFloatValue({params})

适用性

params 输入参数：

错误返回 retCode说明：

按照通用

正确返回 retData说明：

无

示例

调用方式

uplusapi.upStorageModule.putFloatValue({
  storageName:'b/a'，
  storageValue: 6.6
}).then(
  (result) =>console.log('result',result),
  (error) =>console.log('error',error)
);

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "存储成功",
  "retData": ''
  }
}

• putBooleanValue（存储boolean类型值）

  putBooleanValue({params})

适用性

params 输入参数：

错误返回 retCode说明：

按照通用

正确返回 retData说明：

无

示例

调用方式

uplusapi.upStorageModule.putBooleanValue({
  storageName:'c/a',
  storageValue: true
}).then(
  (result) =>console.log('result',result),
  (error) =>console.log('error',error)
);

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "存储成功",
  "retData": ''
  }
}

• putStringValue（存储string类型值）

  putStringValue({params})

适用性

params 输入参数：

错误返回 retCode说明：

按照通用

正确返回 retData说明：

无

示例

调用方式

uplusapi.upStorageModule.putStringValue({
  storageName:'d/a',
  storageValue: '苹果'
}).then(
  (result) =>console.log('result',result),
  (error) =>console.log('error',error)
);

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "存储成功",
  "retData": ''
  }
}

• putDoubleValue（存储double类型值）

  putdoubleValue({params})

适用性

params 输入参数：

错误返回 retCode说明：

按照通用

正确返回 retData说明：

无

示例

调用方式

uplusapi.upStorageModule.putDoubleValue({
  storageName:'e/a',
  storageValue: 12.12
}).then(
  (result) =>console.log('result',result),
  (error) =>console.log('error',error)
);

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "存储成功",
  "retData": ''
  }
}

• putLongValue（存储long类型值）

  putLongValue({params})

适用性

params 输入参数：

错误返回 retCode说明：

按照通用

正确返回 retData说明：

无

示例

调用方式

uplusapi.upStorageModule.putLongValue({
  storageName:'f/a',
  storageValue: 1212111111
}).then(
  (result) =>console.log('result',result),
  (error) =>console.log('error',error)
);

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "存储成功",
  "retData": ''
  }
}

• getIntegerValue（获取int类型值）

  getIntegerValue({params})

适用性

params 输入参数：

错误返回 retCode说明：

按照通用

正确返回 retData说明：

无

示例

调用方式

uplusapi.upStorageModule.getIntegerValue({
  storageName:'a/a',
  storageValue: 0
}).then(
  (result) =>console.log('result',result),
  (error) =>console.log('error',error)
);

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "操作成功",
  "retData": 12
}

• getIFloatValue（获取float类型值）

  getFloatValue({params})

适用性

params 输入参数：

错误返回 retCode说明：

按照通用

正确返回 retData说明：

无

示例

调用方式

uplusapi.upStorageModule.getFloatValue({
  storageName:'b/a',
  storageValue: 0
}).then(
  (result) =>console.log('result',result),
  (error) =>console.log('error',error)
);

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "操作成功",
  "retData": 6.6
}

• getBooleanValue（获取boolean类型值）

  getBooleanValue({params})

适用性

params 输入参数：

错误返回 retCode说明：

按照通用

正确返回 retData说明：

无

示例

调用方式

uplusapi.upStorageModule.getBooleanValue({
  storageName:'c/a',
  storageValue: true
}).then(
  (result) =>console.log('result',result),
  (error) =>console.log('error',error)
);

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "操作成功",
  "retData": true
}

• getStringValue（获取string类型值）

  getStringValue({params})

适用性

params 输入参数：

错误返回 retCode说明：

按照通用

正确返回 retData说明：

无

示例

调用方式

uplusapi.upStorageModule.getStringValue({
  storageName:'d/a',
  storageValue: '111'
}).then(
  (result) =>console.log('result',result),
  (error) =>console.log('error',error)
);

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "操作成功",
  "retData": '苹果'
}

• getDoubleValue（获取double类型值）

  getDoubleValue({params})

适用性

params 输入参数：

错误返回 retCode说明：

按照通用

正确返回 retData说明：

无

示例

调用方式

uplusapi.upStorageModule.getDoubleValue({
  storageName:'e/a',
  storageValue: 0
}).then(
  (result) =>console.log('result',result),
  (error) =>console.log('error',error)
);

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "操作成功",
  "retData": 12.12
}

• getLongValue（获取long类型值）

  getLongValue({params})

适用性

params 输入参数：

错误返回 retCode说明：

按照通用

正确返回 retData说明：

无

示例

调用方式

uplusapi.upStorageModule.getLongValue({
  storageName:'f/a',
  storageValue: 0
}).then(
  (result) =>console.log('result',result),
  (error) =>console.log('error',error)
);

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "操作成功",
  "retData": 1212111111
}

• getIntegerSubNodes（根据父节点获取int类型所有叶子节点存储值）

  getIntegerSubNodes({params})

适用性

params 输入参数：

错误返回 retCode说明：

按照通用

正确返回 retData说明：

示例

调用方式

uplusapi.upStorageModule.getIntegerSubNodes({
  storageName:'a',
  orderedType: 0
}).then(
  (result) =>console.log('result',result),
  (error) =>console.log('error',error)
);

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "获取成功",
  "retData": [
    {
      "createTime":1582615216694,
      "name":"a/a",
      "type":"INTEGER",
      "updateTime":1582615224350,
      "value":12
    },
    {
      "createTime":1582615216768,
      "name":"a/b",
      "type":"INTEGER",
      "updateTime":15826152243456,
      "value":15
    }
  ]
}

• getFloatSubNodes（根据父节点获取float类型所有叶子节点存储值）

  getFloatSubNodes({params})

适用性

params 输入参数：

错误返回 retCode说明：

按照通用

正确返回 retData说明：

示例

调用方式

uplusapi.upStorageModule.getFloatSubNodes({
  storageName:'b',
  orderedType: 1
}).then(
  (result) =>console.log('result',result),
  (error) =>console.log('error',error)
);

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "获取成功",
  "retData": [
    {
      "createTime":1582615216694,
      "name":"b/a",
      "type":"FLOAT",
      "updateTime":1582615224350,
      "value":12.12
    },
    {
      "createTime":1582615216768,
      "name":"b/b",
      "type":"FLOAT",
      "updateTime":15826152243456,
      "value":11.11
    }
  ]
}

• getBooleanSubNodes（根据父节点获取Boolean类型所有叶子节点存储值）

  getBooleanSubNodes({params})

适用性

params 输入参数：

错误返回 retCode说明：

按照通用

正确返回 retData说明：

示例

调用方式

uplusapi.upStorageModule.getBooleanSubNodes({
  storageName:'c'
}).then(
  (result) =>console.log('result',result),
  (error) =>console.log('error',error)
);

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "获取成功",
  "retData": [
    {
      "createTime":1582615216694,
      "name":"c/a",
      "type":"BOOLEAN",
      "updateTime":1582615224350,
      "value":true
    },
    {
      "createTime":1582615216768,
      "name":"c/b",
      "type":"BOOLEAN",
      "updateTime":15826152243456,
      "value":false
    }
  ]
}

• getStringSubNodes（根据父节点获取String类型所有叶子节点存储值）

  getStringSubNodes({params})

适用性

params 输入参数：

错误返回 retCode说明：

按照通用

正确返回 retData说明：

示例

调用方式

uplusapi.upStorageModule.getStringSubNodes({
  storageName:'d'
}).then(
  (result) =>console.log('result',result),
  (error) =>console.log('error',error)
);

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "获取成功",
  "retData": [
    {
      "createTime":1582615216694,
      "name":"d/a",
      "type":"STRING",
      "updateTime":1582615224350,
      "value"'苹果'
    },
    {
      "createTime":1582615216768,
      "name":"d/b",
      "type":"STRING",
      "updateTime":15826152243456,
      "value":'香蕉'
    }
  ]
}

• getDoubleSubNodes（根据父节点获取double类型所有叶子节点存储值）

  getDoubleSubNodes({params})

适用性

params 输入参数：

错误返回 retCode说明：

按照通用

正确返回 retData说明：

示例

调用方式

uplusapi.upStorageModule.getDoubleSubNodes({
  storageName:'e',
  orderedType: 0
}).then(
  (result) =>console.log('result',result),
  (error) =>console.log('error',error)
);

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "获取成功",
  "retData": [
    {
      "createTime":1582615216694,
      "name":"e/a",
      "type":"DOUBLE",
      "updateTime":1582615224350,
      "value":11.11
    },
    {
      "createTime":1582615216768,
      "name":"e/b",
      "type":"DOUBLE",
      "updateTime":15826152243456,
      "value":12.12
    }
  ]
}

• getLongSubNodes（根据父节点获取long类型所有叶子节点存储值）

  getLongSubNodes({params})

适用性

params 输入参数：

错误返回 retCode说明：

按照通用

正确返回 retData说明：

示例

调用方式

uplusapi.upStorageModule.getLongSubNodes({
  storageName:'f',
  orderedType: 1
}).then(
  (result) =>console.log('result',result),
  (error) =>console.log('error',error)
);

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "获取成功",
  "retData": [
    {
      "createTime":1582615216694,
      "name":"f/a",
      "type":"LONG",
      "updateTime":1582615224350,
      "value":1212111111
    },
    {
      "createTime":1582615216768,
      "name":"f/b",
      "type":"LONG",
      "updateTime":15826152243456,
      "value":1212111110
    }
  ]
}

• deleteNode（删除存储节点）

  deleteNode({params})

适用性

params 输入参数：

错误返回 retCode说明：

按照通用

正确返回 retData说明：

无

示例

调用方式

uplusapi.upStorageModule.deleteNode({
  storageName:'a/a'
}).then(
  (result) =>console.log('result',result),
  (error) =>console.log('error',error)
);

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "删除成功",
  "retData": ''
  }
}

• setTemporaryStorage（set临时存储）

  setTemporaryStorage({params})

适用性

params 输入参数：

错误返回 retCode说明：

按照通用

正确返回 retData说明：

无

示例

调用方式

uplusapi.upStorageModule.setTemporaryStorage({
  key:'a',
  value:'123'
}).then(
  (result) =>console.log('result',result),
  (error) =>console.log('error',error)
);

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "操作成功",
  "retData": ''
  }
}

• getTemporaryStorage（get临时存储）

  getTemporaryStorage({params})

适用性

params 输入参数：

错误返回 retCode说明：

按照通用

正确返回 retData说明：

示例

调用方式

uplusapi.upStorageModule.getTemporaryStorage({
  key:'a'
}).then(
  (result) =>console.log('result',result),
  (error) =>console.log('error',error)
);

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "操作成功",
  "retData": { "value":"123" }
  }
}

• deleteTemporaryStorage（删除临时存储）

  deleteTemporaryStorage({params})

适用性

params 输入参数：

错误返回 retCode说明：

按照通用

正确返回 retData说明：

无

示例

调用方式

uplusapi.upStorageModule.deleteTemporaryStorage({
  key:'a',
  value:'123'
}).then(
  (result) =>console.log('result',result),
  (error) =>console.log('error',error)
);

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "操作成功",
  "retData": ''
  }
}

• clearTemporaryStorage（清空临时存储）

  clearTemporaryStorage()

适用性

params 输入参数：

无

错误返回 retCode说明：

按照通用

正确返回 retData说明：

无

示例

调用方式

uplusapi.upStorageModule.clearTemporaryStorage().then(
  (result) =>console.log('result',result),
  (error) =>console.log('error',error)
);

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "操作成功",
  "retData": ''
  }
}

• addDataListener(添加临时存储数据变化监听)

  addDataListener({param},listener)

适用性

param 输入参数：

listener说明：

|属性名 |数据类型 |是否必填 |说明 | |listener|Function| 是 |监听函数|

listener回调数据说明： |属性名 |数据类型 |说明 | |key |String |key值| |action|String | 数据变更动作：delete\update\append|

ps:本回调不会返回变更后的值，需要业务方在触发监听动作后自主查询。

错误返回 retCode说明：

按照通用

正确返回 retData说明：

无

示例

调用方式

  function listener(result) {
    console.log('result',result),
  }
  uplusapi.upStorageModule.addDataListener({key:'a'}, listener).then((result) => {
    console.log('result',result),
  }).catch((err) => {
    console.log("addDataListener err",err);
  });

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "执行成功",
  "retData": ''
}
监听接收数据
{
  "key":"a",
  "action":"update"
}

• removeDataListener (移除临时存储数据变化监听)

  removeDataListener({param},listener)

适用性

param 输入参数：

listener说明：

|属性名 |数据类型 |是否必填 |说明 | |listener|Function| 是 |监听函数|

ps:本回调“listener”需要和addDataListener传入的listener函数是同一个，否则会移除失败。

错误返回 retCode说明：

按照通用

正确返回 retData说明：

无

示例

调用方式

  function listener(result) {
    console.log('result',result),
  }
  uplusapi.upStorageModule.removeDataListener({key:'a'}, listener).then((result) => {
    console.log('result',result),
  }).catch((err) => {
    console.log("removeDataListener err",err);
  });

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "执行成功",
  "retData": ''
}

• addNodeListener(添加节点数据变化监听)

  addNodeListener({param},listener)

适用性

param 输入参数：

ps：注意和临时存储监听的参数是不同的。

listener说明：

|属性名 |数据类型 |是否必填 |说明 | |listener|Function| 是 |监听函数|

listener回调数据说明： |属性名 |数据类型 |说明 | |key |String |key值| |action|String | 数据变更动作：delete\update\append|

ps:本回调不会返回变更后的值，需要业务方在触发监听动作后自主查询。

错误返回 retCode说明：

按照通用

正确返回 retData说明：

无

示例

调用方式

  function listener(result) {
    console.log('result',result),
  }
  uplusapi.upStorageModule.addNodeListener({storageName:'a'}, listener).then((result) => {
    console.log('result',result),
  }).catch((err) => {
    console.log("addNodeListener err",err);
  });

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "执行成功",
  "retData": ''
}
监听接收数据
{
  "key":"a",
  "action":"update"
}

• removeNodeListener (移除节点数据变化监听)

  removeNodeListener({param},listener)

适用性

param 输入参数：

ps：注意和解除临时存储监听的参数是不同的。

listener说明：

|属性名 |数据类型 |是否必填 |说明 | |listener|Function| 是 |监听函数|

ps:本回调“listener”需要和addNodeListener传入的listener函数是同一个，否则会移除失败。

错误返回 retCode说明：

按照通用

正确返回 retData说明：

无

示例

调用方式

  function listener(result) {
    console.log('result',result),
  }
  uplusapi.upStorageModule.removeNodeListener({storageName:'a'}, listener).then((result) => {
    console.log('result',result),
  }).catch((err) => {
    console.log("removeNodeListener err",err);
  });

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "执行成功",
  "retData": ''
}

通用存储常用字段汇总