mirror of
https://github.com/jellyfin/jellyfin.git
synced 2024-09-06 19:37:55 +02:00
Forces all new public/internal members to be documented. Enables TreatWarningsAsErrors for Emby.Drawing
121 lines
3.6 KiB
C#
121 lines
3.6 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.Threading.Tasks;
|
|
using MediaBrowser.Common.Plugins;
|
|
using MediaBrowser.Model.Events;
|
|
using MediaBrowser.Model.Updates;
|
|
using Microsoft.Extensions.DependencyInjection;
|
|
|
|
namespace MediaBrowser.Common
|
|
{
|
|
/// <summary>
|
|
/// An interface to be implemented by the applications hosting a kernel
|
|
/// </summary>
|
|
public interface IApplicationHost
|
|
{
|
|
/// <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>
|
|
/// Gets or sets a value indicating whether this instance has pending kernel reload.
|
|
/// </summary>
|
|
/// <value><c>true</c> if this instance has pending kernel reload; otherwise, <c>false</c>.</value>
|
|
bool HasPendingRestart { get; }
|
|
|
|
bool IsShuttingDown { get; }
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether this instance can self restart.
|
|
/// </summary>
|
|
/// <value><c>true</c> if this instance can self restart; otherwise, <c>false</c>.</value>
|
|
bool CanSelfRestart { get; }
|
|
|
|
/// <summary>
|
|
/// Occurs when [has pending restart changed].
|
|
/// </summary>
|
|
event EventHandler HasPendingRestartChanged;
|
|
|
|
/// <summary>
|
|
/// Notifies the pending restart.
|
|
/// </summary>
|
|
void NotifyPendingRestart();
|
|
|
|
/// <summary>
|
|
/// Restarts this instance.
|
|
/// </summary>
|
|
void Restart();
|
|
|
|
/// <summary>
|
|
/// Gets the application version.
|
|
/// </summary>
|
|
/// <value>The application version.</value>
|
|
string ApplicationVersion { 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; }
|
|
|
|
/// <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);
|
|
|
|
/// <summary>
|
|
/// Resolves this instance.
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
/// <returns>``0.</returns>
|
|
T Resolve<T>();
|
|
|
|
/// <summary>
|
|
/// Shuts down.
|
|
/// </summary>
|
|
Task Shutdown();
|
|
|
|
/// <summary>
|
|
/// Gets the plugins.
|
|
/// </summary>
|
|
/// <value>The plugins.</value>
|
|
IPlugin[] Plugins { get; }
|
|
|
|
/// <summary>
|
|
/// Removes the plugin.
|
|
/// </summary>
|
|
/// <param name="plugin">The plugin.</param>
|
|
void RemovePlugin(IPlugin plugin);
|
|
|
|
/// <summary>
|
|
/// Inits this instance.
|
|
/// </summary>
|
|
Task InitAsync(IServiceCollection serviceCollection);
|
|
|
|
/// <summary>
|
|
/// Creates the instance.
|
|
/// </summary>
|
|
/// <param name="type">The type.</param>
|
|
/// <returns>System.Object.</returns>
|
|
object CreateInstance(Type type);
|
|
|
|
PackageVersionClass SystemUpdateLevel { get; }
|
|
}
|
|
}
|