Class Plugin
- Namespace
- Playnite
- Assembly
- Playnite.SDK.dll
public abstract class Plugin : IAsyncDisposable
- Inheritance
-
Plugin
- Implements
- Inherited Members
Constructors
Plugin()
public Plugin()
Properties
LibrarySettings
public Plugin.LibrarySupport? LibrarySettings { get; set; }
Property Value
MetadataSettings
public Plugin.MetadataSupport? MetadataSettings { get; set; }
Property Value
XamlId
public string? XamlId { get; set; }
Property Value
Methods
CalculateGameInstallSizeAsync(CalculateGameInstallSizeArgs)
public virtual Task<Plugin.CalculateGameInstallSizeResult?> CalculateGameInstallSizeAsync(Plugin.CalculateGameInstallSizeArgs args)
Parameters
Returns
CollectDiagnosticDataArgsAsync(CollectDiagnosticDataArgs)
public virtual Task<Plugin.CollectDiagnosticDataArgsAsyncResult?> CollectDiagnosticDataArgsAsync(Plugin.CollectDiagnosticDataArgs args)
Parameters
Returns
DataChangedAsync(DataChangedArgs)
public Task DataChangedAsync(Plugin.DataChangedArgs args)
Parameters
argsPlugin.DataChangedArgs
Returns
DisposeAsync()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.
public virtual ValueTask DisposeAsync()
Returns
- ValueTask
A task that represents the asynchronous dispose operation.
GetAddGameMenuItemDescriptors(GetAddGameMenuItemDescriptorsArgs)
public virtual ICollection<MenuItemDescriptor> GetAddGameMenuItemDescriptors(Plugin.GetAddGameMenuItemDescriptorsArgs args)
Parameters
Returns
GetAddGameMenuItems(GetAddGameMenuItemsArgs)
public virtual ICollection<MenuItemImpl>? GetAddGameMenuItems(Plugin.GetAddGameMenuItemsArgs args)
Parameters
Returns
GetAppMenuItemDescriptors(GetAppMenuItemDescriptorsArgs)
public virtual ICollection<MenuItemDescriptor>? GetAppMenuItemDescriptors(Plugin.GetAppMenuItemDescriptorsArgs args)
Parameters
Returns
GetAppMenuItems(GetAppMenuItemsArgs)
public virtual ICollection<MenuItemImpl>? GetAppMenuItems(Plugin.GetAppMenuItemsArgs args)
Parameters
Returns
GetAppViewItem(GetAppViewItemsArgs)
public virtual AppViewItem? GetAppViewItem(Plugin.GetAppViewItemsArgs args)
Parameters
Returns
GetAppViewItemDescriptors(GetAppViewItemDescriptorsArgs)
public virtual ICollection<AppViewItemDescriptor>? GetAppViewItemDescriptors(Plugin.GetAppViewItemDescriptorsArgs args)
Parameters
Returns
GetGameEditHandlerAsync(GetGameEditHandlerArgs)
public virtual Task<GameEditSessionHandler?> GetGameEditHandlerAsync(Plugin.GetGameEditHandlerArgs args)
Parameters
Returns
GetGameExplorer(GetGameExplorersArgs)
public virtual GameExplorer? GetGameExplorer(Plugin.GetGameExplorersArgs args)
Parameters
Returns
GetGameExplorerDescriptors(GetGameExplorerDescriptorsArgs)
public virtual ICollection<GameExplorerDescriptor> GetGameExplorerDescriptors(Plugin.GetGameExplorerDescriptorsArgs args)
Parameters
Returns
GetGameFilterDescriptors(GetGameFiltereDescriptorsArgs)
public virtual ICollection<GameFiltererDescriptor> GetGameFilterDescriptors(Plugin.GetGameFiltereDescriptorsArgs args)
Parameters
Returns
GetGameFilterer(GetGameFilterersArgs)
public virtual GameFilterer? GetGameFilterer(Plugin.GetGameFilterersArgs args)
Parameters
Returns
GetGameGrouper(GetGameGroupersArgs)
public virtual GameGrouper? GetGameGrouper(Plugin.GetGameGroupersArgs args)
Parameters
Returns
GetGameGrouperDescriptors(GetGameGrouperDescriptorsArgs)
public virtual ICollection<GameGrouperDescriptor> GetGameGrouperDescriptors(Plugin.GetGameGrouperDescriptorsArgs args)
Parameters
Returns
GetGameMenuItemDescriptors(GetGameMenuItemDescriptorsArgs)
public virtual ICollection<MenuItemDescriptor> GetGameMenuItemDescriptors(Plugin.GetGameMenuItemDescriptorsArgs args)
Parameters
Returns
GetGameMenuItems(GetGameMenuItemsArgs)
public virtual ICollection<MenuItemImpl>? GetGameMenuItems(Plugin.GetGameMenuItemsArgs args)
Parameters
Returns
GetGameMetadataSessionHandler(GetGameMetadataSessionHandlerArgs)
public virtual GameMetadataSessionHandler? GetGameMetadataSessionHandler(Plugin.GetGameMetadataSessionHandlerArgs args)
Parameters
Returns
GetGameSorter(GetGameSortersArgs)
public virtual GameSorter? GetGameSorter(Plugin.GetGameSortersArgs args)
Parameters
argsPlugin.GetGameSortersArgs
Returns
GetGameSorterDescriptors(GetGameSorterDescriptorsArgs)
public virtual ICollection<GameSorterDescriptor> GetGameSorterDescriptors(Plugin.GetGameSorterDescriptorsArgs args)
Parameters
Returns
GetGamesAsync(LibraryGetGamesArgs)
public virtual Task<List<ImportableGame>> GetGamesAsync(Plugin.LibraryGetGamesArgs args)
Parameters
Returns
GetGlobalSearchItems(GetGlobalSearchItemsArgs)
public virtual ICollection<SearchItem>? GetGlobalSearchItems(Plugin.GetGlobalSearchItemsArgs args)
Parameters
Returns
GetInstallActionsAsync(GetInstallActionsArgs)
public virtual Task<List<InstallController>> GetInstallActionsAsync(Plugin.GetInstallActionsArgs args)
Parameters
Returns
GetInstallationDirectory(GetInstallationDirectoryArgs)
public virtual Plugin.GetInstallationDirectoryResult? GetInstallationDirectory(Plugin.GetInstallationDirectoryArgs args)
Parameters
Returns
GetMetadataDataSupportDescriptors(GetMetadataDataSupportDescriptorsArgs)
public virtual ICollection<MetadataDataSupportDescriptor> GetMetadataDataSupportDescriptors(Plugin.GetMetadataDataSupportDescriptorsArgs args)
Parameters
Returns
GetMetadataProviderAsync(GetMetadataProviderArgs)
public virtual Task<MetadataProvider?> GetMetadataProviderAsync(Plugin.GetMetadataProviderArgs args)
Parameters
Returns
GetPlayActionsAsync(GetPlayActionsArgs)
public virtual Task<List<PlayController>> GetPlayActionsAsync(Plugin.GetPlayActionsArgs args)
Parameters
argsPlugin.GetPlayActionsArgs
Returns
GetPluginGameDataPresenter(GetPluginGameDataPresenterArgs)
public virtual PluginGameDataPresenter? GetPluginGameDataPresenter(Plugin.GetPluginGameDataPresenterArgs args)
Parameters
Returns
GetSearchContext(GetSearchContextArgs)
public virtual SearchContext? GetSearchContext(Plugin.GetSearchContextArgs args)
Parameters
Returns
GetSearchSupportDescriptors(GetSearchSupportDescriptorsArgs)
public virtual ICollection<SearchSupportDescriptor>? GetSearchSupportDescriptors(Plugin.GetSearchSupportDescriptorsArgs args)
Parameters
Returns
GetSettingsHandlerAsync(GetSettingsHandlerArgs)
public virtual Task<PluginSettingsHandler?> GetSettingsHandlerAsync(Plugin.GetSettingsHandlerArgs args)
Parameters
Returns
GetSidebarItemDescriptors(GetSidebarItemDescriptorsArgs)
public virtual ICollection<SidebarItemDescriptor>? GetSidebarItemDescriptors(Plugin.GetSidebarItemDescriptorsArgs args)
Parameters
Returns
GetSidebarItems(GetSidebarItemsArgs)
public virtual ICollection<SidebarItem>? GetSidebarItems(Plugin.GetSidebarItemsArgs args)
Parameters
Returns
GetUninstallActionsAsync(GetUninstallActionsArgs)
public virtual Task<List<UninstallController>> GetUninstallActionsAsync(Plugin.GetUninstallActionsArgs args)
Parameters
Returns
GroupDataChangedAsync(GroupDataChangedArgs)
public Task GroupDataChangedAsync(Plugin.GroupDataChangedArgs args)
Parameters
Returns
ImportGamesAsync(ImportGamesArgs)
public virtual Task<List<Game>> ImportGamesAsync(Plugin.ImportGamesArgs args)
Parameters
argsPlugin.ImportGamesArgs
Returns
InitializeAsync(InitializeArgs)
public virtual Task InitializeAsync(Plugin.InitializeArgs args)
Parameters
argsPlugin.InitializeArgs
Returns
OnAgeRatingCollectionChange(DataCollectionChangeArgs<AgeRating>)
public virtual Task OnAgeRatingCollectionChange(DataCollectionChangeArgs<AgeRating> args)
Parameters
Returns
OnAppActionCollectionChange(DataCollectionChangeArgs<AppAction>)
public virtual Task OnAppActionCollectionChange(DataCollectionChangeArgs<AppAction> args)
Parameters
Returns
OnApplicationShutdownAsync(OnApplicationShutdownArgs)
public virtual Task OnApplicationShutdownAsync(Plugin.OnApplicationShutdownArgs args)
Parameters
Returns
OnApplicationStartupAsync(OnApplicationStartupArgs)
public virtual Task OnApplicationStartupAsync(Plugin.OnApplicationStartupArgs args)
Parameters
Returns
OnCategoryCollectionChange(DataCollectionChangeArgs<Category>)
public virtual Task OnCategoryCollectionChange(DataCollectionChangeArgs<Category> args)
Parameters
Returns
OnCompanyCollectionChange(DataCollectionChangeArgs<Company>)
public virtual Task OnCompanyCollectionChange(DataCollectionChangeArgs<Company> args)
Parameters
Returns
OnCompletionStatusCollectionChange(DataCollectionChangeArgs<CompletionStatus>)
public virtual Task OnCompletionStatusCollectionChange(DataCollectionChangeArgs<CompletionStatus> args)
Parameters
Returns
OnExternalIdentifierTypeCollectionChange(DataCollectionChangeArgs<ExternalIdentifierType>)
public virtual Task OnExternalIdentifierTypeCollectionChange(DataCollectionChangeArgs<ExternalIdentifierType> args)
Parameters
Returns
OnFeatureCollectionChange(DataCollectionChangeArgs<Feature>)
public virtual Task OnFeatureCollectionChange(DataCollectionChangeArgs<Feature> args)
Parameters
Returns
OnGameAchievementCollectionChange(DataCollectionChangeArgs<GameAchievement>)
public virtual Task OnGameAchievementCollectionChange(DataCollectionChangeArgs<GameAchievement> args)
Parameters
Returns
OnGameActionCollectionChange(DataCollectionChangeArgs<GameAction>)
public virtual Task OnGameActionCollectionChange(DataCollectionChangeArgs<GameAction> args)
Parameters
Returns
OnGameCollectionChange(DataCollectionChangeArgs<Game>)
public virtual Task OnGameCollectionChange(DataCollectionChangeArgs<Game> args)
Parameters
argsDataCollectionChangeArgs<Game>
Returns
OnGameDescriptionCollectionChange(DataCollectionChangeArgs<GameDescription>)
public virtual Task OnGameDescriptionCollectionChange(DataCollectionChangeArgs<GameDescription> args)
Parameters
Returns
OnGameInstallationCancelledAsync(OnGameInstallationCancelledEventArgs)
public virtual Task OnGameInstallationCancelledAsync(Plugin.OnGameInstallationCancelledEventArgs args)
Parameters
Returns
OnGameInstalledAsync(OnGameInstalledEventArgs)
public virtual Task OnGameInstalledAsync(Plugin.OnGameInstalledEventArgs args)
Parameters
Returns
OnGameNoteCollectionChange(DataCollectionChangeArgs<GameNote>)
public virtual Task OnGameNoteCollectionChange(DataCollectionChangeArgs<GameNote> args)
Parameters
Returns
OnGameRelationCollectionChange(DataCollectionChangeArgs<GameRelation>)
public virtual Task OnGameRelationCollectionChange(DataCollectionChangeArgs<GameRelation> args)
Parameters
Returns
OnGameScriptsCollectionChange(DataCollectionChangeArgs<GameScripts>)
public virtual Task OnGameScriptsCollectionChange(DataCollectionChangeArgs<GameScripts> args)
Parameters
Returns
OnGameSelectionChangedAsync(OnGameSelectionChangedArgs)
public virtual Task OnGameSelectionChangedAsync(Plugin.OnGameSelectionChangedArgs args)
Parameters
Returns
OnGameSessionCollectionChange(DataCollectionChangeArgs<GameSession>)
public virtual Task OnGameSessionCollectionChange(DataCollectionChangeArgs<GameSession> args)
Parameters
Returns
OnGameSplitAsync(OnGamesSplitArgs)
public virtual Task OnGameSplitAsync(Plugin.OnGamesSplitArgs args)
Parameters
argsPlugin.OnGamesSplitArgs
Returns
OnGameStartedAsync(OnGameStartedEventArgs)
public virtual Task OnGameStartedAsync(Plugin.OnGameStartedEventArgs args)
Parameters
Returns
OnGameStartingAsync(OnGameStartingEventArgs)
public virtual Task OnGameStartingAsync(Plugin.OnGameStartingEventArgs args)
Parameters
Returns
OnGameStartupCancelledAsync(OnGameStartupCancelledEventArgs)
public virtual Task OnGameStartupCancelledAsync(Plugin.OnGameStartupCancelledEventArgs args)
Parameters
Returns
OnGameStateChangedAsync(GameStateChangedArgs)
public virtual Task OnGameStateChangedAsync(Plugin.GameStateChangedArgs args)
Parameters
Returns
OnGameStoppedAsync(OnGameStoppedEventArgs)
public virtual Task OnGameStoppedAsync(Plugin.OnGameStoppedEventArgs args)
Parameters
Returns
OnGameUninstallationCancelledAsync(OnGameUninstallationCancelledEventArgs)
public virtual Task OnGameUninstallationCancelledAsync(Plugin.OnGameUninstallationCancelledEventArgs args)
Parameters
Returns
OnGameUninstalledAsync(OnGameUninstalledEventArgs)
public virtual Task OnGameUninstalledAsync(Plugin.OnGameUninstalledEventArgs args)
Parameters
Returns
OnGamepadButtonStateChangedAsync(OnGamepadButtonStateChangedArgs)
public virtual Task OnGamepadButtonStateChangedAsync(OnGamepadButtonStateChangedArgs args)
Parameters
Returns
OnGamepadConnectedAsync(OnGamepadConnectedArgs)
public virtual Task OnGamepadConnectedAsync(OnGamepadConnectedArgs args)
Parameters
Returns
OnGamepadDisconnectedAsync(OnGamepadDisconnectedArgs)
public virtual Task OnGamepadDisconnectedAsync(OnGamepadDisconnectedArgs args)
Parameters
Returns
OnGamesMergedAsync(OnGamesMergedArgs)
public virtual Task OnGamesMergedAsync(Plugin.OnGamesMergedArgs args)
Parameters
argsPlugin.OnGamesMergedArgs
Returns
OnGenreCollectionChange(DataCollectionChangeArgs<Genre>)
public virtual Task OnGenreCollectionChange(DataCollectionChangeArgs<Genre> args)
Parameters
Returns
OnLibraryUpdateFinishedAsync(OnLibraryUpdateFinishedArgs)
public virtual Task OnLibraryUpdateFinishedAsync(Plugin.OnLibraryUpdateFinishedArgs args)
Parameters
Returns
OnLibraryUpdateSpecificFinishedAsync(OnLibraryUpdateSpecificFinishedArgs)
public virtual Task OnLibraryUpdateSpecificFinishedAsync(Plugin.OnLibraryUpdateSpecificFinishedArgs args)
Parameters
Returns
OnLibraryUpdateSpecificStartedAsync(OnLibraryUpdateSpecificStartedArgs)
public virtual Task OnLibraryUpdateSpecificStartedAsync(Plugin.OnLibraryUpdateSpecificStartedArgs args)
Parameters
Returns
OnLibraryUpdateStartedAsync(OnLibraryUpdateStartedArgs)
public virtual Task OnLibraryUpdateStartedAsync(Plugin.OnLibraryUpdateStartedArgs args)
Parameters
Returns
OnMetadataDownloadFinishedAsync(OnMetadataDownloadFinishedArgs)
public virtual Task OnMetadataDownloadFinishedAsync(Plugin.OnMetadataDownloadFinishedArgs args)
Parameters
Returns
OnMetadataDownloadStartedAsync(OnMetadataDownloadStartedArgs)
public virtual Task OnMetadataDownloadStartedAsync(Plugin.OnMetadataDownloadStartedArgs args)
Parameters
Returns
OnPlatformCollectionChange(DataCollectionChangeArgs<Platform>)
public virtual Task OnPlatformCollectionChange(DataCollectionChangeArgs<Platform> args)
Parameters
Returns
OnPluginCallRequestAsync(PluginCallRequestAsyncArgs)
public virtual Task<object?> OnPluginCallRequestAsync(Plugin.PluginCallRequestAsyncArgs args)
Parameters
Returns
OnPluginCallbackAsync(OnPluginCallbackAsyncArgs)
public virtual Task OnPluginCallbackAsync(Plugin.OnPluginCallbackAsyncArgs args)
Parameters
Returns
OnRegionCollectionChange(DataCollectionChangeArgs<Region>)
public virtual Task OnRegionCollectionChange(DataCollectionChangeArgs<Region> args)
Parameters
Returns
OnSeriesCollectionChange(DataCollectionChangeArgs<Series>)
public virtual Task OnSeriesCollectionChange(DataCollectionChangeArgs<Series> args)
Parameters
Returns
OnSourceCollectionChange(DataCollectionChangeArgs<Source>)
public virtual Task OnSourceCollectionChange(DataCollectionChangeArgs<Source> args)
Parameters
Returns
OnSystemHibernateAsync(OnSystemHibernateArgs)
public virtual Task OnSystemHibernateAsync(Plugin.OnSystemHibernateArgs args)
Parameters
Returns
OnSystemLockAsync(OnSystemLockArgs)
public virtual Task OnSystemLockAsync(Plugin.OnSystemLockArgs args)
Parameters
argsPlugin.OnSystemLockArgs
Returns
OnSystemRestartAsync(OnSystemRestartArgs)
public virtual Task OnSystemRestartAsync(Plugin.OnSystemRestartArgs args)
Parameters
Returns
OnSystemShutdownAsync(OnSystemShutdownArgs)
public virtual Task OnSystemShutdownAsync(Plugin.OnSystemShutdownArgs args)
Parameters
Returns
OnSystemSleepAsync(OnSystemSleepArgs)
public virtual Task OnSystemSleepAsync(Plugin.OnSystemSleepArgs args)
Parameters
argsPlugin.OnSystemSleepArgs
Returns
OnTagCollectionChange(DataCollectionChangeArgs<Tag>)
public virtual Task OnTagCollectionChange(DataCollectionChangeArgs<Tag> args)
Parameters
argsDataCollectionChangeArgs<Tag>
Returns
OnUserLogoutAsync(OnUserLogoutArgs)
public virtual Task OnUserLogoutAsync(Plugin.OnUserLogoutArgs args)
Parameters
argsPlugin.OnUserLogoutArgs
Returns
OnViewConfigurationCollectionChange(DataCollectionChangeArgs<ViewConfiguration>)
public virtual Task OnViewConfigurationCollectionChange(DataCollectionChangeArgs<ViewConfiguration> args)
Parameters
Returns
OnWebLinkTypeCollectionChange(DataCollectionChangeArgs<WebLinkType>)
public virtual Task OnWebLinkTypeCollectionChange(DataCollectionChangeArgs<WebLinkType> args)
Parameters
Returns
OpenClientAsync(OpenClientArgs)
public virtual Task OpenClientAsync(Plugin.OpenClientArgs args)
Parameters
argsPlugin.OpenClientArgs
Returns
ShutdownClientAsync(ShutdownClientArgs)
public virtual Task ShutdownClientAsync(Plugin.ShutdownClientArgs args)
Parameters
argsPlugin.ShutdownClientArgs