Class EditWorkflowSession<T>

constructor

• new EditWorkflowSession<T = Record<string, unknown>>(
      options: CreateEditSessionOptions<T>,
  ): EditWorkflowSession<T>

  Type Parameters

  • T = Record<string, unknown>

  Parameters

  • options: CreateEditSessionOptions<T>

  Returns EditWorkflowSession<T>

Readonlykind

Readonlysource

capabilities

• capabilities(): EditWorkflowCapabilitySummary

  Returns EditWorkflowCapabilitySummary

listAttachments

• listAttachments(
      parentId?: FeatureId,
      options?: { signal?: AbortSignal },
  ): Promise<readonly AttachmentInfo[]>

  Parameters

  • OptionalparentId: FeatureId
  • options: { signal?: AbortSignal } = {}

  Returns Promise<readonly AttachmentInfo[]>

metadata

• metadata(): EditWorkflowMetadata

  Returns EditWorkflowMetadata

pendingAttachments

• pendingAttachments(): readonly EditAttachmentMutation[]

  Returns readonly EditAttachmentMutation[]

queryAttachments

• queryAttachments(request?: AttachmentQuery): Promise<readonly AttachmentGroup[]>

  Parameters

  • request: AttachmentQuery = {}

  Returns Promise<readonly AttachmentGroup[]>

queryRelated

• queryRelated<R = Record<string, unknown>>(
      relationshipId: number,
      options?: Omit<RelatedQuery, "relationshipId" | "sourceIds"> & {
          sourceIds?: readonly FeatureId[];
      },
  ): Promise<RelatedResult<R>>

  Type Parameters

  • R = Record<string, unknown>

  Parameters

  • relationshipId: number
  • options: Omit<RelatedQuery, "relationshipId" | "sourceIds"> & {
        sourceIds?: readonly FeatureId[];
    } = {}

  Returns Promise<RelatedResult<R>>

setGeometry

• setGeometry(geometry: Record<string, unknown> | null): this

  Parameters

  • geometry: Record<string, unknown> | null

  Returns this

setId

• setId(id: FeatureId): this

  Parameters

  • id: FeatureId

  Returns this

setValue

• setValue(fieldName: string, value: unknown): this

  Parameters

  • fieldName: string
  • value: unknown

  Returns this

setValues

• setValues(values: Partial<T>): this

  Parameters

  • values: Partial<T>

  Returns this

snapshot

• snapshot(): EditWorkflowSnapshot<T>

  Returns EditWorkflowSnapshot<T>

stageAttachmentAdd

• stageAttachmentAdd(
      attachment: string | Blob | File,
      options?: { contentType?: string; name?: string; parentId?: FeatureId },
  ): this

  Parameters

  • attachment: string | Blob | File
  • options: { contentType?: string; name?: string; parentId?: FeatureId } = {}

  Returns this

stageAttachmentDelete

• stageAttachmentDelete(
      attachmentIds: readonly FeatureId[],
      options?: { parentId?: FeatureId },
  ): this

  Parameters

  • attachmentIds: readonly FeatureId[]
  • options: { parentId?: FeatureId } = {}

  Returns this

stageAttachmentUpdate

• stageAttachmentUpdate(
      attachmentId: FeatureId,
      attachment: string | Blob | File,
      options?: { contentType?: string; name?: string; parentId?: FeatureId },
  ): this

  Parameters

  • attachmentId: FeatureId
  • attachment: string | Blob | File
  • options: { contentType?: string; name?: string; parentId?: FeatureId } = {}

  Returns this

submit

• submit(overrides?: Partial<T>): Promise<EditWorkflowSubmitResult<T>>

  Parameters

  • overrides: Partial<T> = {}

  Returns Promise<EditWorkflowSubmitResult<T>>

validate

• validate(): EditWorkflowValidationResult

  Returns EditWorkflowValidationResult

values

• values(): Readonly<Record<string, unknown>>

  Returns Readonly<Record<string, unknown>>