Skip to main content

Module types

Module types 

Source
Expand description

Shared data models and types.

Modules§

achievements
metadata
user

Structs§

AchievementRow
Collection
Manual / smart / virtual row for the library collections pane.
CurrentUser
Current authenticated user from GET /api/users/me.
EarnedAchievement
Firmware
Represents a firmware file associated with a platform.
MergedRaMetadata
RetroAchievements catalog attached to a ROM (merged_ra_metadata from RomM).
Platform
A gaming platform (console or system) supported by RomM.
RaAchievement
RaUserGameProgression
RaUserProgression
Rom
Represents a single ROM file and its associated metadata.
RomFile
One file row under a RomM Rom (base game, update, DLC, etc.).
RomList
A paginated list of ROMs returned by the API.
RomMatchFields
Provider IDs to send in PUT /api/roms/{id} when applying a search match.
RomUpdateResponse
Subset of DetailedRomSchema returned by PUT /api/roms/{id}.
SaveMetadata
Save metadata returned by RomM /api/saves.
SaveScreenshot
Screenshot attached to a save file.
SearchCover
Row from GET /api/search/cover (SteamGridDB).
SearchRom
Row from GET /api/search/roms.
SgdbResource
VirtualCollectionRow
Response row from GET /api/collections/virtual.

Enums§

RomFileCategory
Category of an internal file within a multi-file RomM ROM (see Rom::files).