Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IUploadFileOptions

Hierarchy

Index

Properties

file?: File

JS 的 File 对象。该属性和 fileInput, filePath仅需要填一个即可

该属性仅在使用 NIM_BROWSER_SDK.js 时可以使用

fileInput?: string | HTMLInputElement
deprecated

请使用 IBaseUploadFileOptions.file 属性

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

  • 该属性仅在使用 NIM_BROWSER_SDK.js 时可以使用
  • 如果传字符串,最后会以 document.getElementById('fileInput').files[0] 拿到 File 对象
  • 如果传的是 DOM 节点,最后以 fileInput.files[0] 拿到 File 对象
filePath?: string

临时文件路径

  • uni-app,小程序等特殊的 JS 运行环境专用(chooseImage 拿到的临时路径)
  • 仅当使用 NIM_UNIAPP_SDK.js, NIM_MINIAPP_SDK.js 时可以使用
example
// 微信小程序选择音频,并发送音频文件消息
wx.chooseMedia({
count: 1,
mediaType: ['vedio'],
success: (res) => {
let r = this.nim.msg.sendAudioMsg({
"scene": "p2p",
"to": "cs5",
"filePath": res.tempFiles[0].tempFilePath
})
r.then((res) => {
// 输出结果
console.log('sendAudioMsg 完成:', res)
}).catch((e) => {
console.error('sendAudioMsg 出错:', e)
})
}
})
maxSize?: number

maxSize 限制文件大小。

只对浏览器生效。

uni-app,小程序等,由于sdk只能得到一个 filePath 临时路径,不能得到整个文件的信息。 所以请开发者自行在选择文件后进行判断,参考那些端的API如 wx.chooseImage,uni.chooseImage

nosScenes?: string

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

常见说明

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

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

不得小于一天,单位秒

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

文件类型

Methods