文档中心 > 移动端开发文档

dd.biz

打开应用

钉钉客户端版本4.5.5以上,JSSDK2.0.63以上支持

dd.biz.microApp.openApp({
    agentId: '123',
    appId: '234',
    corpId: 'dingxxxxxxxxx',
    onSuccess : function(result) {},
    onFail : function(err) {}
})

参数说明

参数 参数类型 说明
agentId String 要打开应用的agentId
appId String 要打开应用的appId
corpId String 要打开的应用所属的corpId

提示:

开发者有两种方式来打开应用:

  1. 通过agentId打开应用
  2. 通过appId和corpId打开应用

如果提供了正确的agentId,系统将直接根据agentId打开应用,不会再使用appId和corpId参数;如果agentId无法打开应用,系统将根据appId和corpId来打开应用;否则返回错误。

打开应用内页面

dd.biz.util.open({
    name:String,//页面名称
    params:JSONObject,//传参
    onSuccess : function() {
        /**/
    },
    onFail : function(err) {}
});
参数 参数类型 说明
name String 页面名称
params JSONObject 传参

目前支持以下页面,具体参数看右边

a.个人资料页

// 页面名称:
    profile
// 传参:
    id : 用户UserId
    corpId: '' //企业id

b.聊天页面

// 页面名称:
    chat
// 传参:
    users: ['123'] 用户列表,工号
    corpId: '' //企业id

c.免费电话页面

// 页面名称:
    call
// 传参:

d.联系人添加页面

// 页面名称:
    contactAdd
// 传参:

f.唤起添加好友页面

// 页面名称:
    friendAdd
// 传参:

g.唤起员工管理页面

// 页面名称:
    manageOrg
// 传参:
"corpId":"dingd90ce2ec337f2f13", "isManager": "true"

分享

dd.biz.util.share({
    type: Number,//分享类型,0:全部组件 默认; 1:只能分享到钉钉;2:不能分享,只有刷新按钮
    url: String,
    title: String,
    content: String,
    image: String,
    onSuccess : function() {
        //onSuccess将在调起分享组件成功之后回调
        /**/
    },
    onFail : function(err) {}
})
图片名称

参数说明

参数 参数类型 说明
type Number 分享类型,0:全部组件默认; 1:只能分享到钉钉;2:不能分享,只有刷新按钮
url String url地址
title String 分享标题
content String 分享内容
image String 分享图片的URL地址

上传图片

选择图片+上传,防止恶意上传。注意:在工作tab页自定义主页不能使用该组件,工作tab页一级页面会阻塞该组件的执行。

将在成功上传之后回调onSuccess方法,返回alicdn上的图片链接。微应用也可以调用<input type="file" accept="image/*">来自定义上传图片,此标签钉钉客户端版本2.5及以上支持。

dd.biz.util.uploadImage({
    compression:true,//(是否压缩,默认为true压缩)
    multiple: false, //是否多选,默认false
    max: 3, //最多可选个数
    quality: 50, // 图片压缩质量, 
    resize: 50, // 图片缩放率
    stickers: {   // 水印信息
        time: "08:35",
        dateWeather: "2016.05.06 周六·晴转多云 16℃",
        username: "王晓",
        address: "西湖·杭州"
    },
    onSuccess : function(result) {
        //onSuccess将在图片上传成功之后调用
        /*
        [
          'http://gtms03.alicdn.com/tps/i3/TB1VF6uGFXXXXalaXXXmh5R_VXX-237-236.png'
        ]
        */
    },
    onFail : function(err) {}
})
图片名称

参数说明

参数 参数类型 说明
compression Boolean 是否压缩, true为压缩,false为不压缩
multiple Boolean 是否多选,默认false
max Number Number为正整数,最多可选个数
quality Number Number为正整数,取值 0~100, 表示图片压缩质量,数值越小压缩越严重
resize Number Number为正整数,取值 0~100, 表示图片压缩质量,数值越小缩放越多
stickers Object 水印信息,仅当multiple参数为false的时候有效,钉钉v2.11.0之后版本支持

水印信息参数

参数 参数类型 说明
time String 时间栏显示的内容
dateWeather String 天气栏显示的内容
username String 用户栏显示的内容
address String 定位栏显示的内容

上传图片(仅支持拍照上传)

只支持直接拍照上传,即调用这个API之后将直接调起相机界面

比如可以应用在,需要用户上传即时照片的场景。成功上传之后回调onSuccess方法,返回图片链接

dd.biz.util.uploadImageFromCamera({
    compression: true,//(是否压缩,默认为true压缩)
    quality: 50, // 图片压缩质量, 
    resize: 50, // 图片缩放率
    stickers: {   // 水印信息
        time: "08:35",
        dateWeather: "2016.05.06 周六·晴转多云 16℃",
        username: "王晓",
        address: "西湖·杭州"
    },
    onSuccess : function(result) {
         //onSuccess将在图片上传成功之后调用
        /*
        [
          'http://gtms03.alicdn.com/tps/i3/TB1VF6uGFXXXXalaXXXmh5R_VXX-237-236.png'
        ]
        */
    },
    onFail : function(err) {}
});

参数说明

参数 参数类型 说明
compression BOOL 是否压缩,true压缩,false不压缩
quality Number Number为正整数,取值 0~100, 表示图片压缩质量,数值越小压缩越严重
resize Number Number为正整数,取值 0~100, 表示图片压缩质量,数值越小缩放越多
stickers Object 水印信息,钉钉v2.11.0之后版本支持

图片浏览器

调用此api,将显示一个图片浏览器

dd.biz.util.previewImage({
    urls: [String],//图片地址列表
    current: String,//当前显示的图片链接
    onSuccess : function(result) {
        /**/
    },
    onFail : function(err) {}
})
图片名称

参数说明

参数 参数类型 说明
urls Array[String] 图片地址列表
current String 当前显示的图片链接

日期选择器

注意:format只支持android系统规范,即2015-03-31格式为yyyy-MM-dd

dd.biz.util.datepicker({
    format: 'yyyy-MM-dd',
    value: '2015-04-17', //默认显示日期
    onSuccess : function(result) {
        //onSuccess将在点击完成之后回调
        /*{
            value: "2015-02-10"
        }
        */
    },
    onFail : function(err) {}
})
图片名称

参数说明

参数 参数类型 说明
format String format只支持android系统规范,即2015-03-31格式为yyyy-MM-dd
value String 默认显示日期

返回说明

参数 说明
value 返回选择的日期

时间选择器

dd.biz.util.timepicker({
    format: 'HH:mm',
    value: '14:00', //默认显示时间  0.0.3
    onSuccess : function(result) {
        //onSuccess将在点击完成之后回调
        /*{
            value: "10:00"
        }
        */
    },
    onFail : function(err) {}
})

参数说明

参数 参数类型 说明
format String 时间格式
value String 默认显示时间

返回说明

参数 说明
value 返回选择的时间

日期+时间选择器

0.0.4

dd.biz.util.datetimepicker({
    format: 'yyyy-MM-dd HH:mm',
    value: '2015-04-17 08:00', //默认显示
    onSuccess : function(result) {
        //onSuccess将在点击完成之后回调
        /*{
            value: "2015-06-10 09:50"
        }
        */
    },
    onFail : function(err) {}
})

参数说明

参数 参数类型 说明
format String 日期和时间的格式
value String 默认显示的日期和时间

返回说明

参数 说明
value 返回选择的日期和时间

下拉控件

0.0.5

dd.biz.util.chosen({
    source:[{
        key: '选项1', //显示文本
        value: '123' //值,
    },{
        key: '选项2',
        value: '234'
    }],
   selectedKey:'选项2' , // 默认选中的key
   onSuccess : function(result) {
    //onSuccess将在点击完成之后回调
        /*
        {
            key: '选项2',
            value: '234'
        }
        */
    },
   onFail : function(err) {}
})
图片名称

参数说明

参数 参数类型 说明
source Array[String] 下拉控件的内容
key String 显示文本
value String 文本对应的值
selectedKey String 默认选中的key值

返回说明

参数 说明
key 返回选择的文本
value 返回选择的值

在新窗口上打开链接

dd.biz.util.openLink({
    url: "http://www.dingtalk.com",//要打开链接的地址
    onSuccess : function(result) {
        /**/
    },
    onFail : function(err) {}
})
参数 参数类型 说明
url String 要打开链接的地址

复制到粘贴版

dd.biz.clipboardData.setData({
    text: "要复制粘贴板的内容", //要复制粘贴板的内容   
    onSuccess : function(result) {
        /**/
    },
    onFail : function() {}
})
参数 参数类型 说明
text String 要复制粘贴板的内容

月历组件,选择某天

依赖钉钉客户端3.5.0以上版本

dd.biz.calendar.chooseOneDay({
    default:1494415396228
    onSuccess : function(result) {
        //onSuccess将在点击确定之后回调
        /*{
            chosen:1494345600000,
            timezone:8
        }
        */
    },
    onFail : function(err) {}
})

参数说明

参数 参数类型 说明
default Long 时间戳,默认选中时间,单位为毫秒ms

返回说明

参数 说明
chosen 时间戳,用户选择日期当日0点的时间(在用户时区),单位为毫秒ms
timezone 整型,用户当前所在时区

月历组件,选择某时间

选择的时间精确到分钟
依赖钉钉客户端3.5.0以上版本

dd.biz.calendar.chooseDateTime({
    default:1494415396228
    onSuccess : function(result) {
        //onSuccess将在点击确定之后回调
        /*{
            chosen:1494345600000,
            timezone:8
        }
        */
    },
    onFail : function(err) {}
})

参数说明

参数 参数类型 说明
default Long 时间戳,默认选中时间,单位为毫秒ms

返回说明

参数 说明
chosen 时间戳,用户选择的时间,单位为毫秒ms
timezone 整型,用户当前所在时区

月历组件,选择半天

依赖钉钉客户端3.5.0以上版本

dd.biz.calendar.chooseHalfDay({
    default:1494415396228
    onSuccess : function(result) {
        //onSuccess将在点击确定之后回调
        /*{
            chosen:1494345600000,
            timezone:8
        }
        */
    },
    onFail : function(err) {}
})

参数说明

参数 参数类型 说明
default Long 时间戳,默认选中时间,单位为毫秒ms

返回说明

参数 说明
chosen 时间戳,如果用户选择上午,则为当日0点的时间;如果是下午,则为当日12点的时间;单位为毫秒ms
timezone 整型,用户当前所在时区

月历组件,选择日期区间

依赖钉钉客户端3.5.0以上版本

dd.biz.calendar.chooseInterval({
    defaultStart:1494415396228,
    defaultEnd:1494415396228
    onSuccess : function(result) {
        //onSuccess将在点击确定之后回调
        /*{
            start: 1514908800000,
            end: 1514995200000,
            timezone:8
        }
        */
    },
    onFail : function(err) {}
})

参数说明

参数 参数类型 说明
defaultStart Long 时间戳,默认开始时间,单位为毫秒ms
defaultEnd Long 时间戳,默认结束时间,单位为毫秒ms

返回说明

参数 说明
start 时间戳,为起始当日0点的时间,单位为毫秒ms
end 时间戳,为截止当日0点的时间,单位为毫秒ms
timezone 整型,用户当前所在时区

FAQ

关于此文档暂时还没有FAQ
返回
顶部