Frodo Library - v5.0.0-5
    Preparing search index...

    Type Alias Workflow

    type Workflow = {
        deleteDraftWorkflow(
            workflowId: string,
            options?: WorkflowDeleteOptions,
        ): Promise<WorkflowSkeleton>;
        deletePublishedWorkflow(
            workflowId: string,
            options?: WorkflowDeleteOptions,
        ): Promise<WorkflowSkeleton>;
        deleteWorkflow(
            workflowId: string,
            deleteDraft?: boolean,
            deletePublished?: boolean,
            options?: WorkflowDeleteOptions,
            resultCallback?: ResultCallback<WorkflowSkeleton>,
        ): Promise<WorkflowGroup>;
        deleteWorkflows(
            deleteDraft?: boolean,
            deletePublished?: boolean,
            options?: WorkflowDeleteOptions,
            resultCallback?: ResultCallback<WorkflowSkeleton>,
        ): Promise<WorkflowSkeleton[]>;
        exportWorkflow(
            workflowId: string,
            options?: WorkflowExportOptions,
        ): Promise<WorkflowExportInterface>;
        exportWorkflows(
            options?: WorkflowExportOptions,
            resultCallback?: ResultCallback<WorkflowExportInterface>,
        ): Promise<WorkflowExportInterface>;
        importWorkflows(
            workflowId: string,
            importData: WorkflowExportInterface,
            options?: WorkflowImportOptions,
            resultCallback?: ResultCallback<WorkflowSkeleton>,
        ): Promise<WorkflowSkeleton[]>;
        publishWorkflow(workflowId: string): Promise<WorkflowSkeleton>;
        readDraftWorkflow(workflowId: string): Promise<WorkflowSkeleton>;
        readPublishedWorkflow(workflowId: string): Promise<WorkflowSkeleton>;
        readWorkflowGroup(workflowId: string): Promise<WorkflowGroup>;
        readWorkflowGroups(): Promise<WorkflowGroup[]>;
        readWorkflows(): Promise<WorkflowSkeleton[]>;
        updateWorkflow(
            workflowId: string,
            workflowData: WorkflowSkeleton,
        ): Promise<WorkflowSkeleton>;
    }
    Index
    deleteDraftWorkflow deletePublishedWorkflow deleteWorkflow deleteWorkflows exportWorkflow exportWorkflows importWorkflows publishWorkflow readDraftWorkflow readPublishedWorkflow readWorkflowGroup readWorkflowGroups readWorkflows updateWorkflow

    • Read workflow group

      Parameters

      • workflowId: string

        the workflow id

      Returns Promise<WorkflowGroup>

      a promise that resolves to a grouped workflow object (contains both draft and published versions)

    Settings
    Member Visibility

    On This Page
    Methods