@nycu-sdc/core-system-sdk
    Preparing search index...

    Interface FormsFormRequestUpdate

    The request body for creating/updating a form.

    interface FormsFormRequestUpdate {
        coverImage?: string;
        deadline?: string;
        description?: ProseMirrorDocumentUpdate;
        dressing?: FormsFormDressing;
        googleSheetUrl?: string;
        messageAfterSubmission?: string;
        previewMessage?: string;
        publishTime?: string;
        title?: string;
        visibility?: FormsFormVisibility;
    }
    Index

    Properties

    coverImage? deadline? description? dressing? googleSheetUrl? messageAfterSubmission? previewMessage? publishTime? title? visibility?

    Properties

    coverImage?: string

    The image path returned by the upload API.

    deadline?: string

    (Optional) Deadline for form completion.

    description?: ProseMirrorDocumentUpdate

    The form description as ProseMirror JSON, edited in Tiptap and sent by the admin interface.

    dressing?: FormsFormDressing

    The dressing of the form.

    googleSheetUrl?: string

    The google sheet url this form's responses will be sent to.

    messageAfterSubmission?: string

    The message to show after user's submission.

    previewMessage?: string

    (Optional) Preview text for the form. If not provided, fallback to first 25 characters of description.

    publishTime?: string

    When the form is available to be filled.

    title?: string

    The title of the form.

    visibility?: FormsFormVisibility

    The visibility setting of the form. Public forms are visible to all logged-in users. Private forms require a direct link to access.

    Settings

    Member Visibility

    On This Page

    Properties