@honua/sdk-js
    Preparing search index...

    Interface AskMapSessionOptions<TContext>Experimental

    interface AskMapSessionOptions<TContext> {
        apply: (
            execution: NlMapPlanExecution,
            context: TContext,
        ) => { count: number };
        approve?: (
            plan: NlMapPlan,
            context: TContext,
            signal: AbortSignal,
        ) => Promise<NlMapPlanApproval>;
        context: () => TContext;
        createControl: (context: TContext, signal: AbortSignal) => NlMapControl;
        onState: (state: AskMapState) => void;
        review: (plan: NlMapPlan, context: TContext) => AskMapReview;
        timeoutMs?: number;
    }

    Type Parameters

    • TContext
    Index

    Properties

    apply approve? context createControl onState review timeoutMs?

    Properties

    apply: (execution: NlMapPlanExecution, context: TContext) => { count: number }

    Atomically render accepted results. Older operations never reach this callback.

    approve?: (
        plan: NlMapPlan,
        context: TContext,
        signal: AbortSignal,
    ) => Promise<NlMapPlanApproval>
    context: () => TContext

    Include source/schema/version, authorization identity, selection and captured viewport. No credentials.

    createControl: (context: TContext, signal: AbortSignal) => NlMapControl
    onState: (state: AskMapState) => void
    review: (plan: NlMapPlan, context: TContext) => AskMapReview
    timeoutMs?: number

    Whole proposal/execution bounds, including a callback that ignores cancellation.

    Settings

    Member Visibility

    On This Page

    Properties