pl-api
    Preparing search index...

    Function announcementsCategory

    • Parameters

      Returns {
          addAnnouncementReaction: (
              announcementId: string,
              emoji: string,
          ) => Promise<EmptyObject>;
          deleteAnnouncementReaction: (
              announcementId: string,
              emoji: string,
          ) => Promise<EmptyObject>;
          dismissAnnouncements: (announcementId: string) => Promise<EmptyObject>;
          getAnnouncements: () => Promise<
              {
                  all_day: boolean;
                  content: string;
                  emojis: {
                      category: string
                      | null;
                      shortcode: string;
                      static_url: string;
                      url: string;
                      visible_in_picker: boolean;
                  }[];
                  ends_at: string
                  | null;
                  id: string;
                  mentions: { acct: string; id: string; url: string; username: string }[];
                  published_at: string;
                  reactions: {
                      announcement_id: string;
                      count: number;
                      me: boolean;
                      name: string;
                      static_url: string | null;
                      url: string | null;
                  }[];
                  read: boolean;
                  starts_at: string
                  | null;
                  statuses: { [key: string]: string };
                  tags: {
                      following?: boolean;
                      history: { accounts: number; day: number; uses: number }[] | null;
                      name: string;
                      total: number | null;
                      url: string;
                  }[];
                  updated_at: string;
              }[],
          >;
      }

      • addAnnouncementReaction: (announcementId: string, emoji: string) => Promise<EmptyObject>

        Add a reaction to an announcement React to an announcement with an emoji.

      • deleteAnnouncementReaction: (announcementId: string, emoji: string) => Promise<EmptyObject>

        Remove a reaction from an announcement Undo a react emoji to an announcement.

      • dismissAnnouncements: (announcementId: string) => Promise<EmptyObject>

        Dismiss an announcement Allows a user to mark the announcement as read.

      • getAnnouncements: () => Promise<
            {
                all_day: boolean;
                content: string;
                emojis: {
                    category: string
                    | null;
                    shortcode: string;
                    static_url: string;
                    url: string;
                    visible_in_picker: boolean;
                }[];
                ends_at: string
                | null;
                id: string;
                mentions: { acct: string; id: string; url: string; username: string }[];
                published_at: string;
                reactions: {
                    announcement_id: string;
                    count: number;
                    me: boolean;
                    name: string;
                    static_url: string | null;
                    url: string | null;
                }[];
                read: boolean;
                starts_at: string
                | null;
                statuses: { [key: string]: string };
                tags: {
                    following?: boolean;
                    history: { accounts: number; day: number; uses: number }[] | null;
                    name: string;
                    total: number | null;
                    url: string;
                }[];
                updated_at: string;
            }[],
        >

        View all announcements See all currently active announcements set by admins.