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

    Interface FormsForm

    The structure of a form.

    interface FormsForm {
        coverImage?: string;
        createdAt: string;
        deadline?: string;
        description: ProseMirrorDocument;
        descriptionHtml?: string;
        dressing?: FormsFormDressing;
        googleSheetUrl?: string;
        id: string;
        lastEditor: string;
        messageAfterSubmission: string;
        previewMessage: string;
        publishTime?: string;
        status: FormsFormStatus;
        title: string;
        unitId: string;
        updatedAt: string;
        visibility: FormsFormVisibility;
    }
    Index

    Properties

    coverImage? createdAt deadline? description descriptionHtml? dressing? googleSheetUrl? id lastEditor messageAfterSubmission previewMessage publishTime? status title unitId updatedAt visibility

    Properties

    coverImage?: string

    The full URL to access the cover image.

    createdAt: string

    The creation timestamp of the form.

    deadline?: string

    (Optional) Deadline for form completion. If not specified, returns null.

    description: ProseMirrorDocument

    The form description as ProseMirror JSON, for admin editing in Tiptap.

    descriptionHtml?: string

    The form description rendered as HTML for frontend form display and preview.

    dressing?: FormsFormDressing

    The dressing of the form.

    googleSheetUrl?: string

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

    id: string

    The form's unique identifier.

    lastEditor: string

    The user who last editted the form.

    messageAfterSubmission: string

    The message to show after user's submission.

    previewMessage: string

    Preview text. If not provided, fallback to first 25 characters of description.

    publishTime?: string

    When the form is available to be filled.

    status: FormsFormStatus

    The status of this form.

    title: string

    The title of the form.

    unitId: string

    The unit this form belongs to.

    updatedAt: string

    The last updated timestamp 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