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

    Shared runtime metadata and lifecycle hooks for authored providers.

    interface WorkflowProviderOptions {
        name?: string;
        displayName?: string;
        description?: string;
        version?: string;
        configure?: ConfigureHandler;
        healthCheck?: HealthCheckHandler;
        warnings?: string[] | WarningsHandler;
        start?: StartHandler;
        close?: CloseHandler;
        startRun: (
            request: StartWorkflowProviderRunRequest,
        ) => MaybePromise<MessageInit<BoundWorkflowRun>>;
        getRun: (
            request: GetWorkflowProviderRunRequest,
        ) => MaybePromise<MessageInit<BoundWorkflowRun>>;
        listRuns: (
            request: Message,
        ) => MaybePromise<MessageInit<BoundWorkflowRun>[]>;
        cancelRun: (
            request: CancelWorkflowProviderRunRequest,
        ) => MaybePromise<MessageInit<BoundWorkflowRun>>;
        upsertSchedule: (
            request: UpsertWorkflowProviderScheduleRequest,
        ) => MaybePromise<MessageInit<BoundWorkflowSchedule>>;
        getSchedule: (
            request: GetWorkflowProviderScheduleRequest,
        ) => MaybePromise<MessageInit<BoundWorkflowSchedule>>;
        listSchedules: (
            request: Message,
        ) => MaybePromise<MessageInit<BoundWorkflowSchedule>[]>;
        deleteSchedule: (
            request: DeleteWorkflowProviderScheduleRequest,
        ) => MaybePromise<void>;
        pauseSchedule: (
            request: PauseWorkflowProviderScheduleRequest,
        ) => MaybePromise<MessageInit<BoundWorkflowSchedule>>;
        resumeSchedule: (
            request: ResumeWorkflowProviderScheduleRequest,
        ) => MaybePromise<MessageInit<BoundWorkflowSchedule>>;
        upsertEventTrigger: (
            request: UpsertWorkflowProviderEventTriggerRequest,
        ) => MaybePromise<MessageInit<BoundWorkflowEventTrigger>>;
        getEventTrigger: (
            request: GetWorkflowProviderEventTriggerRequest,
        ) => MaybePromise<MessageInit<BoundWorkflowEventTrigger>>;
        listEventTriggers: (
            request: Message,
        ) => MaybePromise<MessageInit<BoundWorkflowEventTrigger>[]>;
        deleteEventTrigger: (
            request: DeleteWorkflowProviderEventTriggerRequest,
        ) => MaybePromise<void>;
        pauseEventTrigger: (
            request: PauseWorkflowProviderEventTriggerRequest,
        ) => MaybePromise<MessageInit<BoundWorkflowEventTrigger>>;
        resumeEventTrigger: (
            request: ResumeWorkflowProviderEventTriggerRequest,
        ) => MaybePromise<MessageInit<BoundWorkflowEventTrigger>>;
        publishEvent: (
            request: PublishWorkflowProviderEventRequest,
        ) => MaybePromise<void>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    name?: string
    displayName?: string
    description?: string
    version?: string
    configure?: ConfigureHandler
    healthCheck?: HealthCheckHandler
    warnings?: string[] | WarningsHandler
    start?: StartHandler
    close?: CloseHandler
    startRun: (
        request: StartWorkflowProviderRunRequest,
    ) => MaybePromise<MessageInit<BoundWorkflowRun>>
    getRun: (
        request: GetWorkflowProviderRunRequest,
    ) => MaybePromise<MessageInit<BoundWorkflowRun>>
    listRuns: (request: Message) => MaybePromise<MessageInit<BoundWorkflowRun>[]>
    cancelRun: (
        request: CancelWorkflowProviderRunRequest,
    ) => MaybePromise<MessageInit<BoundWorkflowRun>>
    upsertSchedule: (
        request: UpsertWorkflowProviderScheduleRequest,
    ) => MaybePromise<MessageInit<BoundWorkflowSchedule>>
    getSchedule: (
        request: GetWorkflowProviderScheduleRequest,
    ) => MaybePromise<MessageInit<BoundWorkflowSchedule>>
    listSchedules: (
        request: Message,
    ) => MaybePromise<MessageInit<BoundWorkflowSchedule>[]>
    deleteSchedule: (
        request: DeleteWorkflowProviderScheduleRequest,
    ) => MaybePromise<void>
    pauseSchedule: (
        request: PauseWorkflowProviderScheduleRequest,
    ) => MaybePromise<MessageInit<BoundWorkflowSchedule>>
    resumeSchedule: (
        request: ResumeWorkflowProviderScheduleRequest,
    ) => MaybePromise<MessageInit<BoundWorkflowSchedule>>
    upsertEventTrigger: (
        request: UpsertWorkflowProviderEventTriggerRequest,
    ) => MaybePromise<MessageInit<BoundWorkflowEventTrigger>>
    getEventTrigger: (
        request: GetWorkflowProviderEventTriggerRequest,
    ) => MaybePromise<MessageInit<BoundWorkflowEventTrigger>>
    listEventTriggers: (
        request: Message,
    ) => MaybePromise<MessageInit<BoundWorkflowEventTrigger>[]>
    deleteEventTrigger: (
        request: DeleteWorkflowProviderEventTriggerRequest,
    ) => MaybePromise<void>
    pauseEventTrigger: (
        request: PauseWorkflowProviderEventTriggerRequest,
    ) => MaybePromise<MessageInit<BoundWorkflowEventTrigger>>
    resumeEventTrigger: (
        request: ResumeWorkflowProviderEventTriggerRequest,
    ) => MaybePromise<MessageInit<BoundWorkflowEventTrigger>>
    publishEvent: (
        request: PublishWorkflowProviderEventRequest,
    ) => MaybePromise<void>