uploadImage.d.ts 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. /**
  2. * 上传图片 请求参数定义
  3. * @apiName biz.util.uploadImage
  4. */
  5. export interface IBizUtilUploadImageParams {
  6. /** 默认 jsapi (>= 5.0.0) */
  7. bizType?: string;
  8. /**
  9. * (>= 5.0.0)
  10. * 1,STRICT_AUTH, 严格鉴权,下载文件时需要回调业务方进行鉴权,默认值 。
  11. * 4,TEMP_AUTH, 临时文件,过期后删除文件,无法访问。
  12. * 6,CDN_ONLY,公开文件,上传后只可以通过https下载
  13. */
  14. authType?: number;
  15. /** 是否多选,默认false */
  16. multiple?: boolean;
  17. /** 最多可选个数 */
  18. max?: number;
  19. /** 是否压缩 */
  20. compression?: boolean;
  21. /** Number为正整数,取值 0~100, 表示图片压缩质量,数值越小压缩越严重 */
  22. quality?: number;
  23. /** Number为正整数,取值 0~100, 表示图片压缩质量,数值越小缩放越多 */
  24. resize?: number;
  25. /** 水印信息,钉钉v2.11.0之后版本支持 */
  26. stickers?: {
  27. time?: string;
  28. dateWeather?: string;
  29. username?: string;
  30. address?: string;
  31. };
  32. }
  33. /**
  34. * 上传图片 返回结果定义
  35. * @apiName biz.util.uploadImage
  36. * @returnDemo ['https://static.dingtalk.com/media/lADOA9bQH8zIzMg_200_200.jpg']
  37. */
  38. export declare type IBizUtilUploadImageResult = string[];
  39. /**
  40. * 上传图片
  41. * 选择图片+上传,防止恶意上传。注意:在工作tab页自定义主页不能使用该组件,工作tab页一级页面会阻塞该组件的执行。
  42. * 将在成功上传之后回调onSuccess方法,返回alicdn上的图片链接。微应用也可以调用<input type="file" accept="image/*">来自定义上传图片,此标签钉钉客户端版本2.5及以上支持。
  43. * @apiName biz.util.uploadImage
  44. * @supportVersion pc: 2.5.0 ios: 2.4.0 android: 2.4.0
  45. * @author android:卓剑, ios:须莫
  46. */
  47. export declare function uploadImage$(params: IBizUtilUploadImageParams): Promise<IBizUtilUploadImageResult>;
  48. export default uploadImage$;