Interface IGameDatabaseAPI

Describes object providing game database API.

Inherited members

Games

Platforms

Emulators

Genres

Companies

Tags

Categories

Series

AgeRatings

Regions

Sources

Features

GameScanners

CompletionStatuses

ImportExclusions

FilterPresets

IsOpen

DatabaseOpened

ImportGame(GameMetadata)

ImportGame(GameMetadata, LibraryPlugin)

GetGameMatchesFilter(Game, FilterPresetSettings)

GetFilteredGames(FilterPresetSettings)

GetGameMatchesFilter(Game, FilterPresetSettings, Boolean)

GetFilteredGames(FilterPresetSettings, Boolean)

Properties

DatabasePath

Gets full path to database directory location.

Property Value

Type	Description
System.String

Methods

AddFile(String, Guid)

Add file to data storage.

Parameters

Type	Name	Description
System.String	path	Path of the file to be added.
System.Guid	parentId	Databse item parent containning the file.

Returns

Type	Description
System.String	Database id of added file.

BeginBufferUpdate()

Begins buffered update. Suppresses all notification events until buffering is stopped.

BufferedUpdate()

Switches database to buffered mode. Suppresses all notification events until buffering is stopped.

Returns

Type	Description
System.IDisposable	Buffer object.

EndBufferUpdate()

Ends buffered update.

GetFileStoragePath(Guid)

Returns full path to directory storing files for specified parent.

Parameters

Type	Name	Description
System.Guid	parentId	Id of parent object.

Returns

Type	Description
System.String	Full path to directory.

GetFullFilePath(String)

Returns full path to a file based on database path.

Parameters

Type	Name	Description
System.String	databasePath	Database path as set to game's field.

Returns

Type	Description
System.String	Full path to a file.

RemoveFile(String)

Removes file from database.

Parameters

Type	Name	Description
System.String	id	File id.

SaveFile(String, String)

Exports file from database.

Parameters

Type	Name	Description
System.String	id	File id.
System.String	path	Full path to target file.