Type Alias SiteAnnouncementCreateInput

SiteAnnouncementCreateInput: {
    body: string;
    dismissible?: boolean;
    endsAt?: Date | string | null;
    isPublished?: boolean;
    linkLabel?: string | null;
    linkUrl?: string | null;
    pinned?: boolean;
    postToDiscord?: boolean;
    severity?: SiteAnnouncementSeverity;
    showAsBanner?: boolean;
    showInFeed?: boolean;
    startsAt?: Date | string | null;
    title: string;
}

Mirrors SiteAnnouncementCreateSchema in Noti-v3's src/json/zod/site.zod.ts. Defaults are the server's.

Type declaration

  • body: string

    Markdown.

  • Optionaldismissible?: boolean

    Default true.

  • OptionalendsAt?: Date | string | null
  • OptionalisPublished?: boolean

    Default false (draft).

  • OptionallinkLabel?: string | null
  • OptionallinkUrl?: string | null

    http(s) only; goes with linkLabel.

  • Optionalpinned?: boolean

    Default false.

  • OptionalpostToDiscord?: boolean

    Default false.

  • Optionalseverity?: SiteAnnouncementSeverity

    Default info.

  • OptionalshowAsBanner?: boolean

    Default false.

  • OptionalshowInFeed?: boolean

    Default true.

  • OptionalstartsAt?: Date | string | null
  • title: string

Settings

Member Visibility