nodes/generated

Interface FormNodeParameters

Source


interface FormNodeParameters {
    completionMessage?: string;
    completionTitle?: string;
    defineForm?: "json" | "fields";
    formFields?: {
        values: {
            acceptFileTypes?: string;
            defaultValue?: string;
            elementName?: string;
            fieldLabel: string;
            fieldName: string;
            fieldOptions: { values: { option?: string }[] };
            fieldType:
                | "number"
                | "file"
                | "text"
                | "email"
                | "password"
                | "date"
                | "checkbox"
                | "html"
                | "dropdown"
                | "hiddenField"
                | "radio"
                | "textarea";
            fieldValue?: string;
            formatDate?: string;
            html?: string;
            limitSelection?: "exact"
            | "range"
            | "unlimited";
            maxSelections?: number;
            minSelections?: number;
            multipleFiles?: boolean;
            multiselect?: boolean;
            multiselectLegacyNotice?: string;
            numberOfSelections?: number;
            placeholder?: string;
            requiredField?: boolean;
        }[];
    };
    inputDataFieldName?: string;
    jsonOutput?: string;
    limitType?: "afterTimeInterval"
    | "atSpecifiedTime";
    limitWaitTime?: boolean;
    maxDateAndTime?: string;
    operation?: "page" | "completion";
    options?:
        | {
            buttonLabel?: string;
            customCss?: string;
            formDescription?: string;
            formTitle?: string;
        }
        | { customCss?: string; formTitle?: string };
    redirectUrl?: string;
    respondWith?:
        | "text"
        | "redirect"
        | "showText"
        | "returnBinary";
    responseText?: string;
    resumeAmount?: number;
    resumeUnit?: "minutes"
    | "hours"
    | "days";
}

Properties§

§readonly completionMessage?: string

Type options: {"rows":2}

§readonly completionTitle?: string
§readonly defineForm?: "json" | "fields"

Default: "fields"

§readonly formFields?: { ... }

Default: {} Type options: {"multipleValues":true,"sortable":true,"fixedCollection":{"itemTitle":"={{ $collection.item.properties.find(p => p.name === "fieldType").options.find(o => o.value === $collection.item.value.fieldType).name }}"}}

§readonly inputDataFieldName?: string

Find the name of input field containing the binary data to return in the Input panel on the left, in the Binary tab. You can provide multiple comma-separated field names. Default: "data"

§readonly jsonOutput?: string

Default: "[\n {\n "fieldLabel": "Name",\n "placeholder": "enter your name",\n "requiredField": true\n },\n {\n "fieldLabel": "Age",\n "fieldType": "number",\n "placeholder": "enter your age"\n },\n {\n "fieldLabel": "Email",\n "fieldType": "email",\n "requiredField": true\n },\n {\n "fieldLabel": "Textarea",\n "fieldType": "textarea"\n },\n {\n "fieldLabel": "Dropdown Options",\n "fieldType": "dropdown",\n "fieldOptions": {\n "values": [\n {\n "option": "option 1"\n },\n {\n "option": "option 2"\n }\n ]\n },\n "requiredField": true\n },\n {\n "fieldLabel": "Checkboxes",\n "fieldType": "checkbox",\n "fieldOptions": {\n "values": [\n {\n "option": "option 1"\n },\n {\n "option": "option 2"\n }\n ]\n }\n },\n {\n "fieldLabel": "Radio",\n "fieldType": "radio",\n "fieldOptions": {\n "values": [\n {\n "option": "option 1"\n },\n {\n "option": "option 2"\n }\n ]\n }\n },\n {\n "fieldLabel": "Email",\n "fieldType": "email",\n "placeholder": "me@mail.con"\n },\n {\n "fieldLabel": "File",\n "fieldType": "file",\n "multipleFiles": true,\n "acceptFileTypes": ".jpg, .png"\n },\n {\n "fieldLabel": "Number",\n "fieldType": "number"\n },\n {\n "fieldLabel": "Password",\n "fieldType": "password"\n }\n]\n" Type options: {"rows":5}

§readonly limitType?: "afterTimeInterval" | "atSpecifiedTime"

Sets the condition for the execution to resume. Can be a specified date or after some time. Default: "afterTimeInterval"

§readonly limitWaitTime?: boolean

Whether to limit the time this node should wait for a user response before execution resumes

§readonly maxDateAndTime?: string

Continue execution after the specified date and time

§readonly operation?: "page" | "completion"

Default: "page"

§readonly options?:
    | {
        buttonLabel?: string;
        customCss?: string;
        formDescription?: string;
        formTitle?: string;
    }
    | { customCss?: string; formTitle?: string }

Default: {}

§readonly redirectUrl?: string
§readonly respondWith?: "text" | "redirect" | "showText" | "returnBinary"

Default: "text"

§readonly responseText?: string

The text to display on the page. Use HTML to show a customized web page. Type options: {"rows":2}

§readonly resumeAmount?: number

The time to wait Default: 1 Type options: {"minValue":0,"numberPrecision":2}

§readonly resumeUnit?: "minutes" | "hours" | "days"

Unit of the interval value Default: "hours"