Class APIAdminAnnouncements

Site announcements - the developers' side. Every method is developer-only (403 otherwise) and NOT behind the siteAnnouncements flag, so announcements can be drafted before launch. Every write refreshes what the site shows.

Publishing with postToDiscord posts it to the site-updates Discord webhook ONCE (only if the server has one configured); postedToDiscordAt says when.

Index

Constructors

constructor

Methods

createAnnouncement deleteAnnouncement listAdminAnnouncements updateAnnouncement

Constructors

constructor

new APIAdminAnnouncements(web): APIAdminAnnouncements
Parameters
- web: WebDataManager
Returns APIAdminAnnouncements
- Defined in src/classes/adminAnnouncements.ts:15

Methods

createAnnouncement

createAnnouncement(__namedParameters): Promise<WebResponse<AdminSiteAnnouncement>>
Create an announcement. Rules checked on the server: in the feed, as a banner, or both; linkUrl and linkLabel together; endsAt after startsAt.
Parameters
- __namedParameters: {
  announcement: SiteAnnouncementCreateInput;
  auth: string;
  }
  - announcement: SiteAnnouncementCreateInput
  - auth: string
Returns Promise<WebResponse<AdminSiteAnnouncement>>
- Defined in src/classes/adminAnnouncements.ts:29

deleteAnnouncement

deleteAnnouncement(__namedParameters): Promise<WebResponse<{
announcementId: string;
}>>
Delete an announcement with its dismissals.
Parameters
- __namedParameters: {
  announcementId: string;
  auth: string;
  }
  - announcementId: string
  - auth: string
Returns Promise<WebResponse<{
announcementId: string;
}>>
- Defined in src/classes/adminAnnouncements.ts:47

listAdminAnnouncements

listAdminAnnouncements(__namedParameters): Promise<WebResponse<{
announcements: AdminSiteAnnouncement[];
}>>
Every announcement, drafts and ended ones included, newest first.
Parameters
- __namedParameters: {
  auth: string;
  }
  - auth: string
Returns Promise<WebResponse<{
announcements: AdminSiteAnnouncement[];
}>>
- Defined in src/classes/adminAnnouncements.ts:18

updateAnnouncement

updateAnnouncement(__namedParameters): Promise<WebResponse<AdminSiteAnnouncement>>
Edit an announcement; send only what changes. The same rules apply to the result.
Parameters
- __namedParameters: {
      announcement: Partial<SiteAnnouncementCreateInput>;
      announcementId: string;
      auth: string;
  }
  - announcement: Partial<SiteAnnouncementCreateInput>
  - announcementId: string
  - auth: string
Returns Promise<WebResponse<AdminSiteAnnouncement>>
- Defined in src/classes/adminAnnouncements.ts:38

Class APIAdminAnnouncements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns APIAdminAnnouncements

Methods

createAnnouncement

Parameters

announcement: SiteAnnouncementCreateInput

auth: string

Returns Promise<WebResponse<AdminSiteAnnouncement>>

deleteAnnouncement

Parameters

announcementId: string

auth: string

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

listAdminAnnouncements

Parameters

auth: string

Returns Promise<WebResponse<{
announcements: AdminSiteAnnouncement[];
}>>

updateAnnouncement

Parameters

announcement: Partial<SiteAnnouncementCreateInput>

announcementId: string

auth: string

Returns Promise<WebResponse<AdminSiteAnnouncement>>

Settings

On This Page

Class APIAdminAnnouncements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns APIAdminAnnouncements

Methods

createAnnouncement

Parameters

announcement: SiteAnnouncementCreateInput

auth: string

Returns Promise<WebResponse<AdminSiteAnnouncement>>

deleteAnnouncement

Parameters

announcementId: string

auth: string

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

listAdminAnnouncements

Parameters

auth: string

Returns Promise<WebResponse<{ announcements: AdminSiteAnnouncement[]; }>>

updateAnnouncement

Parameters

announcement: Partial<SiteAnnouncementCreateInput>

announcementId: string

auth: string

Returns Promise<WebResponse<AdminSiteAnnouncement>>

Settings

On This Page

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

Returns Promise<WebResponse<{
announcements: AdminSiteAnnouncement[];
}>>