1.3.3.1 QN.app

优质
小牛编辑
134浏览
2023-12-01

通用协议接口是千牛提供的与业务能力相关的一系列接口。

1.1. API 查询

1.2. API 调用

1.2.1. QN.app.invoke(options)

发起通用协议接口调用

API 调用入参

参数名类型是否可选默认值含义
optionsObject选项
options.apiString通用协议接口名称
options.queryObject请求参数,具体查看每个通用协议接口所需的参数

API 响应结果

参数名类型是否必须返回含义
result*响应对象,具体查看每个通用协议接口返回的结果

调用示例

QN.app.invoke({
    api: 'itemList',         // 通用协议接口名称
    query: {                 // 请求参数
        itemStatus: 'onsale'
    }
}).then(result => {
    console.log(result);
}, error => {
    console.log(error);
});

QN.app.invoke({
    api: 'itemList',         // 通用协议接口名称
    query: {                 // 请求参数
        itemStatus: 'onsale'
    },
    success(result) {
        console.log(result);
    },
    error(error) {
        console.log(error);
    },
});

1.2.2. QN.app.name

String 应用名称

返回值含义
qianniu千牛
taobao淘宝
tmall天猫
alipay支付宝
16881688
wangxin旺信
dingtalk钉钉
web浏览器

1.2.3. QN.app.group

String 应用所属的族系

返回值含义
AliApp阿里系App
Other其他

1.2.4. QN.app.version

Object 应用版本对象

1.2.5. QN.app.version.value

String 千牛版本

1.2.6. QN.app.version.gt(version)

判断版本是否大于某个版本

API 调用入参

参数名类型是否可选默认值含义
versionNumber String需要对比的版本号

API 响应结果

参数名类型是否必须返回含义
resultBooleantrue 为判断成立, false 为判断不成立

调用示例

// 假设 千牛App版本为 5.0
QN.app.version.gt(4); // => true
QN.app.version.gt(6); // => false
QN.app.version.gt('4.4.4'); // => true
QN.app.version.gt('6.6.6'); // => false

1.2.7. QN.app.version.gte(version)

判断版本是否大于或等于某个版本

API 调用入参

参数名类型是否可选默认值含义
versionNumber String需要对比的版本号

API 响应结果

参数名类型是否必须返回含义
resultBooleantrue 为判断成立, false 为判断不成立

调用示例

// 假设 千牛App版本为 5.0
QN.app.version.gte(4); // => true
QN.app.version.gte(5); // => true
QN.app.version.gte(6); // => false
QN.app.version.gte('4.4.4'); // => true
QN.app.version.gte('5.0.0'); // => true
QN.app.version.gte('6.6.6'); // => false

1.2.8. QN.app.version.eq(version)

判断版本是否等于某个版本

API 调用入参

参数名类型是否可选默认值含义
versionNumber String需要对比的版本号

API 响应结果

参数名类型是否必须返回含义
resultBooleantrue 为判断成立, false 为判断不成立

调用示例

// 假设 千牛App版本为 5.0
QN.app.version.eq(5); // => true
QN.app.version.eq(6); // => false
QN.app.version.eq('5.0.0'); // => true
QN.app.version.eq('6.6.6'); // => false

1.2.9. QN.app.version.lt(version)

判断版本是否小于某个版本

API 调用入参

参数名类型是否可选默认值含义
versionNumber String需要对比的版本号

API 响应结果

参数名类型是否必须返回含义
resultBooleantrue 为判断成立, false 为判断不成立

调用示例

// 假设 千牛App版本为 5.0
QN.app.version.lt(4); // => false
QN.app.version.lt(6); // => true
QN.app.version.lt('4.4.4'); // => false
QN.app.version.lt('6.6.6'); // => true

1.2.10. QN.app.version.lte(version)

判断版本是否小于或等于某个版本

API 调用入参

参数名类型是否可选默认值含义
versionNumber String需要对比的版本号

API 响应结果

参数名类型是否必须返回含义
resultBooleantrue 为判断成立, false 为判断不成立

调用示例

// 假设 千牛App版本为 5.0
QN.app.version.lte(4); // => false
QN.app.version.lte(5); // => true
QN.app.version.lte(6); // => true
QN.app.version.lte('4.4.4'); // => false
QN.app.version.lte('5.0.0'); // => true
QN.app.version.lte('6.6.6'); // => true