您当前的位置:首页 > 电脑百科 > 程序开发 > 移动端 > 小程序

钉钉小程序api的TS类型声明文件

时间:2022-09-21 14:47:58  来源:  作者:JS前端开发

钉钉小程序官方文档:文档 - 钉钉开放平台

吐槽一下,当时文档很不友好(2019年年底前),还会出现打不开的情况,可能现在会好一些吧???

踩过很多坑,边调研边开发模式,技术栈uni-App+TS,以下主要是类型声明,直接拿来就用,其他小程序相通。

在typings目录下新增dd.d.ts文件:

declare namespace DDModule {
  export class DD {
    // 钉钉企业id
    corpId: string
    /**
     * 获取钉钉免登码
     *
     */
    getAuthCode(options: GetAuthCodeOptions): void;
    /**
     * 压缩图片
     *
     */
    compressImage(options: CompressImageOptions): void;
    /**
     * 保存在线、本地临时或者永久地址图片到手机相册。
     *
     */
    saveImage(options: SaveImageOptions): void;
    /**
     * 提示框
     *
     */
    alert(options: AlertOptions): void
    /**
     * 确认框
     *
     */
    confirm(options: ConfirmOptions): void
    /**
     * 调用钉钉扫码
     *
     */
    scan(options: scanOptions): void
    /**
     * 选人与部门
     *
     */
    complexChoose(options: ComplexOptions): void
    /**
     * 选取部门
     *
     */
    chooseDepartments(options: ChooseDepartmentsOptions): void
    /**
     * 选取手机通信录
     *
     */
    choosePhonebook(options: ChoosePhoneBookOptions): void
    /**
     * 获取全局唯一录音管理器
     *
     */
    getRecorderManager(): RecordManager
    /**
     * 获取全局背景音频管理
     *
     */
    getBackgroundAudioManager(): BackgroundAudioManager
    /**
     * 上传文件
     *
     */
    uploadFile(options: UploadOptions): void
    /**
    * 获取网络状态
    *
    */
    ge.NETworkType(option: GetNetworkOptions): void
    /**
   * 选取图片
   *
   */
    chooseImage(options: DDChooseImageOptions): void
    /**
    * 选取视频
    *
    */
    chooseVideo(options: DDChooseVideoOptions): void
    /**
    * 图片预览
    *
    */
    previewImage(options: DDPreviewImageOptions): void
    /**
    * 弱提示
    *
    */
    showToast(options: ShowToastOptions): void
    // 移除缓存
    removeStorage(param: { key: string | number }): void
  }
  interface ShowToastOptions {
    content?: string,
    type?: string
    duration?: number,
    success?(param?: any): void,
    fail?(e: any): void,
    complete?(): void,
  }
  interface GetAuthCodeOptions {
    success(param: { authCode: string }): void
    fail?(param: any): void
  }
  interface CompressImageOptions {
    /**
     * 要压缩的图片地址数组
     */
    filePaths: string[],
    /**
     * 压缩级别,支持 0 ~ 4 的整数 4为网络自适应,其他是越高越清晰
     */
    compressLevel?: 0 | 1 | 2 | 3 | 4,
    /**
     * 成功回调
     */
    success?(param?: FilePaths): void,
    /**
     * 失败回调
     */
    fail?(e: any): void,
    /**
     * 无论成功或者失败回调
     */
    complete?(): void,
  }
  interface FilePaths {
    filePaths?: string[]
  }
  interface SaveImageOptions {
    /**
     * 图片地址
     */
    url: string,
    /**
     * 成功回调
     */
    success?(param?: any): void,
    /**
     * 失败回调
     */
    fail?(e: any): void,
    /**
     * 无论成功或者失败回调
     */
    complete?(): void,
  }
  interface AlertOptions {
    /**
     * 标题
     */
    title?: string
    /**
     * 内容
     */
    content?: string
    /**
     * 按钮名字
     */
    buttonText?: string
    /**
     * 成功回调
     */
    success?(param?: any): void,
    /**
     * 失败回调
     */
    fail?(param?: any): void,
    /**
     * 无论成功或者失败回调
     */
    complete?(param?: any): void,
  }
  interface ConfirmOptions {
    /**
     * 标题
     */
    title: string
    /**
     * 内容
     */
    content: string
    /**
     * 确认按钮名字
     */
    confirmButtonText?: string
    /**
     * 取消按钮名字
     */
    cancelButtonText?: string
    /**
     * 成功回调 确认为true 取消为fail
     */
    success?(flag: boolean): void,
    /**
     * 失败回调
     */
    fail?(param?: any): void,
    /**
     * 无论成功或者失败回调
     */
    complete?(param?: any): void,
  }
  interface scanOptions {
    /**
     * qr 二维码 bar 条形码
     */
    type?: 'qr' | 'bar'
    /**
     * 成功回调
     */
    success?(param?: any): void,
    /**
     * 失败回调
     */
    fail?(param?: any): void,
    /**
     * 无论成功或者失败回调
     */
    complete?(param?: any): void,
  }
  interface ComplexOptions {
    /**
     * 标题
     */
    title?: string,
    /**
     * 是否多选
     */
    multiple?: boolean,
    /**
     * 超过限定人数返回提示
     */
    limitTips?: string,
    /**
     * 最大可选人数
     */
    maxUsers?: number,
    /**
     * 已选用户,值为userId列表
     */
    pickedUsers?: string[],
    /**
     * 已选部门
     */
    pickedDepartments?: string[]
    /**
     * 不可选用户,值为userId列表
     */
    disabledUsers?: string[],
    /**
     * 不可选部门
     */
    disabledDepartments?: string[],
    /**
     * 必选用户(不可取消选中状态),值为userId列表
     */
    requiredUsers?: string[],
    /**
     * 必选部门(不可取消选中状态
     */
    requiredDepartments?: string[],
    /**
     * 选人权限,目前只有GLOBAL这个参数)
     */
    permissionType?: 'GLOBAL',
    /**
     * true:返回人员信息
     * false:返回人员和部门信息
     */
    responseUserOnly?: boolean,
    /**
     * 仅支持0和-1两个值:0表示从企业最上层开始,-1表示从自己部门开始
     */
    startWithDepartmentId?: 0 | -1
    /**
     * 成功回调
     */
    success?(param: {
      selectedCount?: number,
      users?: any,
      departments?: any
    }): void
    /**
     * 失败回调
     */
    fail?(e: any): void
  }
  interface ChooseDepartmentsOptions {
    /**
     * 标题
     */
    title?: string,
    /**
     * 是否多选
     */
    multiple?: boolean,
    /**
     * 超过限定人数返回提示
     */
    limitTips?: string,
    /**
     * 最大可选部门
     */
    maxDepartments?: number,
    /**
     * 已选部门
     */
    pickedDepartments?: string[]
    /**
     * 不可选部门
     */
    disabledDepartments?: string[],
    /**
     * 必选部门(不可取消选中状态
     */
    requiredDepartments?: string[],
    /**
     * 选人权限,目前只有GLOBAL这个参数)
     */
    permissionType?: 'GLOBAL',
    /**
     * 成功回调
     */
    success?(param: {
      selectedCount?: number,
      users?: any,
      departments?: any
    }): void
    /**
     * 失败回调
     */
    fail?(e: any): void
  }
  interface ChoosePhoneBookOptions {
    /**
     * 是否多选
     */
    multiple?: boolean
    /**
     * 人数限制,当multiple为true才生效,可选范围1-1500
     */
    maxUsers?: number
    /**
     * 超过人数限制的提示语可以用这个字段自定义
     */
    limitTips?: string
    /**
     * 如果你需要修改选人页面的title,可以在这里赋值
     */
    title?: string
    /**
     * 成功回调
     */
    success?(param: {
      name?: string,
      avatar?: any,
      mobile?: any
    }): void
    /**
     * 失败回调
     */
    fail?(e: any): void
  }
  interface RecordManager {
    start(param?: { duration?: number }): void,    // 开始
    stop(): void,    // 结束
    onstart(): void,    // 监听开始
    onstop(res: { tempFilePath: string }): void,    // 监听结束
    onerror(res: { errorCode?: 20001 | 13 | 2 | 5, errorMessage?: string }): void,    // 监听报错 错误码 20001 正在录音,13 保存失败,2参数错误,5没有读写权限
  }
  interface BackgroundAudioManager {
    src?: string,// 音频地址
    title?: string, // 音频标题
    coverImgUrl?: string, // 音频封面
    paused?: boolean, // 是否暂停
    duration?: number, // 音频长度
    currentTime?: number, // 音频当前播放的时间
    play(): void // 播放
    pause(): void // 暂停
    stop(): void // 停止
    seek(position: number): void // 跳转指定位置,以秒为单位
    onPlay(): void, // 监听开始
    onPause(): void, // 监听暂停
    onStop(): void, // 监听停止
    onEnded(): void, // 监听结束
    onTimeUpdate(): void, // 监听时间变化
    onError(): void, // 监听报错
  }
}
interface UploadOptions {
  url: string // 上传的路径
  filePath: string // 本地文件的虚拟地址
  fileName: string // 对应的key
  fileType: 'image' | 'audio' | 'video'
  header?: Object
  formData?: Object
  success?(param: any): void
  fail?(e: any): void
  complete?(): void,
}
interface GetNetworkOptions {
  success?(param: {
    networkAvailable?: boolean,
    networkType?: 'UNKNOWN' | 'NOTREACHABLE' | 'wifi' | '3G' | '2G' | '4G' | 'WWAN',
  }): void
  fail?(e: any): void,
  complete?(e: any): void,
}
interface DDChooseVideoOptions {
  sourceType?: string[], // 视频来源  可选值 album camera
  maxDuration?: number, // 视频长度
  covered?: boolean,
  success?(param: {
    filePath: string,
    duration?: number,
    size?: number,
    height?: number,
    width?: number,
    coverPath?: string,
  }): void
  fail?(e: any): void
  complete?(): void,
}
interface DDChooseImageOptions {
  count?: number // 最大可选数量
  sourceType?: string[] // 图片来源  可选值 album camera
  success?(param: {
    filePaths: string[], // 所选图片本地占位符数组
  }): void
  fail?(e: any): void
  complete?(): void,
}
interface DDPreviewImageOptions {
  urls: string[],
  current?: number,
  success?(e: any): void,
  fail?(e: any): void,
  complete?(): void,
}

然后在index.d.ts文件,其他.d.ts类型文件亦可

declare const dd: DDModule.DD


Tags:小程序   点击:()  评论:()
声明:本站部分内容及图片来自互联网,转载是出于传递更多信息之目的,内容观点仅代表作者本人,如有任何标注错误或版权侵犯请与我们联系(Email:2595517585@qq.com),我们将及时更正、删除,谢谢。
▌相关推荐
钉钉小程序官方文档:文档 - 钉钉开放平台吐槽一下,当时文档很不友好(2019年年底前),还会出现打不开的情况,可能现在会好一些吧???踩过很多坑,边调研边开发模式,技术栈uni-app+TS,以下主...【详细内容】
2022-09-21  Tags: 小程序  点击:(0)  评论:(0)  加入收藏
前置申请支付宝相关准备内容:小程序 - 微信支付接入指引 - 微信支付商户平台先看文档小程序登录流程:小程序登录 | 微信开放文档登录流程图 这个说明一定要好好看清楚!!! 说明 ...【详细内容】
2022-09-19  Tags: 小程序  点击:(13)  评论:(0)  加入收藏
原标题:“北京警务”微信小程序启用 无犯罪记录证明全流程网上办为了给市民提供更方便快捷的“互联网+公安政务服务”,全新版本的“北京警务”微信小程序正式启用,9项公安业务...【详细内容】
2022-08-30  Tags: 小程序  点击:(28)  评论:(0)  加入收藏
随着科技时代的不断进步,不知不觉之间,我们的生活、工作好像都离不开网络的支持,从最初的各种论坛、阿里巴巴等网页端,在移动设备的迅速发展中慢慢向着手机APP转移,不管是网上商...【详细内容】
2022-08-28  Tags: 小程序  点击:(34)  评论:(0)  加入收藏
1、小程序简介Mall4j 项目致力于为中小企业打造一个完整、易于维护的开源的电商系统,采用现阶段流行技术实现。后台管理系统包含商品管理、订单管理、运费模板、规格管理、会...【详细内容】
2022-08-25  Tags: 小程序  点击:(40)  评论:(0)  加入收藏
微信上隐藏着很多实用的小程序,今天我就给大家分享5个,让人爱不释手的微信小程序,每一款都是精品中的精品! 01*玩乐工具箱亮点:多种有趣的工具。 这个小程序里面聚合了超多工具,你...【详细内容】
2022-08-20  Tags: 小程序  点击:(32)  评论:(0)  加入收藏
出品 | 搜狐科技编辑 | 尹莉娜8月19日,饿了么和抖音共同宣布达成合作。饿了么将基于抖音开放平台,以小程序为载体,共同探索“即看即点即达”新服务模式。。饿了么平台上拥有数...【详细内容】
2022-08-19  Tags: 小程序  点击:(24)  评论:(0)  加入收藏
自微信小程序上线以来,越来越多的商家看到了微信带来的机会,纷纷上架。大家的目的很明确:要在前期抢占微信小程序的流量红利!排名越高,位置越好,接触用户的机会越大。企业要想向更...【详细内容】
2022-08-19  Tags: 小程序  点击:(39)  评论:(0)  加入收藏
小程序制作似乎是程序员的范围,这似乎与我们的新手程序不密切相关。但事实上,在程序员的帮助下,我们也可以自己制作小程序。这里将教你如何0基础自己如何制作小程序?一开始,不要...【详细内容】
2022-08-18  Tags: 小程序  点击:(25)  评论:(0)  加入收藏
一、摘要 随着携程接入小程序平台类型的增加,前端需要负责的端越来越多,研发成本也随之成倍增加。为了解决一套代码多端运行的诉求,携程小程序框架不断调整、升级,逐渐形成了携...【详细内容】
2022-08-17  Tags: 小程序  点击:(42)  评论:(0)  加入收藏
▌简易百科推荐
钉钉小程序官方文档:文档 - 钉钉开放平台吐槽一下,当时文档很不友好(2019年年底前),还会出现打不开的情况,可能现在会好一些吧???踩过很多坑,边调研边开发模式,技术栈uni-app+TS,以下主...【详细内容】
2022-09-21  JS前端开发    Tags:小程序   点击:(0)  评论:(0)  加入收藏
前置申请支付宝相关准备内容:小程序 - 微信支付接入指引 - 微信支付商户平台先看文档小程序登录流程:小程序登录 | 微信开放文档登录流程图 这个说明一定要好好看清楚!!! 说明 ...【详细内容】
2022-09-19  JS前端开发  今日头条  Tags:微信小程序   点击:(13)  评论:(0)  加入收藏
随着科技时代的不断进步,不知不觉之间,我们的生活、工作好像都离不开网络的支持,从最初的各种论坛、阿里巴巴等网页端,在移动设备的迅速发展中慢慢向着手机APP转移,不管是网上商...【详细内容】
2022-08-28  童言软件开发    Tags:小程序   点击:(34)  评论:(0)  加入收藏
1、小程序简介Mall4j 项目致力于为中小企业打造一个完整、易于维护的开源的电商系统,采用现阶段流行技术实现。后台管理系统包含商品管理、订单管理、运费模板、规格管理、会...【详细内容】
2022-08-25  优迈源码分享    Tags:电商小程序   点击:(40)  评论:(0)  加入收藏
小程序制作似乎是程序员的范围,这似乎与我们的新手程序不密切相关。但事实上,在程序员的帮助下,我们也可以自己制作小程序。这里将教你如何0基础自己如何制作小程序?一开始,不要...【详细内容】
2022-08-18  小帆建网站小程序制作     Tags:小程序   点击:(25)  评论:(0)  加入收藏
一、摘要 随着携程接入小程序平台类型的增加,前端需要负责的端越来越多,研发成本也随之成倍增加。为了解决一套代码多端运行的诉求,携程小程序框架不断调整、升级,逐渐形成了携...【详细内容】
2022-08-17  携程技术    Tags:Taro   点击:(42)  评论:(0)  加入收藏
根据官方数据,微信小程序的数量和使用总数不断增加,在交通天花板环境中,用户增长和使用改进是一个重要的机会,许多线下个人商店也看到了这一趋势,抓住机会,制作微信小程序。那么,我...【详细内容】
2022-08-17  小帆建网站小程序制作    Tags:小程序   点击:(29)  评论:(0)  加入收藏
由于小程序的分享(微信、头条平台),需要监听页面的onShareAppMessage生命周期,小程序需要在页面声明了此生命周期,点击右上角的"胶囊"才会有分享功能,而一般情况下,我们希望每个...【详细内容】
2022-08-04  zw源    Tags:微信小程序   点击:(57)  评论:(0)  加入收藏
一、接口介绍据文章类别、关键词等筛选条件,查询微信精选或最新发布的文章、阅读点数、评论、正文、以及微信权威、高流量的公众号等数据,支持分页查询。二、接入点功能 微信...【详细内容】
2022-08-03  万维易源    Tags:API接口   点击:(101)  评论:(0)  加入收藏
第一步,在utils文件夹里新建一个filter.wxs文件 var replaceStar = function (index) { var a switch (index) { case '1': a = '出生时' break; case '...【详细内容】
2022-07-28  马克-1949    Tags:filter   点击:(67)  评论:(0)  加入收藏
站内最新
站内热门
站内头条