Interface ILibraryApi

Namespace

Playnite

Assembly

Playnite.SDK.dll

public interface ILibraryApi : IDisposable

Inherited Members

IDisposable.Dispose()

Properties

AgeRatings

ILibraryCollection<AgeRating> AgeRatings { get; }

Property Value

ILibraryCollection<AgeRating>

AppActions

ILibraryCollection<AppAction> AppActions { get; }

Property Value

ILibraryCollection<AppAction>

Categories

ILibraryCollection<Category> Categories { get; }

Property Value

ILibraryCollection<Category>

Companies

ILibraryCollection<Company> Companies { get; }

Property Value

ILibraryCollection<Company>

CompletionStatuses

ILibraryCollection<CompletionStatus> CompletionStatuses { get; }

Property Value

ILibraryCollection<CompletionStatus>

ExternalIdentifierTypes

ILibraryCollection<ExternalIdentifierType> ExternalIdentifierTypes { get; }

Property Value

ILibraryCollection<ExternalIdentifierType>

Features

ILibraryCollection<Feature> Features { get; }

Property Value

ILibraryCollection<Feature>

GameAchievements

ILibraryCollection<GameAchievement> GameAchievements { get; }

Property Value

ILibraryCollection<GameAchievement>

GameActions

ILibraryCollection<GameAction> GameActions { get; }

Property Value

ILibraryCollection<GameAction>

GameDescriptions

ILibraryCollection<GameDescription> GameDescriptions { get; }

Property Value

ILibraryCollection<GameDescription>

GameNotes

ILibraryCollection<GameNote> GameNotes { get; }

Property Value

ILibraryCollection<GameNote>

GameScripts

ILibraryCollection<GameScripts> GameScripts { get; }

Property Value

ILibraryCollection<GameScripts>

GameSessions

ILibraryCollection<GameSession> GameSessions { get; }

Property Value

ILibraryCollection<GameSession>

Games

ILibraryCollection<Game> Games { get; }

Property Value

ILibraryCollection<Game>

Genres

ILibraryCollection<Genre> Genres { get; }

Property Value

ILibraryCollection<Genre>

LibraryDir

string LibraryDir { get; }

Property Value

string

Platforms

ILibraryCollection<Platform> Platforms { get; }

Property Value

ILibraryCollection<Platform>

Regions

ILibraryCollection<Region> Regions { get; }

Property Value

ILibraryCollection<Region>

Series

ILibraryCollection<Series> Series { get; }

Property Value

ILibraryCollection<Series>

Source

ILibraryCollection<Source> Source { get; }

Property Value

ILibraryCollection<Source>

Tags

ILibraryCollection<Tag> Tags { get; }

Property Value

ILibraryCollection<Tag>

ViewConfigurations

ILibraryCollection<ViewConfiguration> ViewConfigurations { get; }

Property Value

ILibraryCollection<ViewConfiguration>

WebLinkTypes

ILibraryCollection<WebLinkType> WebLinkTypes { get; }

Property Value

ILibraryCollection<WebLinkType>

Methods

AddFileAsync(string, string, string?, bool)

Task<string?> AddFileAsync(string path, string ownerId, string? savedFileName = null, bool useAddonFolder = false)

Parameters

path string

ownerId string

savedFileName string

useAddonFolder bool

Returns

Task<string>

GetCustomCollection<T>(bool, bool)

IPluginLibraryCollection<T> GetCustomCollection<T>(bool cacheData, bool multiType) where T : LibraryObject

Parameters

cacheData bool

multiType bool

Returns

IPluginLibraryCollection<T>

Type Parameters

T

GetFileStorageDir(string)

string GetFileStorageDir(string parentId)

Parameters

parentId string

Returns

string

GetFullFilePath(string)

string GetFullFilePath(string databasePath)

Parameters

databasePath string

Returns

string

ImportGameAsync(ImportableGame)

Task<Game> ImportGameAsync(ImportableGame game)

Parameters

game ImportableGame

Returns

Task<Game>

ImportGamesAsync(IEnumerable<ImportableGame>)

Task<List<Game>> ImportGamesAsync(IEnumerable<ImportableGame> games)

Parameters

games IEnumerable<ImportableGame>

Returns

Task<List<Game>>

RemoveFile(string)

bool RemoveFile(string id)

Parameters

id string

Returns

bool