文件上传模块
数据结构
ESUploadInfo
文件上传信息
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
id | 唯一标识符 | string | 是 |
url | 上传地址 | string | 是 |
mediaType | 媒资类型 | string | 是 |
fileParamsKey | 渠道 | string | 是 |
filePath | 文件存储目录 | string | 是 |
params | 上传参数 | Map<string, string> | 否 |
header | 上传header参数 | Map<string, string> | 否 |
接口
upload
该方法上传文件。
完整方法声明:function upload(info: ESUploadInfo): void
- 参数:
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
info | 上传文件信息 | ESUploadInfo | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无 | void |
addListener
该方法添加文件上传监听。
完整方法声明:function addListener(info: ESUploadInfo, listener: ESUploadListener): void
- 参数:
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
info | 上传文件信息 | ESUploadInfo | 是 |
listener | 上传文件监听 | ESUploadListener | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无 | void |
removeListener
该方法删除文件上传监听。
完整方法声明:function removeListener(listener: ESUploadListener): void
- 参数:
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
listener | 上传文件监听 | ESUploadListener | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无 | void |
基础用法
- 代码示例:
点击查看源码
vue<template> <div class='es-sdk-root-css'> <s-title-view class='es-sdk-content-title-css' :text='this.$options.name' /> <div class='es-sdk-content-divider-css' /> <div class='es-sdk-content-column-css'> <s-text-view :text="'上传状态:' + statusText"></s-text-view> <s-text-button text='点击上传' @onButtonClicked='onButtonClicked' /> </div> </div> </template> <script lang='ts'> import {defineComponent} from '@vue/runtime-core'; import {ESUploadInfo, ESUploadListener, useESUpload} from '@extscreen/es3-core'; import {ref} from 'vue'; export default defineComponent({ name: '上传模块', setup() { const upload = useESUpload(); const statusText = ref(''); const params: Map<string, string> = new Map<string, string>(); const uploadInfo: ESUploadInfo = { id: '111', url: 'http://134.175.107.190/api/v1/applog/upload/exifUploadlog?ip=127.0.0.1', mediaType: 'multipart/form-data', filePramsKey: 'logname', filePath: '/video/bbb.zip', params, }; function onButtonClicked() { upload.upload(uploadInfo); } const listener: ESUploadListener = { onUploadStart() { statusText.value = 'onUploadStart:' + JSON.stringify(uploadInfo); }, onUploadSuccess() { statusText.value = 'onUploadSuccess:' + JSON.stringify(uploadInfo); }, onUploadError() { statusText.value = 'onUploadError:' + JSON.stringify(uploadInfo); }, }; function onESCreate(params) { upload.addListener(uploadInfo, listener); } function onESDestroy() { upload.removeListener(listener); } return { statusText, onButtonClicked, onESCreate, onESDestroy, }; }, }); </script> <style> </style>