IRemoteMetadataProvider.cs 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. using System.Collections.Generic;
  2. using System.Threading;
  3. using System.Threading.Tasks;
  4. using MediaBrowser.Controller.Entities;
  5. using MediaBrowser.Model.Providers;
  6. namespace MediaBrowser.Controller.Providers
  7. {
  8. /// <summary>
  9. /// Interface IRemoteMetadataProvider.
  10. /// </summary>
  11. public interface IRemoteMetadataProvider : IMetadataProvider
  12. {
  13. }
  14. /// <summary>
  15. /// Interface IRemoteMetadataProvider.
  16. /// </summary>
  17. public interface IRemoteMetadataProvider<TItemType, in TLookupInfoType> : IMetadataProvider<TItemType>, IRemoteMetadataProvider, IRemoteSearchProvider<TLookupInfoType>
  18. where TItemType : BaseItem, IHasLookupInfo<TLookupInfoType>
  19. where TLookupInfoType : ItemLookupInfo, new()
  20. {
  21. /// <summary>
  22. /// Gets the metadata for a specific LookupInfoType.
  23. /// </summary>
  24. /// <param name="info">The LookupInfoType to get metadata for.</param>
  25. /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
  26. /// <returns>A task returning a MetadataResult for the specific LookupInfoType.</returns>
  27. Task<MetadataResult<TItemType>> GetMetadata(TLookupInfoType info, CancellationToken cancellationToken);
  28. }
  29. /// <summary>
  30. /// Interface IRemoteMetadataProvider.
  31. /// </summary>
  32. public interface IRemoteSearchProvider<in TLookupInfoType> : IRemoteSearchProvider
  33. where TLookupInfoType : ItemLookupInfo
  34. {
  35. /// <summary>
  36. /// Gets the list of <see cref="RemoteSearchResult"/> for a specific LookupInfoType.
  37. /// </summary>
  38. /// <param name="searchInfo">The LookupInfoType to search for.</param>
  39. /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
  40. /// <returns>A task returning RemoteSearchResults for the searchInfo.</returns>
  41. Task<IEnumerable<RemoteSearchResult>> GetSearchResults(TLookupInfoType searchInfo, CancellationToken cancellationToken);
  42. }
  43. }