preview.d.ts 1.1 KB

1234567891011121314151617181920212223242526272829303132333435
  1. /**
  2. * 附件预览 请求参数定义
  3. * @apiName biz.cspace.preview
  4. */
  5. export interface IBizCspacePreviewParams {
  6. /** 用户当前的corpid,此文件预览成功后只能转发或保存到此corpId对应的企业群和个人 */
  7. corpId: string;
  8. /** 空间ID */
  9. spaceId: string;
  10. /** 文件ID */
  11. fileId: string;
  12. /** 文件名称 */
  13. fileName: string;
  14. /** 文件大小,字节数 */
  15. fileSize: number;
  16. /** 文件扩展名 */
  17. fileType: string;
  18. /** 预览时候可以控制是否显示 下载、转发等等按钮, 暂支持移动端 */
  19. mode?: 'safe' | 'normal' | 'edit' | 'revise' | 'restrict';
  20. /** 表示预览文件的某个版本,4.3.5开始支持,支持移动端 */
  21. version?: string;
  22. }
  23. /**
  24. * 附件预览 返回结果定义
  25. * @apiName biz.cspace.preview
  26. */
  27. export interface IBizCspacePreviewResult {
  28. }
  29. /**
  30. * 附件预览
  31. * @apiName biz.cspace.preview
  32. * @supportVersion pc: 3.0.0 ios: 2.7.0 android: 2.7.0
  33. */
  34. export declare function preview$(params: IBizCspacePreviewParams): Promise<IBizCspacePreviewResult>;
  35. export default preview$;