Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IBaseSendFileOptions

Hierarchy

Index

Properties

如果之前已经上传好了文件,那么直接传入 body 字段 接下来不会再上传它,而是直接发往 IM 服务器

clientAntiSpam?: boolean

是否过客户端反垃圾

env?: string

环境变量,用于指向不同的抄送、第三方回调等配置

ext?: string

扩展字段

file?: File

JS 的 File 对象。

浏览器专用

fileInput?: string | HTMLInputElement
deprecated

Use IBaseUploadFileOptions.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 限制文件大小。

只对浏览器生效。

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

nosScenes?: string

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

nosSurvivalTime?: number

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

不得小于一天,单位秒

notifyTargetTags?: string

本条消息的目标标签,符合该标签条件的成员才会收到消息通知;若缺失,则使用发送者登录时设置的notifyTargetTags,若仍缺失,则消息会发送给聊天室内的所有人

subType?: string

消息子类型,格式为大于0的整数,开发者可自定义

yidunAntiCheating?: string

易盾反作弊字段,长度限制1024,JSON字符串格式。如:"{"email":"test@163.com","phone":"12345678901","token":"1234","extension":"hello"}"

yidunAntiSpamExt?: string

易盾反作弊扩展字段字段,2021-08-09 追加。限制 JSON 格式字符串,长度上限 1024

Methods

  • onUploadStart(task: { abort: any }): void
  • 上传前回调事件

    Parameters

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

    Returns void