Options
All
  • Public
  • Public/Protected
  • All
Menu

当发送消息为 image/video/audio/file 时,这些字段才能生效

Hierarchy

  • UploadFileOptions

Index

Properties

file?: File

JS 的 File 对象。

浏览器专用

fileInput?: string | HTMLInputElement
deprecated

Use UploadFileOptions.file instead.

即将弃用!!存储文件的 DOM 元素,与上面的 file 只要选填一个就可以了。

浏览器专用。

如果传字符串,最后会以 document.getElementById('fileInput').files[0] 拿到 File 对象 如果传的是 DOM 节点,最后以 fileInput.files[0] 拿到 File 对象

filePath?: string

临时文件路径

uni-app,RN,小程序等特殊的 JS 运行环境专用(chooseImage 拿到的临时路径)

maxSize?: number

maxSize 限制文件大小。

对浏览器生效(v10.0.0+)

而在 uni-app、小程序等 filePath 上传场景中,调用 stat 方法检测生效 (v10.9.90+)。

若宿主环境不支持文件大小探查,则仍建议开发者在选择文件后自行判断,参考 wx.chooseImage、uni.chooseImage 等端能力。

md5?: string

上传文件 md5 值。NOS 厂商根据该值判断文件完整性

nosScenes?: string

存储场景,不传默认实例化配置,默认为"im"

nosSurvivalTime?: number

存储有效时间,不传则默认实例化配置

不得小于一天,单位秒

type?: "image" | "audio" | "video" | "file"

文件类型

Methods

  • onUploadStart(task: { abort: any }): void
  • 上传前回调事件。返回一个 task 对象,可以调用 task.abort() 取消上传

    Parameters

    • task: { abort: any }
      • [key: string]: any
      • abort:function
        • abort(): void
        • Returns void

    Returns void