Options
All
  • Public
  • Public/Protected
  • All
Menu

Module CloudStorageServiceInterface

Index

Interfaces

Type Aliases

Type Aliases

FileProgressObject

FileProgressObject: { loaded: number; percentage: number; percentageText: string; total: number }

Type declaration

  • loaded: number

    已上传大小

  • percentage: number

    已上传进度

  • percentageText: string

    已上传进度的文本描述

  • total: number

    总大小

IUploadFileOptions

IUploadFileOptions: { file?: File; fileInput?: string | HTMLInputElement; filePath?: string; maxSize?: number; nosScenes?: string; nosSurvivalTime?: number; onUploadDone?: any; onUploadProgress?: any; onUploadStart?: any }

Type declaration

  • Optional file?: File

    JS 的 File 对象。

    浏览器专用

  • Optional fileInput?: string | HTMLInputElement

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

    浏览器专用。

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

  • Optional filePath?: string

    临时文件路径

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

  • Optional maxSize?: number

    maxSize 限制文件大小。

    只对浏览器生效。

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

  • Optional nosScenes?: string

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

  • Optional nosSurvivalTime?: number

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

    不得小于一天，单位秒

  • onUploadDone?:function
  • onUploadProgress?:function
  • onUploadStart?:function

    • 上传前回调事件

      Parameters

      Returns void

UploadFileOptions

UploadFileOptions: { file?: File; fileInput?: string | HTMLInputElement; filePath?: string; maxSize?: number; nosScenes?: string; nosSurvivalTime?: number; type?: "image" | "audio" | "video" | "file"; onUploadDone?: any; onUploadProgress?: any; onUploadStart?: any }

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

Type declaration

  • Optional file?: File

    JS 的 File 对象。

    浏览器专用

  • Optional fileInput?: string | HTMLInputElement
    deprecated

    Use {@link UploadFileOptions.file} instead.

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

    浏览器专用。

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

  • Optional filePath?: string

    临时文件路径

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

  • Optional maxSize?: number

    maxSize 限制文件大小。

    只对浏览器生效。

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

  • Optional nosScenes?: string

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

  • Optional nosSurvivalTime?: number

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

    不得小于一天，单位秒

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

    文件类型

  • onUploadDone?:function
  • onUploadProgress?:function
  • onUploadStart?:function

    • 上传前回调事件

      Parameters

      Returns void

UploadFileResult

UploadFileResult: { audioCodec?: string; container?: string; dur?: number; ext: string; h?: number; md5?: string; name: string; orientation?: string; size?: number; url: string; videoCodec?: string; w?: number }

Type declaration

  • Optional audioCodec?: string

    音频解码格式

  • Optional container?: string

    音视频文件的容器

  • Optional dur?: number

    音频/视频 文件的时长

  • ext: string

    文件后缀

  • Optional h?: number

    高度

  • Optional md5?: string
  • name: string

    文件名

  • Optional orientation?: string

    图片的转向

  • Optional size?: number

    文件大小，单位字节

  • url: string

    文件 url

  • Optional videoCodec?: string

    视频解码格式

  • Optional w?: number

    宽度。