// client-side:
const announcements = beam.announcements;
// server-side:
const announcements = beamServer.announcements(playerId);
// claim a single announcement
await announcements.claim({ id: "id" });
// claim multiple announcements
await announcements.claim({ id: ["id-1", "id-2"] });

Throws¶

If the announcement ID is invalid or the operation fails.

delete()¶

delete(params): Promise<void>

Defined in: src/services/AnnouncementsService.ts:159

Deletes one or more announcements for the current player.

Parameters¶

params¶

AnnouncementIdParams

Returns¶

Promise<void>

Remarks¶

Ensure any claimable announcements are handled appropriately before deletion.

Example¶

// client-side:
const announcements = beam.announcements;
// server-side:
const announcements = beamServer.announcements(playerId);
// delete a single announcement
await announcements.delete({ id: "id" });
// delete multiple announcements
await announcements.delete({ id: ["id-1", "id-2"] });

Throws¶

If the announcement ID is invalid or the operation fails.

list()¶

list(): Promise<AnnouncementView[]>

Defined in: src/services/AnnouncementsService.ts:56

Fetches all active announcements for the current player.

Returns¶

Promise<AnnouncementView[]>

Example¶

// client-side
const announcements = await beam.announcements.list();
// server-side
const announcements = await beamServer.announcements(playerId).list();

Throws¶

If the request fails.

markAsRead()¶

markAsRead(params): Promise<void>

Defined in: src/services/AnnouncementsService.ts:122

Marks one or more announcements as read for the current player.

Parameters¶

params¶

AnnouncementIdParams

Returns¶

Promise<void>

Example¶

// client-side:
const announcements = beam.announcements;
// server-side:
const announcements = beamServer.announcements(playerId);
// mark a single announcement as read
await announcements.markAsRead({ id: "id" });
// mark multiple announcements as read
await announcements.markAsRead({ id: ["id-1", "id-2"] });