享道出行开放平台文档中心

# APP框架方法定义

webview的window挂载变量：AppEvent

# 1、获取当前环境

API说明：获取当前环境是否为嵌入在APP中

参数：无

返回：‘APP’

调用示例

AppEvent.getENV()

# 2、设置导航栏外观

API说明：设置APP打开的webview头部导航

# 参数说明

参数名称 类型 必选 默认值 说明
title string 否 无 标题文字
titleColor string 否 '#000000' 标题颜色
titileIcon string 否 无 标题icon
leftIcon string 否 无 左导航Icon
rightIcon string 否 无 右导航Icon
hide boolean 否 false 是否隐藏整个导航
background string 否 '#ffffff' 导航背景色
leftText string 否 无 左按钮文字
leftTextColor string 否 ‘#34495e’ 左按钮文字颜色
rightText string 否 无 右按钮文字
rightTextColor string 否 ‘#34495e’ 右按钮文字颜色
leftHide boolean 否 false 是否隐藏导航左控件
rightHide boolean 否 false 是否隐藏导航右控件
leftClick function 否 返回 左按钮点击事件
rightClick function 否 无 右按钮点击事件
success function 否 无 设置成功回调
fail function 否 无 设置失败回调

TIP

备注：单独设置某个字段，不设置其他字段时不会清空已设置过的字段；例如开始已经调用过一次设置title， AppEvent.setNavigationBar({title:'享道出行'})，下次再调用设置 AppEvent.setNavigationBar({leftClick:() => {}}) 不会清空前面的title

# 调用示例

AppEvent.setNavigationBar({
    title: '享道出行'，
    titleColor: '#999999',
    titleIcon: 'https://example.com/example.png'，
    leftIcon:'https://example.com/example.png',
    rightIcon:'https://example.com/example.png',
    hide:  true ，
    leftHide: true，
    rightHide: true，
    leftClick: function(){},
    rightClick: function(){},
    success:function(){}，
    fail：function() {}，
})

# 3、关闭当前webview

API说明：关闭当前webview回到App原生页面 参数说明：无

# 调用示例

AppEvent.closeWindow()

# 4、获取当前位置

API说明：调用App获取用户当前经纬度

# 参数说明

参数名称 类型 必选 默认值 说明
type string 是 'gd' 坐标系类型
success \function 否 无 获取定位成功回调
fail \function 否 无 获取定位失败回调

# 成功返回参数

参数名称 类型 说明
code number 失败code：10001 未开启定位；10002 GPS信号弱；10003 无获取定位权限

# 调用示例

AppEvent.getLocation({
  type: 'gd', // 高德
  success: function (res) {
    var latitude = res.latitude; // 纬度，浮点数，范围为90 ~ -90
    var longitude = res.longitude; // 经度，浮点数，范围为180 ~ -180。
  },
  fail: function(code) {
    // code 10001 未开启定位
    // code 10002 GPS信号弱
    // code 10003 无获取定位权限
  }
})

# 5、呼起App分享

API说明：呼起APP分享

# 参数说明

参数名称 类型 必选 默认值 说明
title string 是 无 分享标题
desc string 是 无 分享描述
link string 是 无 分享链接
imgUrl string 是 无 分享图片
shareType string 是 无 分享类型
success function 否 无 设置成功回调
fail function 否 无 设置失败回调

# shareType分享方式的枚举值

值 说明
weixin 微信
weixinTimeline 微信朋友圈
qqFriend QQ好友

# 调用示例

AppEvent.openShare({
  title: '', // 分享标题
  desc: '', // 分享描述
  link: '', // 分享链接
  imgUrl: '', // 分享图标
  shareType: 'weixin',
  success: function () {
  },
  fail: function() {
  }
})

# 6、拨打电话

API说明：调用App能力拨打电话

# 参数说明

参数名称 类型 必选 默认值 说明
phoneNumber string 是 无 要呼出的电话号码
success function 否 无 设置成功回调
fail function 否 无 设置失败回调

# 调用示例

AppEvent.makePhoneCall({
  phoneNumber： 18888888888 // 电话号码
  success: function () {
  },
  fail: function() {
  }
})

# 7、获取联系人

API说明：获取手机联系人

# 参数说明

参数名称 类型 必选 默认值 说明
success function 否 无 设置成功回调
fail function 否 无 设置失败回调

# 成功返回参数

参数名称 类型 说明
name string 姓名
phone string 号码

# 失败返回参数

参数名称 类型 说明
err string 失败原因

# 调用示例

AppEvent.getContact: ({
    success: function(name, phone){}, // 成功返回联系人姓名和手机号
    fail:function(err){}, // 失败抛出失败原因
  })

# 8、调用图片查看器

API说明：查看图片

# 参数说明

参数名称 类型 必选 默认值 说明
current string 是 无 当前展示的图片的https链接
urls Array 是 无 所有需要展示图片的https链接数组
success function 否 无 设置成功回调
fail function 否 无 设置失败回调

# 调用示例

AppEvent.previewImage({
  current: '', // 当前显示图片的链接
  urls: [], // 需要预览的图片链接列表
});

# 9、监听App由后台切换至前台

API说明：App由后台切换至前台时触发的回调

# 参数说明

参数名称 类型 必选 默认值 说明
invoke function 是 无 由后台切换至前台的回调
success function 否 无 设置成功回调
fail function 否 无 设置失败回调

# invoke函数返回值

参数名称 类型 说明
backTime number 在后台停留的时间（分钟）

# 调用示例

AppEvent.appShow({
    invoke: function(res) {}
})

# 10、获取当前网络状态

API说明：获取当前设备网络状态

# 参数说明

参数名称 类型 必选 默认值 说明
success function 否 无 设置成功回调
fail function 否 无 设置失败回调

# 成功回调参数说明

字段 说明 类型
type 获取当前手机连接的网络类型（wifi/mobile/unknown/none）分别代表无线网/移动蜂窝网络/未知网络/无网络连接 string

# 调用示例

AppEvent.getNetworkInfo({
    sucess: function(type) {},
    fail: function(err) {}
})

# 11、是否开启IOS系统页面弹性效果 （非必须）（仅IOS）

API说明：在嵌入IOS系统中，开启获关闭webview页面弹性效果

# 调用示例

AppEvent.webViewBounce(true | false); // true开启, false关闭

← 订单投诉接口 →