2019-01-13 13:01:16 -07:00
|
|
|
using MediaBrowser.Model.Entities;
|
2018-12-27 16:27:57 -07:00
|
|
|
|
|
|
|
namespace MediaBrowser.Controller.Providers
|
|
|
|
{
|
2020-03-26 14:26:12 -07:00
|
|
|
/// <summary>Represents and identifier for an external provider.</summary>
|
2018-12-27 16:27:57 -07:00
|
|
|
public interface IExternalId
|
|
|
|
{
|
2020-03-26 14:26:12 -07:00
|
|
|
/// <summary>Gets the name used to identify this provider</summary>
|
2018-12-27 16:27:57 -07:00
|
|
|
string Name { get; }
|
|
|
|
|
2020-03-26 14:26:12 -07:00
|
|
|
/// <summary>Gets the unique key to distinguish this provider/type pair. This should be unique across providers.</summary>
|
2018-12-27 16:27:57 -07:00
|
|
|
string Key { get; }
|
|
|
|
|
2020-03-26 14:26:12 -07:00
|
|
|
/// <summary>Gets the specific media type for this id.</summary>
|
|
|
|
ExternalIdMediaType Type { get; }
|
2020-03-22 12:58:53 -07:00
|
|
|
|
2020-03-26 14:26:12 -07:00
|
|
|
/// <summary>Gets the url format string for this id.</summary>
|
2018-12-27 16:27:57 -07:00
|
|
|
string UrlFormatString { get; }
|
|
|
|
|
2020-03-26 14:26:12 -07:00
|
|
|
/// <summary>Determines whether this id supports a given item type.</summary>
|
|
|
|
/// <param name="item">The item.</param>
|
|
|
|
/// <returns>True if this item is supported, otherwise false.</returns>
|
2018-12-27 16:27:57 -07:00
|
|
|
bool Supports(IHasProviderIds item);
|
|
|
|
}
|
|
|
|
}
|