Class APIAnnouncements

Site announcements - developer-posted announcements the dashboard shows, in a feed and/or as a banner.

listAnnouncements needs no session; the rest need a logged-in user (auth). Behind the siteAnnouncements launch flag: while it is hidden for the caller the lists are EMPTY (not 403) and a dismissal 404s.

Only announcements showing NOW are returned: published, and inside their start/end window. One announcement can be in both feed and banners. Pinned first, then newest. body is markdown.

Constructors

constructor

Methods

createAnnouncementDismissal getAnnouncementDismissals listAnnouncements

Constructors

constructor

Methods

createAnnouncementDismissal

  • createAnnouncementDismissal(__namedParameters): Promise<WebResponse<{
        announcementId: string;
        dismissed: true;
    }>>

  • Dismiss a banner for the logged-in user (remembered across devices). Dismissing twice is fine. { status: 400, error: { code: 'not_dismissible' } } when it cannot be dismissed; 30/minute.

    Parameters

    • __namedParameters: {
          announcementId: string;
          auth: string;
      }
      • announcementId: string
      • auth: string

    Returns Promise<WebResponse<{
        announcementId: string;
        dismissed: true;
    }>>

getAnnouncementDismissals

  • getAnnouncementDismissals(__namedParameters): Promise<WebResponse<{
        dismissedIds: string[];
    }>>

  • The showing, dismissible announcements the logged-in user has dismissed - hide those banners.

    Parameters

    • __namedParameters: {
          auth: string;
      }
      • auth: string

    Returns Promise<WebResponse<{
        dismissedIds: string[];
    }>>

listAnnouncements

Settings

Member Visibility

On This Page

Constructors
Methods