文档中心 > API

QN.localstore

更新时间：2017/10/16 访问次数：4319

本地存储

本地的持久化存储，有效范围为整个插件。

API 调用

QN.localstore.set(options) / QN.localstore.setSync(options)

存储数据

同步接口支持版本：iOS >= 6.3.0 Android >= 6.3.0

API 调用入参

参数名 类型 是否可选 默认值 含义
options Object 选项
options.query Object 需要存储的数据对象，key/value 的形式，支持多个
options.success Function 可选 调用成功的回调函数
options.error Function 可选 调用失败的回调函数

API 响应结果

参数名 类型 是否一定返回 含义
result Object 响应对象
result.code String 错误码，成功为 QAP_SUCCESS；失败为其他
result.msg String 错误信息

调用示例

// 异步调用
QN.localstore.set({
    query: {
        name: '张三',
        age: 18,
        data: {x: 1, y: 2},
    }
}).then(result => {
    console.log(result);
}, error => {
    console.log(error);
});
// 同步调用
let result = QN.localstore.setSync({
    query: {
        name: '张三',
        age: 18,
        data: {x: 1, y: 2},
    }
});
console.log(result);

QN.localstore.get(options) / QN.localstore.getSync(options)

查询数据

同步接口支持版本：iOS >= 6.3.0 Android >= 6.3.0

API 调用入参

参数名 类型 是否可选 默认值 含义
options Object 选项
options.query Object 请求参数
options.query.key String Array 存储的 key 或 以 key 组成的数组
options.success Function 可选 调用成功的回调函数
options.error Function 可选 调用失败的回调函数

API 响应结果

参数名 类型 是否一定返回 含义
result Object 响应对象
result.code String 错误码，成功为 QAP_SUCCESS；失败为其他
result.msg String 错误信息
result.data Object 获取到的数据，格式为 key value，如果某个 key 未取到值，则 data 中将不包含该 key

调用示例

// 异步调用，获取一个 key 的数据
QN.localstore.get({
    query: {
        key: 'name'
    }
}).then(result => {
    console.log(result);
}, error => {
    console.log(error);
});

// 同步调用
let result = QN.localstore.getSync({
    query: {
        key: 'name'
    }
});
console.log(result);
// 异步调用，获取多个 key 的数据
QN.localstore.get({
    query: {
        key: ['name', 'age', 'data', 'job']
    }
}).then(result => {
    console.log(result);
    /**
     * // `job` 这个字段没有值，`data` 中将不包含 `job` 字段
     * {
     *   errorCode: 0,
     *   errorMsg: '',
     *   data: {
     *      name: '张三',
     *      age: '18',
     *      data: {x: 1, y: 2},
     *      job: null  // 如果存储中没有数据，则返回null
     *   }
     * }
     */
}, error => {
    console.log(error);
});

// 同步调用
let result = QN.localstore.getSync({
    query: {
        key: ['name', 'age', 'data', 'job']
    }
});
console.log(result);

QN.localstore.remove(options) / QN.localstore.removeSync(options)

删除数据

同步接口支持版本：iOS >= 6.3.0 Android >= 6.3.0

API 调用入参

参数名 类型 是否可选 默认值 含义
options Object 选项
options.query Object 请求参数
options.query.key String Array 存储的 key 或 以 key 组成的数组
options.success Function 可选 调用成功的回调函数
options.error Function 可选 调用失败的回调函数

API 响应结果

参数名 类型 是否一定返回 含义
result Object 响应对象
result.code String 错误码，成功为 QAP_SUCCESS；失败为其他
result.msg String 错误信息

调用示例

// 异步调用，删除一个 key 的数据
QN.localstore.remove({
    query: {
        key: 'name'
    }
}).then(result => {
    console.log(result);
}, error => {
    console.log(error);
});

// 同步调用
let result = QN.localstore.removeSync({
    query: {
        key: 'name'
    }
});
console.log(result);
// 异步调用，删除多个 key 的数据
QN.localstore.remove({
    query: {
        key: ['name', 'age', 'data', 'job']
    }
}).then(result => {
    console.log(result);
}, error => {
    console.log(error);
});

// 同步调用
let result = QN.localstore.removeSync({
    query: {
        key: ['name', 'age', 'data', 'job']
    }
});
console.log(result);

QN.localstore.clear(options) / QN.localstore.clearSync(options)

清除数据

同步接口支持版本：iOS >= 6.3.0 Android >= 6.3.0

API 调用入参

参数名 类型 是否可选 默认值 含义
options Object 可选 选项
options.success Function 可选 调用成功的回调函数
options.error Function 可选 调用失败的回调函数

API 响应结果

参数名 类型 是否一定返回 含义
result Object 响应对象
result.code String 错误码，成功为 QAP_SUCCESS；失败为其他
result.msg String 错误信息

调用示例

// 异步调用
QN.localstore.clear()
.then(result => {
    console.log(result);
}, error => {
    console.log(error);
});

// 同步调用
let result = QN.localstore.clearSync();
console.log(result);

FAQ

关于此文档暂时还没有FAQ
有用(0) 我要提问
返回
顶部
阿里巴巴集团 | 淘宝网 | 天猫 | 聚划算 | 全球速卖通 | 阿里巴巴国际交易市场 | 1688 | 阿里妈妈 | 阿里旅行·去啊 | 阿里云计算 | YunOS | 阿里通信 | 万网 | 高德 | 优视 | 友盟 | 酷盘 | 虾米 | 天天动听 | 来往 | 钉钉 | 11Main | 支付宝
关于淘宝 合作伙伴 营销中心 联系客服 开放平台 诚征英才 联系我们 网站地图 法律声明 © 2016 Taobao.com 版权所有
网络文化经营许可证：文网文[2010]040号 | 增值电信业务经营许可证：浙B2-20080224-1 | 信息网络传播视听节目许可证：1109364号