Click or drag to resize
LaunchBox

IDataManager Interface

This interface provides access to all data in LaunchBox/Big Box. Use the PluginHelper's static DataManager property to access the instance methods and read and write LaunchBox data.

Namespace:  Unbroken.LaunchBox.Plugins.Data
Assembly:  Unbroken.LaunchBox.Plugins (in Unbroken.LaunchBox.Plugins.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public interface IDataManager
Request Example View Source

The IDataManager type exposes the following members.

Methods
  NameDescription
Public methodAddNewEmulator
Adds a new Emulator to the user's collection.
Public methodAddNewGame
Adds a new Game to the user's collection.
Public methodAddNewPlatform
Adds a new Platform to the user's collection.
Public methodAddNewPlatformCategory
Adds a new Platform Category to the user's collection.
Public methodAddNewPlaylist
Adds a new Playlist to the user's collection.
Public methodBackgroundReloadSave
Recommended instead of other Reload and Save methods when quickly saving a single or small amount of values in the data. Completely avoids Dropbox, Google Drive, etc. sync issues by making sure that all changed data is loaded from disk before making the specified changes.
Public methodForceReload
Forces all data to be reloaded from XML files. This method should only ever be necessary to call when significant changes are made to the XML files by something other than the LaunchBox or Big Box applications.
Public methodGetAllEmulators
Gets all Emulators in the user's collection.
Public methodGetAllGames
Gets all Games in the user's collection.
Public methodGetAllParents
Gets all Parents in the user's collection.
Public methodGetAllPlatformCategories
Gets all Platform Categories in the user's collection.
Public methodGetAllPlatforms
Gets all Platforms in the user's collection.
Public methodGetAllPlaylists
Gets all Playlists in the user's collection.
Public methodGetEmulatorById
Get an Emulator by the Emulator's ID.
Public methodGetGameById
Gets a Game via the Game's ID.
Public methodGetPlatformByName
Gets a Platform via the Platform's Name.
Public methodGetPlatformCategoryByName
Gets a Platform Category via the Platform Category's Name.
Public methodGetPlaylistById
Gets a Playlist via the Playlist's ID.
Public methodGetRootPlatformsCategoriesPlaylists
Gets the list of root platforms, platform categories, and playlists, which can then be used to parse through children as well.
Public methodReloadIfNeeded
Reloads any changed XML files from disk. Should be called before loading up data to change and save.
Public methodSave
Saves all changes to LaunchBox or Big Box data to disk. Will only save XML files that were changed.
Public methodTryRemoveEmulator
Attempts to remove an Emulator from the user's collection.
Public methodTryRemoveGame
Attempts to remove a Game from the user's collection.
Public methodTryRemovePlatform
Attempts to remove a Platform from the user's collection.
Public methodTryRemovePlatformCategory
Attempts to remove a Platform Category from the user's collection.
Public methodTryRemovePlaylist
Attempts to remove a Playlist from the user's collection.
Top
See Also