基础api

基础api
Promise编程, ready, 配置, 判断API可用性, 非公共API使用, 检测是否安装的app, 版本对比

Defined in: src/doc/doc.js:53
Module: dpzeus

方法

config

config
(
  • opts
)

Defined in src/doc/doc.js:93

选择配置DPZeus
注：前端静态配置方法，不与native交互

参数:

opts Object

配置项
参数名类型标识描述
opts Object

配置项

Example:

<html>
    <h1>选择配置DPApp</h1>
</html>
<script>
DPZeus.config({
    debug: false, //是否开启调试模式。开启后会以alert打印调试信息。default: false
    bizname: "your-bizname", //存储及相关api需要该配置,
    success: function(data){
        alert(JSON.stringify(data));
    },
    fail: function(error){
        alert(JSON.stringify(error));
    }
});
</script>

getPromiseInstance

getPromiseInstance () Object

Defined in src/doc/doc.js:65

获得一个基于Promise封装的DPApp拷贝 所有API的方法调用在这个Object下均被 Promise 化
注：并未完全实现，慎用

Returns:

[Object]

依据调用的API而决定

Example:

<html>
    <h1>获得一个基于Promise封装的DPApp拷贝
所有API的方法调用在这个Object下均被 Promise 化</h1>
</html>
<script>
DPZeus.getPromiseInstance().getUA().then(function(info){
    alert(JSON.stringify(info));
}, function(fail){
    alert(JSON.stringify(fail));
});
</script>

isApiSupported

isApiSupported
(
  • opts
)
Object

Defined in src/doc/doc.js:106

Available since 2.0.0

判断API可用性

参数:

opts Object
opts.apiName String

需要查看的API名称（仅methodName）
opts.success Function

成功回调
opts.fail Function

失败回调
参数名类型标识描述
opts Object
参数名类型标识描述
apiName String

需要查看的API名称（仅methodName）

success Function

成功回调

fail Function

失败回调

Returns:

[Object]

Base

Example:

<html>
    <h1>判断API可用性</h1>
</html>
<script>
DPZeus.isApiSupported({
    apiName: 'alert',  //
    success: function(data){
//        log(isSupported); //boolean,支持返回true,反之为false
        alert(JSON.stringify(data));
    },
    fail: function(error){
        //log(error);
        alert(JSON.stringify(error));
    }
});
</script>

isInstalledApp

isInstalledApp
(
  • opts
)
Object

Defined in src/doc/doc.js:123

检测是否安装的app

参数:

opts Object
opts.scheme String

app scheme 供IOS使用
opts.package String

app package 供安卓使用
opts.success Function

成功回调
opts.fail Function

失败回调
参数名类型标识描述
opts Object
参数名类型标识描述
scheme String

app scheme 供IOS使用

package String

app package 供安卓使用

success Function

成功回调

fail Function

失败回调

Returns:

[Object] 
{
 installed: <Boolean>
}

Example:

<html>
    <h1>检测是否安装的app</h1>
</html>
<script>
DPZeus.isInstalledApp({
    scheme: "qq://",
    package: "com.tencent.mobileqq",
    success: function(result){
        alert(JSON.stringify(result));
    },
    fail: function(error){
        alert(JSON.stringify(error));
    }
});
</script>

ready

ready
(
  • callback
)

Defined in src/doc/doc.js:79

等待整个native就绪后执行回调里的逻辑

参数:

callback Function

需要执行的回调方法
参数名类型标识描述
callback Function

需要执行的回调方法

Returns:

没有回调值

Example:

<html>
    <h1>等待整个native就绪后执行回调里的逻辑</h1>
</html>
<script>
DPZeus.ready(function(){
    //页面主逻辑
    alert('ready done!');
});
</script>

Semver

Semver () Boolean

Defined in src/doc/doc.js:143

版本比对工具函数
使用方式
DPZeus.Semver.gt(versionA,versionB); // 是否大于
DPZeus.Semver.gte(versionA,versionB); // 是否大于等于
DPZeus.Semver.lt(versionA,versionB); // 是否小于
DPZeus.Semver.lte(versionA,versionB); // 是否小于等于
DPZeus.Semver.eq(versionA,versionB); // 是否相同(严格全等)

Returns:

Boolean:

Example:

<html>
版本比对工具函数
</html>
<script>
var ver1 = "1.2.5", ver2 = "1.2.6";
var data = {
  gt: DPZeus.Semver.gt(ver1, ver2),
  gte: DPZeus.Semver.gte(ver1, ver2),
  lt: DPZeus.Semver.lt(ver1, ver2),
  lte: DPZeus.Semver.lte(ver1, ver2),
  eq: DPZeus.Semver.eq(ver1, ver2),
}
alert(JSON.stringify(data))
</script>

use

use () Object deprecated

Defined in src/doc/doc.js:161

自定义调用
注：KNB中的方法，在DPZeus中不打算实现
详细说明请参见非公共API使用

Returns:

[Object]

依据调用的API而决定

Example:

<html>
    <h1>自定义调用</h1>
</html>
<script>
DPZeus.config({bizName: "dpzues-test"});
DPZeus.use('publish', {
        action: 'changePhone'
    }
);
</script>