@valon-technologies/gestalt
    Preparing search index...

    Interface AppDefinitionOptions

    Runtime hooks required to implement an app provider.

    interface AppDefinitionOptions {
        name?: string;
        displayName?: string;
        description?: string;
        version?: string;
        migrations?: MigrationsOption;
        workflows?: readonly WorkflowDefinitionInput[];
        configure?: ConfigureHandler;
        healthCheck?: HealthCheckHandler;
        warnings?: string[] | WarningsHandler;
        start?: StartHandler;
        close?: CloseHandler;
        connectionMode?: ConnectionMode;
        authTypes?: string[];
        connectionParams?: Record<string, ConnectionParamDefinition>;
        resolveHTTPSubject?: HTTPSubjectResolver;
        iconSvg?: string;
        operations: OperationDefinition<any, any>[];
        sessionCatalog?: SessionCatalogHandler;
    }

    Hierarchy (View Summary)

    Index

    Properties

    name? displayName? description? version? migrations? workflows? configure? healthCheck? warnings? start? close? connectionMode? authTypes? connectionParams? resolveHTTPSubject? iconSvg? operations sessionCatalog?

    Properties

    name?: string
    displayName?: string
    description?: string
    version?: string
    migrations?: MigrationsOption

    Revisions the SDK discovers and runs during provider startup, before the author's own configure handler. The author never calls a runner.

    workflows?: readonly WorkflowDefinitionInput[]

    Workflow definitions declared as static desired state. The host reconciles these on the config-definitions path; declarations cannot depend on config. Only app (integration) providers publish these via GetMetadata.

    configure?: ConfigureHandler
    healthCheck?: HealthCheckHandler
    warnings?: string[] | WarningsHandler
    start?: StartHandler
    close?: CloseHandler
    connectionMode?: ConnectionMode
    authTypes?: string[]
    connectionParams?: Record<string, ConnectionParamDefinition>
    resolveHTTPSubject?: HTTPSubjectResolver
    iconSvg?: string
    operations: OperationDefinition<any, any>[]
    sessionCatalog?: SessionCatalogHandler

    Settings

    Member Visibility

    On This Page

    Properties