Actions & hooks

Register declared contributions through ExtensionContext. Formatters return text for an undoable edit. Hooks require API 3.3 and return plans for the event document, with no ambient filesystem/network/DOM access. Hooks run after successful local changes; hook failures do not roll them back. Table actions must await declareOutputs before updates; cancellation retains completed writes.

Usage guide: actions. API index.

Signatures, parameters and return types are generated from the SDK. Optional members are not available in every host and context.

FileHookContext

Source

FileHookContext.event

Supported hosts: Lite Mobile

readonly event: FileHookEvent;

FileHookContext.signal

Supported hosts: Lite Mobile

readonly signal: AbortSignal;

FileHookContext.settings

Supported hosts: Lite Mobile

readonly settings: Readonly<Record<string, SettingValue>>;

Related types: FileHookEvent, SettingValue.

FileHookHandler

Source

Supported hosts: Lite Mobile

export type FileHookHandler = (context: FileHookContext) => FileHookPlan | void | Promise<FileHookPlan | void>;

Related types: FileHookContext, FileHookPlan.

FormatterProvider

Source

FormatterProvider.format

Supported hosts: Lite

format(input: FormatterInput): {
    text: string;
} | Promise<{
    text: string;
}>;

Parameter	Type	Required
`input`	`FormatterInput`	Yes

Returns: { text: string; } | Promise<{ text: string; }>.

Related types: FormatterInput.

TableActionCapabilities

Source

TableActionCapabilities.eidos

Supported hosts: Lite Mobile

readonly eidos: {
    readonly table: Pick<EidosTable, "tableId" | "viewId" | "readContext">;
    readonly config: Pick<EidosConfig, "read">;
};

TableActionCapabilities.target

Supported hosts: Lite Mobile

readonly target: {
    count: number;
    readRows(options: {
        offset: number;
        limit: number;
        fields: string[];
    }): Promise<TableActionRecord[]>;
    update(input: {
        readToken: string;
        values: Record<string, LogicalValue>;
    }): Promise<void>;
};

TableActionCapabilities.connections

Supported hosts: Lite Mobile

readonly connections: {
    request(input: {
        connection: string;
        body: JsonObject;
    }): Promise<JsonObject>;
};

TableActionCapabilities.task

Supported hosts: Lite Mobile

readonly task: {
    declareOutputs(rows: Array<{
        readToken: string;
        values: Record<string, LogicalValue>;
    }>): Promise<void>;
    report(progress: {
        completed: number;
        message?: string;
    }): Promise<void>;
};

Related types: EidosTable, EidosConfig, TableActionRecord.

TableActionProvider

Source

TableActionProvider.getItems

Supported hosts: Lite Mobile

getItems(context: {
    readonly i18n: PluginI18n;
    readonly signal: AbortSignal;
    readonly capabilities: Pick<TableActionCapabilities, "eidos">;
}): Promise<TableActionItem[]> | TableActionItem[];

Parameter	Type	Required
`context`	`{ readonly i18n: PluginI18n; readonly signal: AbortSignal; readonly capabilities: Pick<TableActionCapabilities, "eidos">; }`	Yes

Returns: Promise<TableActionItem[]> | TableActionItem[].

TableActionProvider.run

Supported hosts: Lite Mobile

run(context: TableActionContext, itemId: string): Promise<void>;

Parameter	Type	Required
`context`	`TableActionContext`	Yes
`itemId`	`string`	Yes

Returns: Promise<void>.