Interface EditSession<T>

interface EditSession<T> {
    id: string;
    cancel(reason?: string): void;
    reset(fieldId?: string): CommandOutcome;
    resolveConflict(decision: ConflictResolution): CommandOutcome;
    set(fieldId: string, value: unknown): CommandOutcome;
    snapshot(): SessionSnapshot<T>;
    submit(): Promise<SubmitOutcome<T>>;
    subscribe(listener: SessionListener<T>): Unsubscribe;
    validate(): Promise<ValidationReport>;
}

Type Parameters

T

Index

Properties

Methods

cancel reset resolveConflict set snapshot submit subscribe validate

Properties

`Readonly`id

id: string

Methods

cancel

cancel(reason?: string): void
Parameters
- Optionalreason: string
Returns void

reset

reset(fieldId?: string): CommandOutcome
Parameters
- OptionalfieldId: string
Returns CommandOutcome

resolveConflict

resolveConflict(decision: ConflictResolution): CommandOutcome
Parameters
- decision: ConflictResolution
Returns CommandOutcome

set

set(fieldId: string, value: unknown): CommandOutcome
Parameters
- fieldId: string
- value: unknown
Returns CommandOutcome

snapshot

snapshot(): SessionSnapshot<T>

Returns SessionSnapshot<T>

submit

submit(): Promise<SubmitOutcome<T>>

Returns Promise<SubmitOutcome<T>>

subscribe(listener: SessionListener<T>): Unsubscribe
Parameters
- listener: SessionListener<T>
Returns Unsubscribe

validate

validate(): Promise<ValidationReport>

Returns Promise<ValidationReport>