宜搭+
    正在准备搜索索引...

    类 FormMapper

    表单数据操作器。

    该类提供针对具体宜搭表单或流程实例的数据操作能力，包括查询、新增、删除、 更新。查询操作会自动处理分页、子表数据加载（超过 50 条时自动拉取剩余数据） 以及元信息注入。

    通过 FormMapper.asProcess 方法可将操作器切换为流程实例模式， 此时所有操作将针对流程实例而非普通表单。

    26.7.1

    索引

    构造函数

    constructor

    属性

    appMapper formUuid processCode type

    方法

    asProcess delete_ insert select update of

    构造函数

    属性

    appMapper: AppMapper = ...

    应用上下文映射器实例。

    提供当前操作所需的 AppMapper.appId 与 AppMapper.csrfToken 等环境参数。

    26.7.1

    formUuid: string = ""

    当前操作的目标表单 UUID。

    26.7.1

    processCode: string = ""

    流程编码。

    仅在 FormMapper.type 为 "process" 时有效，用于流程实例的新增操作。

    26.7.1

    type: "form" | "process" = "form"

    当前操作的数据类型。

    • "form"：普通表单数据。
    • "process"：流程实例数据。

    默认值为 "form"。

    26.7.1

    方法

    • 切换到流程实例模式。

      切换后，所有数据操作将针对流程实例而非普通表单，并自动适配相关接口与 数据结构。

      参数

      • processCode: string

        流程编码，需与表单绑定的流程一致。

      返回 FormMapper

      当前实例，支持链式调用。

      26.7.1

    delete_

    • delete_(id: string): Promise<void>

      删除一条表单或流程实例数据。

      根据 FormMapper.type 自动选择普通表单的 deleteFormData 接口 或流程实例的 deleteInstance 接口。

      参数

      • id: string

        记录 ID，可为普通表单的 formInstId 或流程实例的 processInstanceId。

      返回 Promise<void>

      异步操作完成后返回 undefined。

      26.7.1

    • 新增一条表单或流程实例数据。

      根据 FormMapper.type 自动选择普通表单的 saveFormData 接口 或流程实例的 startInstance 接口。

      参数

      • data: {} = {}

        需要新增的数据对象，结构需符合目标表单字段定义。

      返回 Promise<void>

      异步操作完成后返回 undefined。

      26.7.1

    • 查询表单或流程实例数据。

      该方法支持两种查询模式：

      • 当 query 为对象时，按条件查询多条记录，并自动处理分页与子表数据加载。
      • 当 query 为字符串时，视为记录 ID（普通表单的 formInstId 或流程实例的 processInstanceId），查询单条记录。

      返回的记录对象已包含 meta 字段，其中保存了 formInstId 等元信息。 对于 tableField_xxx 类型的子表字段，若条数超过 50，会自动拉取剩余数据。

      参数

      • query: string | object = {}

        查询条件对象或单条记录 ID，默认为空对象（查询全部）。

      • pageAmount: number = Number.MAX_SAFE_INTEGER

        需要查询的页数，默认为 Number.MAX_SAFE_INTEGER（查询所有页）。

      • pageOffset: number = 0

        页码偏移量，默认为 0（从第一页开始）。

      • rawParams: {} = {}

        附加的原始接口请求参数，默认为空对象。

      返回 Promise<unknown[] | undefined>

      异步返回查询结果数组；查询失败时返回 undefined。

      26.7.1

    • 更新一条表单或流程实例数据。

      根据 FormMapper.type 自动选择普通表单的 updateFormData 接口 或流程实例的 updateInstance 接口。

      参数

      • id: string

        记录 ID，可为普通表单的 formInstId 或流程实例的 processInstanceId。

      • data: {} = {}

        需要更新的数据对象，结构需符合目标表单字段定义。

      返回 Promise<void>

      异步操作完成后返回 undefined。

      26.7.1

    显示设置

    成员可见性

    目录

    构造函数
    属性
    方法