@halix/action-sdk
    Preparing search index...

    Interface FormTemplateActionResponse

    FormTemplateActionResponse is an interface defining the properties of a form template action response. These properties are expected by the form framework unpon receiving an action response from an action handler.

    interface FormTemplateActionResponse {
        isError: boolean;
        notificationConfigs?: NotificationConfig[];
        responseType: "formTemplateAction";
        successMessage: string;
        updatedSubject: any;
    }

    Hierarchy (View Summary)

    Index

    Properties

    isError: boolean

    Whether the action is an error

    notificationConfigs?: NotificationConfig[]

    Notification configurations; present only if the action should trigger one or more notifications

    responseType: "formTemplateAction"

    The type of action response

    listAction - Use when the action is being run from a list formTemplateAction - Use when the action is being run from a form template pageTemplateAction - Use when the action is being run from a page template objectSaveAction - Use when the action has been specified for use on object save events calculatedFieldAction - Use when the action is being used to determine calculated field values singleValueAction - Use when the action is being used to determine a single value in specific build-in platform events (e.g., determining shopping cart prices) error - Use when the action is not successful

    successMessage: string
    updatedSubject: any