2021-05-06 18:39:20 -04:00
|
|
|
#nullable disable
|
|
|
|
|
2019-01-13 15:01:16 -05:00
|
|
|
using MediaBrowser.Model.Entities;
|
2020-05-17 15:57:24 -04:00
|
|
|
using MediaBrowser.Model.Providers;
|
2018-12-27 18:27:57 -05:00
|
|
|
|
|
|
|
namespace MediaBrowser.Controller.Providers
|
|
|
|
{
|
2020-05-17 16:24:28 -04:00
|
|
|
/// <summary>
|
|
|
|
/// Represents an identifier for an external provider.
|
|
|
|
/// </summary>
|
2018-12-27 18:27:57 -05:00
|
|
|
public interface IExternalId
|
|
|
|
{
|
2020-05-17 14:22:36 -04:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the display name of the provider associated with this ID type.
|
|
|
|
/// </summary>
|
2020-05-17 17:35:43 -04:00
|
|
|
string ProviderName { get; }
|
2018-12-27 18:27:57 -05:00
|
|
|
|
2020-05-17 14:22:36 -04:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the unique key to distinguish this provider/type pair. This should be unique across providers.
|
|
|
|
/// </summary>
|
2020-05-17 16:24:28 -04:00
|
|
|
// TODO: This property is not actually unique across the concrete types at the moment. It should be updated to be unique.
|
2018-12-27 18:27:57 -05:00
|
|
|
string Key { get; }
|
|
|
|
|
2020-05-17 14:22:36 -04:00
|
|
|
/// <summary>
|
2020-05-17 16:24:28 -04:00
|
|
|
/// Gets the specific media type for this id. This is used to distinguish between the different
|
|
|
|
/// external id types for providers with multiple ids.
|
2020-05-23 16:08:51 -04:00
|
|
|
/// A null value indicates there is no specific media type associated with the external id, or this is the
|
|
|
|
/// default id for the external provider so there is no need to specify a type.
|
2020-05-17 14:22:36 -04:00
|
|
|
/// </summary>
|
2020-05-17 15:59:13 -04:00
|
|
|
/// <remarks>
|
2020-05-17 17:35:43 -04:00
|
|
|
/// This can be used along with the <see cref="ProviderName"/> to localize the external id on the client.
|
2020-05-17 15:59:13 -04:00
|
|
|
/// </remarks>
|
2020-05-23 16:08:51 -04:00
|
|
|
ExternalIdMediaType? Type { get; }
|
2020-03-22 15:58:53 -04:00
|
|
|
|
2020-05-17 14:22:36 -04:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the URL format string for this id.
|
|
|
|
/// </summary>
|
2018-12-27 18:27:57 -05:00
|
|
|
string UrlFormatString { get; }
|
|
|
|
|
2020-05-17 14:22:36 -04:00
|
|
|
/// <summary>
|
|
|
|
/// Determines whether this id supports a given item type.
|
|
|
|
/// </summary>
|
2020-03-26 17:26:12 -04:00
|
|
|
/// <param name="item">The item.</param>
|
|
|
|
/// <returns>True if this item is supported, otherwise false.</returns>
|
2018-12-27 18:27:57 -05:00
|
|
|
bool Supports(IHasProviderIds item);
|
|
|
|
}
|
|
|
|
}
|