jellyfin/MediaBrowser.Common/IApplicationHost.cs

126 lines
4.3 KiB
C#
Raw Normal View History

using System;
2018-12-27 23:27:57 +00:00
using System.Collections.Generic;
2020-08-11 15:04:11 +00:00
using System.Reflection;
2021-11-02 15:02:52 +00:00
using Microsoft.Extensions.DependencyInjection;
2018-12-27 23:27:57 +00:00
namespace MediaBrowser.Common
{
2020-12-06 23:48:54 +00:00
/// <summary>
/// Delegate used with GetExports{T}.
/// </summary>
/// <param name="type">Type to create.</param>
/// <returns>New instance of type <param>type</param>.</returns>
2021-05-28 12:33:54 +00:00
public delegate object? CreationDelegateFactory(Type type);
2020-12-06 23:48:54 +00:00
2018-12-27 23:27:57 +00:00
/// <summary>
2019-12-10 23:13:57 +00:00
/// An interface to be implemented by the applications hosting a kernel.
2018-12-27 23:27:57 +00:00
/// </summary>
public interface IApplicationHost
{
2019-12-10 23:13:57 +00:00
/// <summary>
/// Occurs when [has pending restart changed].
/// </summary>
2021-05-28 12:33:54 +00:00
event EventHandler? HasPendingRestartChanged;
2019-12-10 23:13:57 +00:00
2018-12-27 23:27:57 +00:00
/// <summary>
/// Gets the name.
/// </summary>
/// <value>The name.</value>
string Name { get; }
/// <summary>
/// Gets the device identifier.
/// </summary>
/// <value>The device identifier.</value>
string SystemId { get; }
/// <summary>
2023-10-04 18:34:53 +00:00
/// Gets a value indicating whether this instance has pending changes requiring a restart.
2018-12-27 23:27:57 +00:00
/// </summary>
2023-10-04 18:34:53 +00:00
/// <value><c>true</c> if this instance has a pending restart; otherwise, <c>false</c>.</value>
2018-12-27 23:27:57 +00:00
bool HasPendingRestart { get; }
/// <summary>
2023-10-04 18:34:53 +00:00
/// Gets or sets a value indicating whether the application should restart.
/// </summary>
2023-10-04 18:34:53 +00:00
bool ShouldRestart { get; set; }
2018-12-27 23:27:57 +00:00
/// <summary>
/// Gets the application version.
/// </summary>
/// <value>The application version.</value>
2019-10-08 18:51:11 +00:00
Version ApplicationVersion { get; }
2020-12-06 23:48:54 +00:00
/// <summary>
/// Gets or sets the service provider.
/// </summary>
2021-05-28 12:33:54 +00:00
IServiceProvider? ServiceProvider { get; set; }
2020-12-06 23:48:54 +00:00
2019-10-08 18:51:11 +00:00
/// <summary>
/// Gets the application version.
/// </summary>
/// <value>The application version.</value>
string ApplicationVersionString { get; }
/// <summary>
/// Gets the application user agent.
/// </summary>
/// <value>The application user agent.</value>
string ApplicationUserAgent { get; }
/// <summary>
/// Gets the email address for use within a comment section of a user agent field.
/// Presently used to provide contact information to MusicBrainz service.
/// </summary>
string ApplicationUserAgentAddress { get; }
2020-08-11 15:04:11 +00:00
/// <summary>
/// Gets all plugin assemblies which implement a custom rest api.
/// </summary>
/// <returns>An <see cref="IEnumerable{Assembly}"/> containing the plugin assemblies.</returns>
IEnumerable<Assembly> GetApiPluginAssemblies();
2019-12-10 23:13:57 +00:00
/// <summary>
/// Notifies the pending restart.
/// </summary>
void NotifyPendingRestart();
2018-12-27 23:27:57 +00:00
/// <summary>
/// Gets the exports.
/// </summary>
/// <typeparam name="T">The type.</typeparam>
/// <param name="manageLifetime">If set to <c>true</c> [manage lifetime].</param>
/// <returns><see cref="IReadOnlyCollection{T}" />.</returns>
IReadOnlyCollection<T> GetExports<T>(bool manageLifetime = true);
2018-12-27 23:27:57 +00:00
2020-12-06 23:48:54 +00:00
/// <summary>
/// Gets the exports.
/// </summary>
/// <typeparam name="T">The type.</typeparam>
/// <param name="defaultFunc">Delegate function that gets called to create the object.</param>
/// <param name="manageLifetime">If set to <c>true</c> [manage lifetime].</param>
/// <returns><see cref="IReadOnlyCollection{T}" />.</returns>
2021-03-09 04:57:38 +00:00
IReadOnlyCollection<T> GetExports<T>(CreationDelegateFactory defaultFunc, bool manageLifetime = true);
2020-12-06 23:48:54 +00:00
/// <summary>
/// Gets the export types.
/// </summary>
/// <typeparam name="T">The type.</typeparam>
/// <returns>IEnumerable{Type}.</returns>
IEnumerable<Type> GetExportTypes<T>();
2018-12-27 23:27:57 +00:00
/// <summary>
/// Resolves this instance.
/// </summary>
2019-12-10 23:13:57 +00:00
/// <typeparam name="T">The <c>Type</c>.</typeparam>
2018-12-27 23:27:57 +00:00
/// <returns>``0.</returns>
T Resolve<T>();
/// <summary>
/// Initializes this instance.
2018-12-27 23:27:57 +00:00
/// </summary>
2021-11-02 15:02:52 +00:00
/// <param name="serviceCollection">Instance of the <see cref="IServiceCollection"/> interface.</param>
void Init(IServiceCollection serviceCollection);
2018-12-27 23:27:57 +00:00
}
}