ding

来自于:官方立即使用

概述

钉钉简介

钉钉(DingTalk)是阿里巴巴集团专为中国企业打造的免费沟通和协同的多端平台,帮助企业通过系统化的解决方案(微应用),全方位提升企业沟通和协同效率。

dingding 模块概述

本模块封装了钉钉的分享功能

android签名 下载签名工具并安装,打开然后输入应用的包名,即可生成该应用的签名

模块使用攻略

使用之前须从钉钉开放平台申请开发者账号并创建应用,获取 appid

钉钉平台接入流程参考钉钉平台接入文档

配置 config.xml 文件:

针对 ios 平台配置方法:

  • 配置示例:

<feature name="dingding">
    <param name="appID" value="bf1acab2de4925b9cd624819" />
     <param name="urlScheme" value="dingoak5hqhuvmpfhpnjvt" />
</feature>

注意:

1, iOS 平台上必须添加白名单,如下:

  <preference name="querySchemes" value="dingtalk,dingtalk-open" />

详情参考 APICloud 官方文档之-----白名单配置

模块接口

isInstalled

判断当前设备是否安装钉钉客户端

isInstalled(callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    installed: true      //布尔型;true||false,当前设备是否安装钉钉客户端
}

示例代码

var dingding = api.require('dingding');
dingding.isInstalled(function(ret) {
    if (ret.installed) {
        alert("当前设备已安装钉钉客户端");
    } else {
        alert('当前设备未安装钉钉客户端');
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

isSupportShare(仅支持安卓)

判断是否支持分享

isSupportShare(callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    isSupport: true      //布尔型;true||false,是否支持分享
}

示例代码

var dingding = api.require('dingding');
dingding.isSupportShare(function(ret) {
    if (ret.isSupport) {
        alert("支持钉钉分享");
    } else {
        alert('不支持钉钉分享');
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

shareText

分享文本内容

shareText({params}, callback(ret, err))

params

appId:

  • 类型:字符串
  • 描述:(必选项)从钉钉开放平台获取的 appid。
  • ios不支持

text:

  • 类型:字符串
  • 描述:分享的文本

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
                //错误码:
                //-1(未知错误)
                //0(成功)
                //-2(用户取消)
                //-3(发送失败)
}

示例代码

var dingding = api.require('dingding');
dingding.shareText({
    appId: '',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.status) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

shareImage

分享图片内容

shareImage({params}, callback(ret, err))

params

appId:

  • 类型:字符串
  • 描述:(必选项)从钉钉开放平台获取的 appid。
  • ios不支持

contentUrl:

  • 类型:字符串
  • 描述:分享图片的 url 地址(支持 fs://、widget:// 和网络路径)(android不支持widget)

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
                //错误码:
                //-1(未知错误)
                //0(成功)
                //-2(用户取消)
                //-3(发送失败)
}

示例代码

var dingding = api.require('dingding');
dingding.shareImage({
    appId: '',
    contentUrl: 'fs://b.jpg'
}, function(ret, err) {
    if (ret.status) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

shareWebpage

分享网页

shareWebpage({params}, callback(ret, err))

params

appId:

  • 类型:字符串
  • 描述:(必选项)从钉钉开放平台获取的 appid。
  • ios不支持

title:

  • 类型:字符串
  • 描述:(可选项)分享网页的标题

description:

  • 类型:字符串
  • 描述:(可选项)分享网页的描述。

thumurl:

  • 类型:字符串
  • 描述:(可选项)分享网页的缩略图地址,要求本地路径(fs://、widget://和网络路径)(android不支持widget)

url:

  • 类型:字符串
  • 描述:分享网页的 url 地址。

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
                //错误码:
                //-1(未知错误)
                //0(成功)
                //-2(用户取消)
                //-3(发送失败)
}

示例代码

var dingding = api.require('dingding');
dingding.shareWebpage({
    appId: '',
    title: '测试标题',
    description: '分享内容的描述',
    thumurl: 'fs://a.jpg',
    url: 'http://apicloud.com'
}, function(ret, err) {
    if (ret.status) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本