文件分类操作

实例化一个 BaaS.FileCategory 对象,以下操作都是在该对象上进行操作,如下进行实例化:

let MyFileCategory = new BaaS.FileCategory()

创建文件分类

MyFileCategory.create({name})

参数说明

参数类型必填说明
nameStringY文件分类名称

返回参数说明

参数类型必填说明
created_atNumberY分类创建时间
filesNumberY分类下的文件数
idStringY分类 ID
nameStringY分类名
subcategoriesArrayY子分类列表

示例代码

  1. let MyFileCategory = new BaaS.FileCategory()
  2. MyFileCategory.create({name: 'test-file-category'}).then(res => {
  3. // success
  4. }, err => {
  5. // err
  6. })

返回示例

  1. {
  2. "created_at": 1536810022,
  3. "files": 0,
  4. "id": "5b99dc2652f76d7246298257",
  5. "name": "test-file-category",
  6. "parent": null,
  7. "subcategories": [],
  8. }

获取文件分类详情

MyFileCategory.get(categoryID)

参数说明

参数类型必填说明
categoryIDStringY文件分类 ID

返回参数说明

参数类型必填说明
created_atNumberY分类创建时间
filesNumberY分类下的文件数
idStringY分类 ID
nameStringY分类名
updated_atNumberY分类更新时间

示例代码

  1. let MyFileCategory = new BaaS.FileCategory()
  2. MyFileCategory.get('5a2fe91508443e3123dbe1cb').then(res => {
  3. // success
  4. }, err => {
  5. // err
  6. })

返回示例

  1. {
  2. created_at: 1513089301,
  3. files: 2,
  4. id: "5a2fe91508443e3123dbe1cb",
  5. name: "重要",
  6. updated_at: 1513089306
  7. }

更新文件分类

MyFileCategory.update(categoryID, {name})

参数说明

参数类型必填说明
categoryIDStringY文件分类 ID
nameStringY文件分类名称

返回参数说明

参数类型必填说明
created_atNumberY分类创建时间
filesNumberY分类下的文件数
parentNumberY父分类 ID
idStringY分类 ID
nameStringY分类名
subcategoriesArrayY子分类列表
updated_atNumberY分类更新时间

示例代码

  1. let MyFileCategory = new BaaS.FileCategory()
  2. MyFileCategory.update(categoryID, {name: 'file-category'}).then(res => {
  3. // success
  4. }, err => {
  5. // err
  6. })

返回示例

  1. {
  2. "created_at": 1536810022,
  3. "files": 0,
  4. "id": "5b99dc2652f76d7246298257",
  5. "name": "file-category",
  6. "parent": null,
  7. "subcategories": [],
  8. "updated_at": 1536810664
  9. }

删除文件分类

MyFileCategory.delete(categoryID)

参数说明

参数类型必填说明
categoryIDStringY文件分类 ID

示例代码

  1. let MyFileCategory = new BaaS.FileCategory()
  2. MyFileCategory.delete(categoryID).then(res => {
  3. // success
  4. }, err => {
  5. // err
  6. })

返回示例

  1. ""

获取符合条件的文件分类总数

BaaS.FileCategory#count()

  1. let MyFileCategory = new BaaS.FileCategory()
  2. let query = new BaaS.Query()
  3. query.contains('name', substr)
  4. let num = await MyFileCategory.setQuery(query).count()
  5. console.log(num) // 10
  1. let MyFileCategory = new BaaS.FileCategory()
  2. let query = new BaaS.Query()
  3. query.contains('name', substr)
  4. MyFileCategory.setQuery(query).count().then(num => {
  5. // success
  6. console.log(num) // 10
  7. }, err => {
  8. // err
  9. })

查询,获取分类列表

BaaS.FileCategory#find(options)

参数说明

options:

参数类型必填默认说明
withCountbooleantrue是否返回 total_count

withCount 设为 false,接口返回的数据中不包含 total_count,当数据条目多时,可通过不返回 total_count 提高响应速度。如果需要查询记录的总数,请使用 count 方法。

SDK v2.x withCount 的默认值为 true,SDK v3+ withCount 的默认值为 false

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

支持字段类型说明
idString文件分类 ID
nameString文件分类名

示例代码

  1. let MyFileCategory = new BaaS.FileCategory()
  2. // 查找所有文件分类
  3. MyFileCategory.find()
  4. // 设置查询条件
  5. let query = new BaaS.Query()
  6. query.contains('name', substr)
  7. MyFileCategory.setQuery(query).find()

排序

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

支持字段描述
name文件名
created_at文件创建时间

分页

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