OpenFin Workspace API
    Preparing search index...

    Interface NotificationFormSubmittedEvent

    Event fired whenever submit button is clicked on a notification form.

    "notification-form-submitted"

    interface NotificationFormSubmittedEvent {
        button: ButtonOptions;
        clearForm: () => Promise<void>;
        form: Record<string, unknown>;
        notification: Readonly;
        preventDefault: () => void;
        setFormStatus: (
            formStatusOptions: Omit<FormStatusOptions, "_notificationId">,
        ) => Promise<void>;
        type: "notification-form-submitted";
    }
    Index
    button clearForm form notification preventDefault setFormStatus type
    button: ButtonOptions
    clearForm: () => Promise<void>

    Resets all form field values to their initial state. Call this after a successful submission when you want the form cleared for the next entry. If not called, form values are preserved.

    form: Record<string, unknown>
    notification: Readonly
    preventDefault: () => void

    Prevents the default behaviour of notification form submit, where notification card gets dismissed right after submit.

    addEventListener('notification-form-submitted', async (event) => {
        // preventing the default submit behaviour
        event.preventDefault();

        // setting the form status to processing
        event.setFormStatus({
          formStatus: 'Processing'
        });

        const longOperationResult = await ...();

        if (longOperationResult.hasError) {
           // setting error if long-running operation has failed.
           event.setFormStatus({
              formStatus: 'not-submitted',
              error: longOperationResult.operationErrorMessage
            });
        } else {
           // setting form status to submitted
           event.setFormStatus({
             formStatus: 'submitted'
           });
        }
      });
    setFormStatus: (
        formStatusOptions: Omit<FormStatusOptions, "_notificationId">,
    ) => Promise<void>

    Type Declaration

      • (formStatusOptions: Omit<FormStatusOptions, "_notificationId">): Promise<void>

      • Parameters

        • formStatusOptions: Omit<FormStatusOptions, "_notificationId">

          Allows to set the status of the form. The form status reflects the state of the submit button which includes its text. Submit button text for different statuses is defined using formOptions property for a submit button when creating a notification.

        Returns Promise<void>

    addEventListener('notification-form-submitted', async (event) => {
        // preventing the default submit behaviour
        event.preventDefault();

        // setting the form status to processing
        event.setFormStatus({
          formStatus: 'Processing'
        });

        const longOperationResult = await ...();

        if (longOperationResult.hasError) {
           // setting error if long-running operation has failed.
           event.setFormStatus({
              formStatus: 'not-submitted',
              error: longOperationResult.operationErrorMessage
            });
        } else {
           // setting form status to submitted
           event.setFormStatus({
             formStatus: 'submitted'
           });
        }
     });
    type: "notification-form-submitted"

    Settings

    On This Page
    Properties