IRetroAchievementsApi8.0

Interface in Unbroken.LaunchBox.Plugins.RetroAchievements

Obsolete since 14.1

Use Services.Achievements.IAchievementManager for provider-neutral achievement data. This interface remains supported for existing integrations.

public interface IRetroAchievementsApi

This interface provides access to the retroachievements.org API. Use the PluginHelper's static PluginHelper.RetroAchievementsApi property to access the instance methods of the API.

Methods

GetAllUserCompletionProgress13.15Gets a list of all games the user has any achievement progress for
GetConsolesChanged 14.1Gets an enumeration of all consoles that are available from retroachievements.org.
GetGameInfoChanged 14.1Gets game information for the specified retroachievements.org game ID.
GetGameInfoWithProgress(string)Changed 14.1Gets game and related user progress information for the specified retroachievements.org game ID.
GetGameInfoWithProgress(IGame)Changed 14.1Gets game and related user progress information for the specified game.
GetGameProgression(string)13.27Retrieves aggregate achievement-progression and completion-time statistics for a game.
GetGameProgression(IGame)13.27Retrieves aggregate achievement-progression and completion-time statistics for a game.
GetGamesForConsoleChanged 14.1Gets an enumeration of all games with achievements that are available for the specified console ID.
GetHasCredentialsGets a Boolean value specifying whether or not LaunchBox has been configured with credentials for retroachievements.org. Does not guarantee working credentials.
GetRecentlyPlayedGamesChanged 14.1Gets an enumeration of games that have been recently played by the user.
GetUserRankAndScoreChanged 14.1Gets the current user's rank and score.
GetUserSummary10.8Gets the users summary from retroachievements.org.

GetAllUserCompletionProgress 13.15

List<GameCompletionProgress>? GetAllUserCompletionProgress()

Gets a list of all games the user has any achievement progress for

Returns

Returns null if the user has no credentials entered, otherwise returns a list of games the user has any achievement progress on

GetConsoles Changed 14.1

IEnumerable<Console>? GetConsoles()

Gets an enumeration of all consoles that are available from retroachievements.org.

Returns

An enumeration of Console objects that represent the consoles available. May be null if credentials have not been configured.

GetGameInfo Changed 14.1

GameInfo? GetGameInfo(string gameId)

Gets game information for the specified retroachievements.org game ID.

gameId: The retroachievements.org game ID to retrieve information for.

Returns

A GameInfo object with all relevant information. May be null if credentials have not been configured.

GetGameInfoWithProgress(string) Changed 14.1

GameInfoWithProgress? GetGameInfoWithProgress(string gameId)

Gets game and related user progress information for the specified retroachievements.org game ID.

gameId: The retroachievements.org game ID to retrieve information for.

Returns

A GameInfoWithProgress object with all relevant information. May be null if credentials have not been configured.

GetGameInfoWithProgress(IGame) Changed 14.1

GameInfoWithProgress? GetGameInfoWithProgress(IGame game)

Gets game and related user progress information for the specified game.

game: The IGame to retrieve information for.

Returns

A GameInfoWithProgress object with all relevant information. May be null if credentials have not been configured or the game is not found.

GetGameProgression(string) 13.27

GameInfoWithProgress? GetGameProgression(string gameId)

Retrieves aggregate achievement-progression and completion-time statistics for a game.

gameId: The RetroAchievements game identifier.

Returns

The available progression data, or null if unsupported or unavailable. The default implementation returns null.

GetGameProgression(IGame) 13.27

GameInfoWithProgress? GetGameProgression(IGame game)

Retrieves aggregate achievement-progression and completion-time statistics for a game.

game: The library game whose RetroAchievements identity should be resolved.

Returns

The available progression data, or null if unsupported or unavailable. The default implementation returns null.

GetGamesForConsole Changed 14.1

IEnumerable<Game>? GetGamesForConsole(string consoleId)

Gets an enumeration of all games with achievements that are available for the specified console ID.

consoleId: The retroachievements.org console ID to retrieve the list of games for.

Returns

An enumeration of Game objects that represent the games available for the specified console ID. May be null if credentials have not been configured.

GetHasCredentials

bool GetHasCredentials()

Gets a Boolean value specifying whether or not LaunchBox has been configured with credentials for retroachievements.org. Does not guarantee working credentials.

Returns

A boolean value specifying whether or not credentials have been entered by the user for retroachievements.org. Does not guarantee that they are valid credentials.

GetRecentlyPlayedGames Changed 14.1

IEnumerable<RecentlyPlayedGame>? GetRecentlyPlayedGames(int count, int offset)

Gets an enumeration of games that have been recently played by the user.

count: The number of games to retrieve.

offset: The number of games to skip (for paging).

Returns

An enumeration of RecentlyPlayedGame objects that represent the recently played games. May be null if credentials have not been configured.

GetUserRankAndScore Changed 14.1

UserRankAndScore? GetUserRankAndScore()

Gets the current user's rank and score.

Returns

A UserRankAndScore object with all relevant information. May be null if credentials have not been configured.

GetUserSummary 10.8

UserSummary? GetUserSummary(int recentGamesCount, int recentAchievementCount)

Gets the users summary from retroachievements.org.

recentGamesCount: The last number of games recently played.

recentAchievementCount: The last number of achievements earned.

Returns

The user's summary, or null when credentials are missing or the summary could not be retrieved.