文件操作

实例化一个 BaaS.File 对象，以下操作都是在该对象上进行操作，如下进行实例化：

let MyFile = new BaaS.File()

上传文件

MyFile.upload(uploadFile, fileMeta)

参数说明

FileMeta对象说明

示例代码

let MyFile = new BaaS.File()

// 指定文件名上传
MyFile.upload('/var/log/test.log').then()

// 使用 Buffer 构建文件内容
MyFile.upload(Buffer.from('this is file content'), {filename: 'test.txt'}).then()

// 上传到指定目录
MyFile.upload('/var/log/test.log', {category_id: 1}).then()

返回参数说明

res.data:

file 参数说明：

文件云下载

创建下载任务

MyFile.createDownloadTask({originalUrl, filename, categoryName, overwrite})

参数说明

示例代码

let MyFile = new BaaS.File()

const res = await MyFile.createDownloadTask({
  originalUrl: 'https://***.jpg',
  filename: '***.jpg',
  categoryName: '文件云下载',
  overwrite: true,
})
return res.data

返回示例

{
  "id": 1
}

获取下载结果

MyFile.getDownloadTaskResult(id)

参数说明

示例代码

let MyFile = new BaaS.File()
const res = await MyFile.getDownloadTaskResult(1)
return res.data

返回示例

下载中：

{
  "category_name": "文件云下载",
  "created_at": 1587545049,
  "error_message": null,
  "file_path": "https://***.jpg",
  "filename": "***.jpg",
  "id": 5,
  "original_url": "https://***.jpg",
  "status": "pending",
}

下载失败：

{
  "category_name": "文件云下载",
  "created_at": 1587545049,
  "error_message": null,
  "file_path": "https://***.jpg",
  "filename": "***.jpg",
  "id": 5,
  "original_url": "https://***.jpg",
  "status": "failed",
}

下载成功：

{
  "category_name": "文件云下载",
  "created_at": 1587545049,
  "error_message": null,
  "file_path": "https://***.jpg",
  "filename": "***.jpg",
  "id": 5,
  "original_url": "https://***.jpg",
  "status": "success",
  "uploaded_file": {
    "categories": [
      {
        "id": "5ea003ca2dc6106f4f0b441f",
        "name": "文件云下载",
        "parent": null
      }
    ],
    "cdn_path": "***.jpg",
    "created_at": 1587545051,
    "created_by": 1091431,
    "id": "5ea003db2dc6106fcfd3cf62",
    "media_type": null,
    "mime_type": null,
    "name": "***.jpg",
    "path": "https://***.jpg",
    "reference": {},
    "size": 7755,
    "status": "success",
    "updated_at": 1587545051
  }
}

获取文件详情

MyFile.get(fileID)

参数说明

返回参数说明

res.data:

category 参数说明：

示例代码

let MyFile = new BaaS.File()
MyFile.get('5a2fe93308443e313a428c4f').then(res => {
  // success
}, err => {
  // err
})

返回示例

{
  "category": {
    "id": "5a2fe91508443e3123dbe1cb",
    "name": "科技"
  },
  "created_at": 1507822469,
  "id": "5a2fe93308443e313a428c4f",
  "mime_type": "text/plain; charset=utf-8",
  "name": "tmp_262601706o6zAJs-pmaywKzqHIvzwU97rtiGIe4dd39171563993cf10b12bae2ac30ec.svg",
  "path": "https://baas-hello-world.cloud.ifanrusercontent.com/1fQTn8UCwQYlGFrv.txt",
  "size": 3879
}

删除文件

MyFile.delete(fileID)

参数说明

示例代码

let MyFile = new BaaS.File()

MyFile.delete('5a2fe93308443e313a428c4f').then()

MyFile.delete(['5a2fe93308443e313a428c4c', '5a2fe93308443e313a428c4d']).then()

获取符合条件的文件总数

BaaS.File#count()

文件查询与数据表查询方法一致，但只支持以下指定字段的筛选

• async/await
• promise

let MyFile = new BaaS.File()
let query = new BaaS.Query()
query.compare('category_name', '=', categoryName)
query.contains('name', substr)
let num = await MyFile.setQuery(query).count()
console.log(num)  // 10

let MyFile = new BaaS.File()
let query = new BaaS.Query()
query.compare('category_name', '=', categoryName)
query.contains('name', substr)
MyFile.setQuery(query).count().then(num => {
  // success
  console.log(num)  // 10
  callback(null, res)
}, err => {
  // err
  callback(err)
})

查询，获取文件列表

BaaS.File#find(options)

参数说明

options:

文件查询与数据表查询方法一致，但只支持以下指定字段的筛选

示例代码

let MyFile = new BaaS.File()

// 查找所有文件
MyFile.find()

let query = new BaaS.Query()
// 查询某一文件分类下的所有文件
query.compare('category_name', '=', categoryName)
// 查询文件名包含指定字符串的文件
query.contains('name', substr)
MyFile.setQuery(query).find()

let MyFile = new BaaS.File()

// 查找所有文件
MyFile.find()

// 按创建时间范围查询: 2018年10月24日17时10分57秒 至今上传的文件
let query = BaaS.Query.and(new BaaS.Query().compare('created_at', '<=', Math.ceil(Date.now() / 1000)), new BaaS.Query().compare('created_at', '>=', 1540372257)),

MyFile.setQuery(query).find()

排序

文件查询排序与数据表排序方法一致，但只支持对以下指定字段进行排序

示例代码

let MyFile = new BaaS.File()
MyFile.orderBy('-created_at').find().then()

分页

文件查询排序与数据表分页方法一致

视频截图

MyFile.genVideoSnapshot(params)

params参数说明

返回参数说明

res.data:

示例代码

let MyFile = new BaaS.File()
let params = {
  "source": "asjgernaskasdewk",
  "save_as": "hello.png",
  "point": "00:00:10",
  "category_id": "5c18bc794e1e8d20dbfcddcc",
  "random_file_link": false
}
MyFile.genVideoSnapshot(params).then((res) => {
  // success
}, err => {
  // HError 对象
})

HError 对象结构请参考错误码和 HError 对象

返回示例

{
  "created_at": 1547461561,
  "path": null,
  "created_by_id": 16042162,
  "mime_type": "image/png",
  "media_type": "image",
  "size": 99391,
  "name": "1gizRRuY71ZUcSZX.png",
  "status": "success",
  "reference": "",
  "cdn_path": "1gizRRRdklnf7gCD.png",
  "updated_at": 1547461561,
  "categories": [],
  "_id": "5c3c63b9d1606e0b3fc7acb7"
}

M3U8 视频拼接

MyFile.videoConcat(params)

params参数说明

返回参数说明

res.data:

示例代码

let MyFile = new BaaS.File()
let params = {
  "m3u8s": ["xxxxxxxxxxx", "xxxxxxxxxxx"],
  "save_as": "hello.m3u8",
  "category_id": "5c18bc794e1e8d20dbfcddcc",
  "random_file_link": false,
}
MyFile.videoConcat(params).then((res) => {
  // success
}, err => {
  // HError 对象
})

HError 对象结构请参考错误码和 HError 对象

返回示例

{
  "created_at": 1547461561,
  "path": null,
  "created_by_id": 16042162,
  "mime_type": "",
  "media_type": "",
  "size": "",
  "name": "hello.m3u8",
  "status": "pengding",
  "reference": "",
  "cdn_path": "1gizRRRdklnf7gCD.m3u8",
  "updated_at": 1547461561,
  "categories": [],
  "_id": "5c3c63b9d1606e0b3fc7acb7"
}

M3U8 视频剪辑

MyFile.videoClip(params)

params参数说明

返回参数说明

res.data:

示例代码

let MyFile = new BaaS.File()
let params = {
  "m3u8": "xxxxxxxxxxx",
  "include": [0, 20],
  "save_as": "0s_20s.m3u8",
  "category_id": "5c18bc794e1e8d20dbfcddcc",
  "random_file_link": false
}
MyFile.videoClip(params).then((res) => {
  // success
}, err => {
  // HError 对象
})

HError 对象结构请参考错误码和 HError 对象

返回示例

{
  "created_at": 1547461561,
  "path": null,
  "created_by_id": 16042162,
  "mime_type": "",
  "media_type": "",
  "size": "",
  "name": "hello.m3u8",
  "status": "pending",
  "reference": "",
  "cdn_path": "1gizRRRdklnf7gCD.m3u8",
  "updated_at": 1547461561,
  "categories": [],
  "_id": "5c3c63b9d1606e0b3fc7acb7"
}

M3U8 时长和分片信息

MyFile.videoMeta(params)

params参数说明

返回参数说明

res.data:

meta 参数说明：

示例代码

let MyFile = new BaaS.File()
let params = {
  "m3u8": "xxxxxxxxxxx"
}
MyFile.videoMeta(params).then((res) => {
  // success
}, err => {
  // HError 对象
})

HError 对象结构请参考错误码和 HError 对象

返回示例

{
  "status_code": 200,
  "message": "ok",
  "meta": {
    "duration": 2850.2974559999984,
    "points": [
      11.277933,
      23.7237,
      34.6346,
      42.008632999999996,
      50.483765999999996,
      64.764699,
      70.80406599999999,
      82.31556599999999,
      92.892799,
      100.200099,
      114.74796599999999,
      123.92379899999999,
      131.09763199999998,
      140.97416499999997,
      158.32483199999996,
      160.05989899999994,
      172.70586599999996,
      181.04753299999996,
      191.79159999999996
    ]
  }
}

音视频的元信息

MyFile.videoAudioMeta(params)

params参数说明

返回参数说明

res.data:

format 参数说明：

streams 参数说明：

示例代码

let MyFile = new BaaS.File()
let params = {
  "source": "xxxxxxxxxxx"
}
MyFile.videoAudioMeta(params).then((res) => {
  // success
}, err => {
  // HError 对象
})

HError 对象结构请参考错误码和 HError 对象

返回示例

{
  "streams": [
    {
      "index": 0,
      "type": "video",
      "video_fps": 25,
      "video_height": 236,
      "video_width": 426,
      "codec_desc": "H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10",
      "codec": "h264",
      "bitrate": 99608,
      "duration": 184.8,
      "metadata": {
        "handler_name": "VideoHandler",
        "language": "und"
      }
    },
    {
      "index": 1,
      "type": "audio",
      "audio_channels": 2,
      "audio_samplerate": 44100,
      "codec_desc": "AAC (Advanced Audio Coding)",
      "codec": "aac",
      "bitrate": 48005,
      "duration": 184.855011,
      "metadata": {
        "handler_name": "SoundHandler",
        "language": "und"
      }
    }
  ],
  "format": {
    "duration": 184.902,
    "fullname": "QuickTime / MOV",
    "bitrate": 154062,
    "filesize": 3560797,
    "format": "mov,mp4,m4a,3gp,3g2,mj2"
  }
}

刷新 CDN 缓存

MyFile.purgeCache(operationType, content)

参数说明

示例代码

let MyFile = new BaaS.File()
MyFile.purgeCache('exact', ['https://***']).then((res) => {
  // success
}, err => {
  // HError 对象
})

HError 对象结构请参考错误码和 HError 对象

返回示例

{
  "status": "ok"
}

获取 CDN 缓存刷新操作记录

MyFile.getPurgeCacheHistory(params)

params 参数说明

示例代码

let MyFile = new BaaS.File()
let params = {
  offset: 0,
  limit: 10,
  operationType: 'exact',
  created_at__gte: 1548744906,
  created_at__lte: 1548917706,
}
MyFile.getPurgeCacheHistory(params).then((res) => {
  // success
}, err => {
  // HError 对象
})

HError 对象结构请参考错误码和 HError 对象

返回示例

{
  "meta": {
      "limit": 10,
      "next": null,
      "offset": 0,
      "previous": null,
      "total_count": 1
  },
  "objects": [
      {
          "content": "https://***",
          "created_at": 1548830917,
          "error_message": null,
          "id": "5c5148c57032fce4f73e6ef6",
          "operation_type": "exact",
          "status": "in_progress",
          "updated_at": 1548830917
      }
  ]
}