文档中心 > API

QN.sessionstore

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

会话存储

会话存储

本地会话存储，关闭插件后删除。有效范围为整个插件。

API 调用

QN.sessionstore.set(options) / QN.sessionstore.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.sessionstore.set({
    query: {
        name: '张三',
        age: 18,
        data: {x: 1, y: 2},
    }
}).then(result => {
    console.log(result);
}, error => {
    console.log(error);
});
// 同步调用
let result = QN.sessionstore.setSync({
    query: {
        name: '张三',
        age: 18,
        data: {x: 1, y: 2},
    }
});
console.log(result);

QN.sessionstore.get(options) / QN.sessionstore.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.sessionstore.get({
    query: {
        key: 'name'
    }
}).then(result => {
    console.log(result);
}, error => {
    console.log(error);
});

// 同步调用
let result = QN.sessionstore.getSync({
    query: {
        key: 'name'
    }
});
console.log(result);

// 异步调用，获取多个 key 的数据
QN.sessionstore.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.sessionstore.getSync({
    query: {
        key: ['name', 'age', 'data', 'job']
    }
});
console.log(result);

QN.sessionstore.remove(options) / QN.sessionstore.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.sessionstore.remove({
    query: {
        key: 'name'
    }
}).then(result => {
    console.log(result);
}, error => {
    console.log(error);
});

// 同步调用
let result = QN.sessionstore.removeSync({
    query: {
        key: 'name'
    }
});
console.log(result);

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

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

QN.sessionstore.clear(options) / QN.sessionstore.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.sessionstore.clear()
.then(result => {
    console.log(result);
}, error => {
    console.log(error);
});

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

FAQ

关于此文档暂时还没有FAQ

有用(0) 我要提问

开放平台

API

QN.sessionstore

会话存储

API 调用

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

API 调用入参

API 响应结果

调用示例

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

API 调用入参

API 响应结果

调用示例

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

API 调用入参

API 响应结果

调用示例

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

API 调用入参

API 响应结果

调用示例

FAQ