讯飞文档开发者中心

# 枚举类型

Open API 中包含许多枚举类型的参数，具体如下：

# 空间类型

/**
 * 空间类型
 * 空间划分为我的空间、共享空间等。
 * 当前只有我的空间。
 */
export enum SpaceType {
  /** 我的空间 */
  MY_SPACE = 1,
}

# 文件对象类型

/**
 * 文件对象类型
 * 文件系统中的对象分为文件和文件夹。
 */
export enum FsType {
  /** 文件夹 */
  FOLDER = 1,
  /** 文件 */
  FILE = 2,
}

# 角色类型

/**
 * 角色类型
 * 用户对某一个文件（夹）的角色，不同角色权限不同。
 */
export enum RoleType {
  /** 无权限者 */
  NONE = 'none',
  /** 可读者 */
  READER = 'reader',
  /** 编辑者 */
  EDITOR = 'editor',
  /** 管理者 */
  ADMIN = 'admin',
  /** 拥有者 */
  OWNER = 'owner',
}

# 文件类型

/**
 * 文件类型
 * 文件分为多个类型，用于区分后续的预览和编辑行为。
 */
export enum FileType {
  /** 文档，特指在线文档。 */
  DOC = 1,
  /** 图片 */
  PIC = 2,
  /** 音频 */
  AUDIO = 3,
  /** 视频 */
  VIDEO = 4,
  /** 其他 */
  OTHER = 0,
}

# 文档类型

/**
 * 文档类型
 * 文档分为文字文档、表格文档等多种子类型。
 */
export enum DocType {
  /** 文字文档 */
  NOTE = 'note',
  /** 表格文档 */
  SHEET = 'sheet',
  /** 速记文档 */
  SHORTHAND = 'shorthand',
}

# 来源类型

/**
 * 来源类型
 * 为后续拓展保留字段，暂可不用。
 */
export enum SourceType {
  /** 协作文档 */
  IDOC = 1,
  /** 对象存储、云存储 */
  OOS = 2,
  /** 文件系统 */
  IFSFILE = 3,
}

# 操作类型

/**
 * 操作类型
 * 对文档的操作记录，分为读、写。
 */
export enum OperateType {
  /** 阅读 */
  READ = 'read',
  /** 编辑 */
  EDIT = 'edit',
}

# 存储目录

/**
 * 存储目录
 * 云存储 objectId 前缀，人为添加前缀以区分文件位置。
 */
export enum FolderType {
  /** 图片 */
  IMAGE = 'image',
  /** 附件 */
  ATTACHMENT = 'attachment',
  /** 音频 */
  AUDIO = 'audio',
}

# 文件状态

/**
 * 文件状态
 * 标记文件是否在回收站或已删除。
 */
export enum FsStatus {
  /** 正常 */
  NORMAL = 1,
  /** 回收站 */
  REMOTE = 2,
  /** 已删除 */
  DELETE = 3,
}

# 协作状态

/**
 * 协作状态
 */
export enum CollaborativeStatus {
  /** 我拥有的且没有邀请别人协作的 */
  OWN_SHARE_NOBODY = 1,
  /** 我拥有的且邀请别人协作的 */
  OWN_SHARE_OTHERS = 2,
  /** 不是我拥有的且别人我邀请协作的 */
  SHARE_ME = 3,
}

# 离线上传处理状态

/**
 * 离线上传处理状态
 */
export enum IflydocsOfflineUploadType {
  /** 正常处理 */
  NORMAL = 1,
  /**
   * 文档|父文件夹|协作关系
   * 被删除(我创建的|我拥有的)上传到我的空间
   */
  FALLBACK = 2,
  /**
   * 文档|父文件夹|协作关系
   * 被删除（非我创建的|删除超过保留时间无法找到记录）直接删除
   */
  DELETE = 3,
}

# 导出文件类型

/**
 * 导出文件类型
 */
export enum IflydocsExportFileType {
  /** 导出为 Word，适用于文字文档 */
  DOCX = 1,
  /** 导出为 PDF，适用于文字文档 */
  PDF = 2,
  /** 导出为 Excel，适用于表格文档 */
  XLSX = 3,
  /** 导出为 CSV，适用于表格文档 */
  CSV = 4,
}

# 导出任务处理状态

/**
 * 文档导入、导出异步任务处理状态
 */
export enum IflydocsTaskStatus {
  /** 排队中 */
  WAITING = 1,
  /** 处理中 */
  PROCESSING = 2,
  /** 处理成功 */
  SUCCESS = 3,
  /** 处理失败 */
  FAILURE = 4,
}

← 数据结构 →