Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

blob?: File

JS 的 File 对象。

注:若有可能,更推荐开发者使用这个传参,携带文件的名字后缀等信息,

注2: fileInput、file、filePath、blob 只需要填一个

commonUpload?: boolean

是否使用普通上传。

注:默认 false 是使用分片上传的。普通上传限制是 100MB 文件,当宿主环境不支持 File 无法做文件切片时会自动退化为普通上传。

fileInput?: string | HTMLInputElement

Input[type=file] 的 DOM 节点或者节点 ID。

注:浏览器专属,SDK 会读取该节点下的第一个被选择文件, 在上传完成前请不要操作该节点下的文件

注2: fileInput、file、filePath、blob 只需要填一个

filePath?: string

临时文件的路径

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

注2: fileInput、file、filePath、blob 只需要填一个

maxSize?: number

限制文件的大小,单位字节.

注:小程序,rn 等环境,由于只有 filePath 而没有 file 具体信息,无法使用这个字段做判断,只能让开发者自行在选择文件是判定。

nosScene?: string

常见说明

  • 常用场景为根据资源类型设置存储场景,然后设置定时任务调用 清理文件 删除。
  • IM 默认的存储场景为: 'im'
  • Chatroom 默认的存储场景为: 'chatroom'

存储场景优先级

  • sendFile 或者 previewFile 时的 nosScene 参数
  • 初始化参数的 nosScene 参数
  • 默认参数: 'im' 或者 'chatroom'

私有化安全链接

  • 私有化生成安全链接,请设置 nosScene: '_nim_security'
  • 接收方使用 getNosAccessToken 获取带有鉴权信息的链接
  • 使用 deleteNosAccessToken 设置鉴权信息无效
nosSurvivalTime?: number

上传的文件在网易云存储服务(NetEase Object Storage, NOS)上的存储有效期。

notice

默认为 Infinity(永久)。设置的时间不得小于一天,单位:秒。

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

文件类型,image 图片,video 视频,audio 音频,file 其他文件。