Class EditWorkflowSession<T>

constructor

• new EditWorkflowSession<T>(options): 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?, options?): Promise<readonly AttachmentInfo[]>

• Parameters

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

    • Optionalsignal?: AbortSignal

  Returns Promise<readonly AttachmentInfo[]>

metadata

• metadata(): EditWorkflowMetadata

• Returns EditWorkflowMetadata

pendingAttachments

• pendingAttachments(): readonly EditAttachmentMutation[]

• Returns readonly EditAttachmentMutation[]

queryAttachments

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

• Parameters

  • request: AttachmentQuery = {}

  Returns Promise<readonly AttachmentGroup[]>

queryRelated

• queryRelated<R>(relationshipId, options?): 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): this

• Parameters

  • geometry: null | Record<string, unknown>

  Returns this

setId

• setId(id): this

• Parameters

  • id: FeatureId

  Returns this

setValue

• setValue(fieldName, value): this

• Parameters

  • fieldName: string
  • value: unknown

  Returns this

setValues

• setValues(values): this

• Parameters

  • values: Partial<T>

  Returns this

snapshot

• snapshot(): EditWorkflowSnapshot<T>

• Returns EditWorkflowSnapshot<T>

stageAttachmentAdd

• stageAttachmentAdd(attachment, options?): this

• Parameters

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

    • OptionalcontentType?: string

    • Optionalname?: string

    • OptionalparentId?: FeatureId

  Returns this

stageAttachmentDelete

• stageAttachmentDelete(attachmentIds, options?): this

• Parameters

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

    • OptionalparentId?: FeatureId

  Returns this

stageAttachmentUpdate

• stageAttachmentUpdate(attachmentId, attachment, options?): this

• Parameters

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

    • OptionalcontentType?: string

    • Optionalname?: string

    • OptionalparentId?: FeatureId

  Returns this

submit

• submit(overrides?): 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>>