JSAPI接口文档

接口调用说明

  • 调用友空间接口需要先加载bridge.js ( 下载 )
  • 调用具体功能前需要先进行安全认证
  • 调用方式:
	yyesn.类别.函数名(callback,parameters);
  • callback 为提供给native客户端的回调函数

  • parameters 传递给native接口的参数

  • parameters中又包含callback参数的需要提前通过register函数注册才能被调用

  • 调用示例:


初始化完成回调函数

  • 函数名称:ready
  • 功能:bridge初始化成功立即调用
  • 参数:必须为函数
  • 调用示例:
yyesn.ready(function(){
    alert('test');
})

安全认证

  • 函数名称:config
  • 安全认证参数:
参数名是否必填类型长度默认值说明
corpIdYstring0企业ID
nonceStrYstring生成签名的随机串
timeStampYnumber生成签名的时间戳
signatureYstringJS-API签名
agentIdYnumber微应用ID,普通企业可以通过OA后台的微应用-设置查看agentID,ISV需要通过调用授权成功后的get_auth_info获取授权方的agentid
urlYstring请求的url(请求的域名,白名单会跳过jstick验证)
jsApiListYarray需要调用的jsapi列表
  • 安全认证需要在bridge初始化完成后立即调用

  • 调用示例:

yyesn.ready(function () {
                yyesn.config({
                        'corpId':"open492d2283ac0b" ,
                        'nonceStr': "123456",
                        'timeStamp': 1474945174935,
                        'signature': "43d99d92d5",
                        'agentId': 3,
                        'url': "http://test.com/demo.html",
                        'jsApiList': ["hiddenMenu"]
                    });



        });

函数注册

  • 函数名称:register
  • 函数注册参数:必须为object (其中key为注册的函数名称, value必须为函数类型即注册的函数体)
  • 注册示例:
yysen.register({test:function(d){alert(d)}});

1.隐藏友空间导航条

  • 函数名称:"hiddenMenu"
  • 类别:client
  • 参数:无
  • 返回值:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据

2.关闭webview页面

  • 函数名称:"closePage"
  • 类别:client
  • 参数:无
  • 返回值:无

3.设置导航栏

  • 函数名称:"setHeader"
  • 类别:client
  • 参数:
参数名是否必填类型长度默认值说明
centerValuesYarray0中间菜单项列表 ,列表选项如果是一个的话直接是点击图标就执行操作
rightValuesNarray右侧菜单项列表 ,列表选项如果是一个的话直接是点击图标就执行操作
typeNarray1是图片,2是文字,文字的话values只能是一个。图片的话icon为必填项。
rightTitleNstring右侧的文字
iconNstring右侧图标地址(选填)
titleNstring中间的文字
navColorNstring导航条颜色(当前不建议设置成白色,如果需要白色,直接不设置就好)
screenOrientationNstring1竖屏2横屏 默认是竖屏
  • 参数示例
    parameters:{"centerValues":[{
                    "key":"item0","value":"菜单一"
                    },{
                    "key":"item1","value":"菜单二"
                }],
                "rightValues":[{
                    "key":"itemr0","value":"菜单一"
                    },{
                    "key":"itemr1","value":"菜单二"
                    }],
                "icon":"http://xxx/xxx.png"
            }

  • 返回值:无

4.打开新的webview

  • 函数名称:"openWindow"
  • 类别:client
  • 参数:
参数名是否必填类型长度默认值说明
orientationYstring窗体类型0 纵向1随重力感应可横向可纵向 2横向 默认纵向
urlYstring访问的url
navShowNstring继承父窗体仅限iOS)是否显示导航条 2:隐藏 1:显示
navColorNstring继承父窗体(仅限iOS)导航条色值 必须是标准格式 #FFFFFF
statusBarColorNstring继承父窗体(仅限iOS)状态条色值 必须是标准格式 #FFFFFF,如果没有设置默认使用navColor
hideToolbarNstring继承父窗体(仅限iOS)是否隐藏右上角的更多操作工具条项 1:隐藏
  • 参数示例:
    parameters: {
        orientation: '2',
        url: 'http://www.baidu.com'
    }
  • 返回值:无

5.打开app

  • 函数名称:"openApp"
  • 类别:enterprise
  • 参数:
参数名是否必填类型长度默认值说明
app_idYstring应用id
titleYstring应用名称
  • 参数示例:
    parameters: {
        app_id: '2',
        title: 'http://www.baidu.com'
    }
  • 返回值:无

6.选择日期

  • 函数名称:"selectDate"
  • 类别:client
  • 参数:
参数名是否必填类型长度默认值说明
timeNstring时间戳
modeNstring日期类型1是带时分的
  • 参数示例:
    parameters: {
        mode: '1'
    }
  • 返回值:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据
  • 响应data:
参数名是否返回类型长度默认值说明
timeYnumber时间戳

7.选择列表

  • 函数名称:"selectList"
  • 类别:client
  • 参数:
参数名是否必填类型长度默认值说明
valuesYstring所需要的列表逗号分隔的字符串
checkvalueNstring已选中的值
keysNstringvalues所对应的keys
checkkeyNstringcheckvalue所对应的key,如果传key就根据key来判断
  • 参数示例:
    parameters:{
        values:"病假,事假,漏打卡",
        checkvalue:"事假",
        keys:"1101,1102,1103",
        checkKey:"1102"
    }
  • 返回值:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据
  • 响应data:
参数名是否返回类型长度默认值说明
keyYstring选中的键
valueYstring选中的值

8.选择联系人

  • 函数名称:"selectContacts"
  • 类别:enterprise
  • 参数:
参数名是否必填类型长度默认值说明
multiNnumber11为多选 0为单选
modeNnumber11为联系人 2为手机通讯录
select_listNarray已选人对象的list
max_numNnumber最大选择人数
select_numNnumber已选择人数
nav_titleNstring选择联系人选择联系人页面的标题
nav_colorNstring#007ddc页面颜色值
  • 参数示例:
    parameters:{
        nav_title: '55',
        nav_color: '#222222',
        select_list: [{
        "tel": "15701006902",
        "avatar": "http://test.staticoss.upesn.com/1/3893/201508/6/1438831550ESiE.png",
        "name": "Wan",
        "is_caller": 0,
        "member_id": 0,
        "member_type": 0,
        "in_qz": 0,
        "id": 3893,
        "_id": 0,
        "type": 0
        }]
    }
  • 返回值:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据
  • 响应data:同已选人对象list

9.调用嘟嘟打电话

  • 函数名称:"callUer"
  • 类别:enterprise
  • 参数:
参数名是否必填类型长度默认值说明
member_idYstring用户id
nameYstring用户名称
avatarYstring用户头像
mobileYstring用户手机号
  • 参数示例:
    parameters:{
        'mobile':'13120215037',
        'avatar':'http://test.staticoss.upesn.com/1/3598/201509/24/1443079150TfFF.jpg',
        'name':'张金波',
        'member_id':11
    }
  • 返回值:无

10.选择附件

  • 函数名称:"selectAttachment"
  • 类别:client
  • 参数:
参数名是否必填类型长度默认值说明
typeNstring选择附件的类型1图片2视频3 文件4拍照
maxselectnumNstring9可选图片的最大数量,附件默认是9
  • 参数示例:
    parameters:{
        'type':'2'
    }
  • 返回值:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据
  • 响应data:files数组
  • file对象详情:
参数名是否一定返回类型长度默认值说明
thumbNstring缩略图
fnameYstring文件名称
pathYstring文件路径
fidYstring文件id
filesizeYnumber文件大小

11.选择城市

  • 函数名称:"selectCity"
  • 类别:client
  • 参数:
参数名是否必填类型长度默认值说明
provinceNstring省份
cityNstring城市
  • 参数示例:
    parameters:{ 'province': '55', 'city': '微邮' }
  • 返回值:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据
  • 响应data
参数名是否必填类型长度默认值说明
provinceNstring省份
cityNstring城市

12.地图定位

  • 函数名称:"selectMap"
  • 类别:client
  • 请求参数:
参数名是否必填类型长度默认值说明
radiusNnumber0
  • 参数示例:
    parameters:{ radius:100 }
  • 返回值:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据
  • 响应data
参数名是否必填类型长度默认值说明
addrstrYstring地址
latitudeYnumber经度
longitudeYnumber纬度
zoomYstring缩放级别
  • 响应数据示例
    {
        "error_code": "4",
        "tip_level":“0”,
        "error": "ERROR_API_PARAMS",
        "error_description": "参数错误",
        "data": {
        "addrstr": "北京市海淀区北清路68号院22号楼",
        "zoom": 16,
        "longitude": 116.241739,
       "latitude": 40.073996
        }
    }

13.分享接口

  • 函数名称:"share"
  • 类别:client
  • 请求参数:
参数名是否必填类型长度默认值说明
contentYstring分享的内容
titleNstring分享的标题
imgUrlNstring分享的图标
urlNstring分享后打开的地址
  • 参数示例:
    parameters:{
        'content': '分享内容',
        'title': '分享标题',
        'imgUrl': 'http://upesn.com/default.jpg',
        'url':"http://www.baidu.com"
    }
  • 返回值:同上
  • 响应data
参数名是否必填类型长度默认值说明
addrstrYstring地址
latitudeYnumber经度
longitudeYnumber纬度
zoomYstring缩放级别
  • 响应数据示例
    {
        "error_code": "4",
        "tip_level":“0”,
        "error": "ERROR_API_PARAMS",
        "error_description": "参数错误"
    }


14.绑定手机号

  • 函数名称:"bindPhone"
  • 类别:enterprise
  • 请求参数:无
  • 返回值: 无

15.评论回复

  • 函数名称:"feedReply"
  • 类别:enterprise
  • 请求参数:
参数名是否必填类型长度默认值说明
idYstring动态的id
rIdNstring回复评论的id。
rNameNstring评论的人的名字
typeYstring对应的模块,现在有动态和任务,不传时默认是动态;任务传35,快审135
  • 参数示例:
    parameters:{
            "id":"1"
            "rId":"35",
            "rName":"李四"
    }
  • 返回值:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据
  • 响应data : 同上

16.图片预览

  • 函数名称:"viewImage"
  • 类别:client
  • 请求参数:
参数名是否必填类型长度默认值说明
filesYstring,'分隔的字符串
indexNstring第几张图片
  • 参数示例:
    parameters:{
        "files":"http://ddddd.jpg,http://ddddd.jpg",
        "index":1

    }
  • 返回值:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据
  • 响应data:同上

17.发送微邮

  • 函数名称:"sendMemail"
  • 类别:enterprise
  • 请求参数:
参数名是否必填类型长度默认值说明
usersYarray用户信息列表
  • user对象详情:同上
  • 参数示例
     parameters : {
        "users": [{
            'mobile': '13120215037',
            'avatar': 'dd',
            'name': '张金波',
            'member_id': 11
        }]
    }
  • 返回值:无

18.发送群组消息

  • 函数名称:"sendMessage"

  • 类别:enterprise

  • 请求参数:

  • | 参数名 | 是否必填 | 类型 | 长度 | 默认值 | 说明| | ------------- |:-------------:| -----:| -----:| -----: |-----:| |from_id|Y|number|||应用编号| |from_type|Y|number|||应用对象id|

  • 参数示例

     parameters:{
         "from_type":"55",
         "from_id":"1"
     }
  • 返回值:无

19.嘟嘟电话(多人)

  • 函数名称:"callUsers"
  • 类别:enterprise
  • 请求参数:
参数名是否必填类型长度默认值说明
usersYarray用户信息列表
  • user对象详情:
参数名是否必填类型长度默认值说明
member_idYstring用户
nameYstring用户名称
avatarYstring用户头像
mobileYstring手机号
  • 参数示例
     parameters : {
        "users": [{
            'mobile': '13120215037',
            'avatar': 'dd',
            'name': '张金波',
            'member_id': 11
        }]
    }
  • 返回值:无

20.选择团队

  • 函数名称:"selectGroup"
  • 类别:enterprise
  • 请求参数:
参数名是否必填类型长度默认值说明
usersYarray用户信息列表
  • user对象详情:同上
  • 参数示例
     parameters : {
        "users": [{
            'mobile': '13120215037',
            'avatar': 'dd',
            'name': '张金波',
            'member_id': 11
        }]
    }
  • 返回值:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据

21.@人

  • 函数名称:"processAt"
  • 类别:enterprise
  • 请求参数:
参数名是否必填类型长度默认值说明
gidNnumber团队id,如果有团队id是选择团队中的人
  • 参数示例
     parameters : {"gid":1123}
  • 返回值:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据
  • 响应data:
参数名是否一定返回类型长度默认值说明
member_idYstring用户id
nameYstring用户姓名

22.用户详情

  • 函数名称:"viewUser"
  • 类别:enterprise
  • 请求参数:
参数名是否必填类型长度默认值说明
member_idYstring用户id
  • 参数示例
     parameters : {"member_id":'1123'}
  • 返回值:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据

23.聊天窗口

  • 函数名称:"openChatWindow"
  • 类别:enterprise
  • 请求参数:
参数名是否必填类型长度默认值说明
chat_modeYnumber0单聊1群组2讨论组
send_idYstring发送者iD
send_nameYstring发送的名称
send_avatarNstring发送者头像
  • 参数示例
     parameters:{
         "chat_mode":1,
         "send_id":'1123',
         "send_name":'1123',
         "send_avatar":'1123'
    }
  • 返回值:无

24.复制文本

  • 函数名称:"copyText"
  • 类别:client
  • 请求参数:
参数名是否必填类型长度默认值说明
contentYstring复制内容
  • 参数示例
     parameters : {
        "content": "test"
    }
  • 返回值:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据

25.发言

  • 函数名称:"createFeed"
  • 类别:enterprise
  • 请求参数:
参数名是否必填类型长度默认值说明
gidYstring团队id
group_nameYstring团队名称
group_logoNstring团队logo
pubNstring是否公开
  • 参数示例
     parameters : {
        "gid":"111",
        "group_name":"测试"
     }
  • 返回值:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据

26.文件预览

  • 函数名称:"previewFile"
  • 类别:client
  • 请求参数:
参数名是否必填类型长度默认值说明
fidYstring文件id
  • 参数示例
     parameters : {
        "fid": "113"
    }
  • 返回值:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据

27.查看任务的进展

  • 函数名称:"viewTaskLog"
  • 类别:enterprise
  • 请求参数:
参数名是否必填类型长度默认值说明
taskIdYstring任务id
  • 参数示例
     parameters : {
        "taskId":"1121"
    }
  • 返回值:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据

28.查看任务的知会人/参与人

  • 函数名称:"viewTaskUser"
  • 类别:enterprise
  • 请求参数:
参数名是否必填类型长度默认值说明
taskIdYstring任务id
typeYnumber类型: 1-参与人 2-知会人 3-审批人
  • 参数示例
     parameters : {
       "taskId",'1123',
       "type":1
    }
  • 返回值:无

29.指派或编辑

  • 函数名称:"createOredit"
  • 类别:enterprise
  • 请求参数:
参数名是否必填类型长度默认值说明
idNstring任务id(指派任务时不需要传;编辑任务时必传)
typeNnumber模块类型(项目类型:180)
type_idYnumber应用模块ID(目前就是项目id)
  • 参数示例
     parameters : {
        "id":"1121"
    }
  • 返回值:无

30.任务的评价

  • 函数名称:"taskComment"
  • 类别:enterprise
  • 请求参数:
参数名是否必填类型长度默认值说明
task_idYstring任务的id
  • 参数示例
     parameters : {
        "task_id":'14411'
    }
  • 返回值:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据

31.带删除的大图浏览

  • 函数名称:"viewOrDeleteImage"
  • 类别:client
  • 请求参数:
参数名是否必填类型长度默认值说明
filesYarrayfile 对象的数组
indexYnumber第几张图片(从0开始)
isDeleteYnumber1是带删除0不带 默认不带
  • file对象详情
参数名是否必填类型长度默认值说明
thumbNstring缩略图
fnameNstring文件名称
pathNstring文件路径
fidNstring文件id
filesizeNnumber文件大小
  • 参数示例
     parameters:{
         "files":[{path:"http://ddddd.jpg"}],
         "index":2
    }
  • 响应参数:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据
  • 响应data:
参数名是否必填类型长度默认值说明
thumbNstring缩略图
fnameNstring文件名称
pathNstring文件路径
fidNstring文件id
filesizeNnumber文件大小

32.动态数据更新

  • 函数名称:"feedDataUpdate"
  • 类别:enterprise
  • 请求参数:
参数名是否必填类型长度默认值说明
typeYstring1:更新喜欢数(lnum, like)2:更新评论数(参数rnum))3:增加评论数(无需参数)
fidYstring动态id
rnumYstring评论数
lnumYstring喜欢(赞)数
likeYstring自己是否喜欢了(1:自己喜欢了,0: 自己未喜欢)
  • 参数示例
     parameters :  {
         'type': '1',
         'lnum': '3',
         'like':'1'
     }
  • 返回值:无

33.配置导航条(仅限ios)

  • 函数名称:"configNavigationBar"
  • 类别:client
  • 请求参数:
参数名是否必填类型长度默认值说明
navShowNstring是否显示导航条 1:显示 2:隐藏 0:默认
topOffSetNnumber内容距离山部的偏移,默认为:0
navColorClearNstring导航条颜色为透明,优先级别高于navColor,设置就以此为准
navColorNstring导航条的颜色 默认是 #FFFFFF
statusBarStatusNnumber状态栏状态,0: 保持当前色,1: 默认黑色 2:白色 此参数受到navColor影响,当navColor为#FFFFFF时,此参数无效
  • 参数示例
     parameters :  {
     'navShow': '2',
     'statusBarStatus': '1',
     'navColor': '#FFFFFF', }
  • 返回值:无

34.定位

  • 函数名称:"getLocation"
  • 类别:client
  • 请求参数:无
  • 返回值:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据
  • 响应data:
参数名是否必须返回类型长度默认值说明
latitudeYstring纬度
longitudeYstring0经度
accuracyYstring0水平精度

35.震动

  • 函数名称:"vibrate"
  • 类别:client
  • 请求参数:无
  • 返回值:无

36.摇一摇

  • 函数名称:"getShaking"
  • 类别:client
  • 请求参数:无
  • 返回值:无

37.计步

  • 函数名称:"getStepCount"
  • 类别:client
  • 请求参数:无
  • 响应data:
参数名是否必须返回类型长度默认值说明
stepCountYstring步数
  • 返回值:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据

38.截屏(暂时只支持ios)

  • 函数名称:"getScreenshot"
  • 类别:client
  • 请求参数:
参数名是否必填类型长度默认值说明
typeNnumber0截屏类型 1:截取整个屏幕(包括导航条) 0:默认(只截取webview)
  • 响应data:
参数名是否必须返回类型长度默认值说明
screenshotNString截屏图片base64编码后的字符串
  • 参数示例
     parameters :  {
     'type': '0'
     }
  • 返回值:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据

39.配置导航栏

  • 函数名称:"configNavBar"
  • 类别:client
  • 请求参数:
参数名是否必填类型长度默认值说明
hideNnumber00:显示 1:隐藏
hideShadowImageNnumber00:显示导航栏底部线 1:不显示
backgroundColorNstring导航条背景色颜色
tintColorNstring导航栏上返回按钮、标题等等的颜色统一设置
progressBarColorNstring进度条颜色(默认为tintColor颜色)
statusBarStyleNnumber0状态栏样式(0:黑色 1:白色)
leftItemsNarray导航栏左边的菜单项
centerItemsNarray导航栏中间的菜单项
rightItemsNarray导航栏右边的菜单项
  • leftItems、centerItems、rightItems数组参数元素说明
参数名是否必填类型长度默认值说明
titleNstring按钮文字
titleColorNstring文字颜色(默认为tintColor颜色)
iconNstring按钮图片
iconColorNstring按钮颜色(默认为tintColor颜色)
fontSizeNnumber1字体大小类型(0:小 1:中 2:大)
titlePositionNnumber0文字位置(0:文字在icon右边 1:文字在icon左边 2:文字在icon下边 3:文字在icon上边)
callbackNstring菜单项回调(需提前注册)
  • 参数示例
     parameters :  {
     'backgroundColor': '#aaaaaa',
     'tintColor': '#ffffff',
     'progressBarColor': '#abcdef'
    }
  • 返回值:无

40.支付回调

  • 函数名称:"payResult"
  • 类别:client
  • 请求参数:
参数名是否必填类型长度默认值说明
idNstring红包id
statusNnumber0红包支付状态0失败1成功
  • 参数示例
     parameters :  {
     'id': '2112', 'status': '0'
     }
  • 返回值:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据

41.获取计步服务状态

  • 函数名称:"getStepServiceStatus"
  • 类别:client
  • 请求参数:无
  • 响应data:
参数名是否必填类型长度默认值说明
isStepServiceRunningYstring0:服务未开启,1:服务开启服务是否开启
  • 返回值:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据

42.开启或停止计步服务

  • 函数名称:"stopOrStartStepService"
  • 类别:client
  • 请求参数:无
  • 返回值:
参数名是否必须返回类型长度默认值说明
tip_levelNnumber0提示级别,-1:客户端的固定提示,0:在客户端不处理(兼容数据),1:弹框提示,2:自动关闭提示 ,3:客户端不提示
error_descriptionYstring错误提示信息
error_codeYnumber返回的错误编码 0:表示成功,4:参数错误。。。
errorYstring服务器端错误编码
old_apiYboll
dataYobject数据

43.文件下载

  • 函数名称:"fileBrowser"
  • 类别:client
  • 请求参数:
参数名是否必填类型长度默认值说明
unameNstring上传者名称
fidNstring文件id
filenameYstring文件名称
fileextYstring附 件类型(文件格式) 如上标示处理(-1:"未知格式"; 0:"doc,docx,wps,dps,wpt";1: "pot,potx,ppt,pptx,dpt,pps,ppsx";2: "xls,xlsx";3: "txt";4: "pdf";5: "rar,zip"; 6: "avi,rmvb,rm,asf,divx,mpg,mpeg,mpe,wmv,mp4,mkv,vob,flv";7: "jpg,jpeg,bmp,psd,gif,png,tiff";8: "mp3,wav")
file_down_urlYstring文件地址
filesizeYstring文件字节大小 如 11000
file_codeNstring文件的md5编码(依据该字段判断文件是否需要重新下载(如果没有该字段则根据filesize判断))
createdNstring时间戳 (到秒)1450831716 上传时间
show_detailNstring是否显示详细信息(0 不显示 1 显示(默认) )
  • 参数示例
     parameters :  {
     'filename': '测试图片',
     'fileext': '7',
     'extflag': '0',
     'file_down_url': 'http://desk.fd.zol-img.com.cn/t_s960x600c5/g5/M00/02/00/ChMkJ1bKxCSIRtwrAA2uHQvukJIAALHCALaz_UADa41063.jpg',
     'filesize': '10001'}


44.扫一扫

  • 函数名称:"scanQRCodeBasedConfigurable"
  • 类别:client
  • 请求参数:
参数名是否必填类型长度默认值说明
typeYnumber0:扫描一次 1:扫描多次
callbackYstringjs提供给原生回调方法
  • 参数示例
     parameters :  0:扫描一次 1:扫描多次

  • 返回值:无