mirror of
https://github.com/jellyfin/jellyfin.git
synced 2026-06-01 21:38:27 +01:00
Add xmldocs for TMDb provider, correct provider spelling
This commit is contained in:
@@ -33,9 +33,9 @@ namespace MediaBrowser.Controller.Entities.Movies
|
||||
.ToArray();
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the name of the TMDB collection.
|
||||
/// Gets or sets the name of the TMDb collection.
|
||||
/// </summary>
|
||||
/// <value>The name of the TMDB collection.</value>
|
||||
/// <value>The name of the TMDb collection.</value>
|
||||
public string TmdbCollectionName { get; set; }
|
||||
|
||||
[JsonIgnore]
|
||||
|
||||
@@ -1,9 +1,14 @@
|
||||
#pragma warning disable CS1591
|
||||
|
||||
namespace MediaBrowser.Controller.Providers
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface IHasOrder.
|
||||
/// </summary>
|
||||
public interface IHasOrder
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the order.
|
||||
/// </summary>
|
||||
/// <value>The order.</value>
|
||||
int Order { get; }
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
#pragma warning disable CS1591
|
||||
|
||||
using System.Collections.Generic;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
@@ -8,20 +6,41 @@ using MediaBrowser.Model.Providers;
|
||||
|
||||
namespace MediaBrowser.Controller.Providers
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface IRemoteMetadataProvider.
|
||||
/// </summary>
|
||||
public interface IRemoteMetadataProvider : IMetadataProvider
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Interface IRemoteMetadataProvider.
|
||||
/// </summary>
|
||||
public interface IRemoteMetadataProvider<TItemType, in TLookupInfoType> : IMetadataProvider<TItemType>, IRemoteMetadataProvider, IRemoteSearchProvider<TLookupInfoType>
|
||||
where TItemType : BaseItem, IHasLookupInfo<TLookupInfoType>
|
||||
where TLookupInfoType : ItemLookupInfo, new()
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the metadata for a specific LookupInfoType.
|
||||
/// </summary>
|
||||
/// <param name="info">The LookupInfoType to get metadata for.</param>
|
||||
/// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
|
||||
/// <returns>Task{MetadataResult{TItemType}}.</returns>
|
||||
Task<MetadataResult<TItemType>> GetMetadata(TLookupInfoType info, CancellationToken cancellationToken);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Interface IRemoteMetadataProvider.
|
||||
/// </summary>
|
||||
public interface IRemoteSearchProvider<in TLookupInfoType> : IRemoteSearchProvider
|
||||
where TLookupInfoType : ItemLookupInfo
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the list of <see cref="RemoteSearchResult"/> for a specific LookupInfoType.
|
||||
/// </summary>
|
||||
/// <param name="searchInfo">The LookupInfoType to search for.</param>
|
||||
/// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
|
||||
/// <returns>Task{IEnumerable{RemoteSearchResult}}.</returns>
|
||||
Task<IEnumerable<RemoteSearchResult>> GetSearchResults(TLookupInfoType searchInfo, CancellationToken cancellationToken);
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user