Merge pull request #3137 from mark-monteiro/external-id-type
Correctly Support Translating External Idspull/3461/head
Bond-009
5 years ago
committed by
GitHub
commit
73da8df4bf
@ -1,15 +1,45 @@
|
||||
using MediaBrowser.Model.Entities;
|
||||
using MediaBrowser.Model.Providers;
|
||||
|
||||
namespace MediaBrowser.Controller.Providers
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents an identifier for an external provider.
|
||||
/// </summary>
|
||||
public interface IExternalId
|
||||
{
|
||||
string Name { get; }
|
||||
/// <summary>
|
||||
/// Gets the display name of the provider associated with this ID type.
|
||||
/// </summary>
|
||||
string ProviderName { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the unique key to distinguish this provider/type pair. This should be unique across providers.
|
||||
/// </summary>
|
||||
// TODO: This property is not actually unique across the concrete types at the moment. It should be updated to be unique.
|
||||
string Key { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the specific media type for this id. This is used to distinguish between the different
|
||||
/// external id types for providers with multiple ids.
|
||||
/// 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.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This can be used along with the <see cref="ProviderName"/> to localize the external id on the client.
|
||||
/// </remarks>
|
||||
ExternalIdMediaType? Type { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the URL format string for this id.
|
||||
/// </summary>
|
||||
string UrlFormatString { get; }
|
||||
|
||||
/// <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>
|
||||
bool Supports(IHasProviderIds item);
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,26 +1,36 @@
|
||||
#nullable disable
|
||||
#pragma warning disable CS1591
|
||||
|
||||
namespace MediaBrowser.Model.Providers
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents the external id information for serialization to the client.
|
||||
/// </summary>
|
||||
public class ExternalIdInfo
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets the name.
|
||||
/// Gets or sets the display name of the external id provider (IE: IMDB, MusicBrainz, etc).
|
||||
/// </summary>
|
||||
// TODO: This should be renamed to ProviderName
|
||||
public string? Name { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the unique key for this id. This key should be unique across all providers.
|
||||
/// </summary>
|
||||
/// <value>The name.</value>
|
||||
public string Name { get; set; }
|
||||
// TODO: This property is not actually unique across the concrete types at the moment. It should be updated to be unique.
|
||||
public string? Key { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the key.
|
||||
/// Gets or sets the specific media type for this id. This is used to distinguish between the different
|
||||
/// external id types for providers with multiple ids.
|
||||
/// 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.
|
||||
/// </summary>
|
||||
/// <value>The key.</value>
|
||||
public string Key { get; set; }
|
||||
/// <remarks>
|
||||
/// This can be used along with the <see cref="Name"/> to localize the external id on the client.
|
||||
/// </remarks>
|
||||
public ExternalIdMediaType? Type { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the URL format string.
|
||||
/// </summary>
|
||||
/// <value>The URL format string.</value>
|
||||
public string UrlFormatString { get; set; }
|
||||
public string? UrlFormatString { get; set; }
|
||||
}
|
||||
}
|
||||
|
||||
@ -0,0 +1,71 @@
|
||||
namespace MediaBrowser.Model.Providers
|
||||
{
|
||||
/// <summary>
|
||||
/// The specific media type of an <see cref="ExternalIdInfo"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Client applications may use this as a translation key.
|
||||
/// </remarks>
|
||||
public enum ExternalIdMediaType
|
||||
{
|
||||
/// <summary>
|
||||
/// A music album.
|
||||
/// </summary>
|
||||
Album = 1,
|
||||
|
||||
/// <summary>
|
||||
/// The artist of a music album.
|
||||
/// </summary>
|
||||
AlbumArtist = 2,
|
||||
|
||||
/// <summary>
|
||||
/// The artist of a media item.
|
||||
/// </summary>
|
||||
Artist = 3,
|
||||
|
||||
/// <summary>
|
||||
/// A boxed set of media.
|
||||
/// </summary>
|
||||
BoxSet = 4,
|
||||
|
||||
/// <summary>
|
||||
/// A series episode.
|
||||
/// </summary>
|
||||
Episode = 5,
|
||||
|
||||
/// <summary>
|
||||
/// A movie.
|
||||
/// </summary>
|
||||
Movie = 6,
|
||||
|
||||
/// <summary>
|
||||
/// An alternative artist apart from the main artist.
|
||||
/// </summary>
|
||||
OtherArtist = 7,
|
||||
|
||||
/// <summary>
|
||||
/// A person.
|
||||
/// </summary>
|
||||
Person = 8,
|
||||
|
||||
/// <summary>
|
||||
/// A release group.
|
||||
/// </summary>
|
||||
ReleaseGroup = 9,
|
||||
|
||||
/// <summary>
|
||||
/// A single season of a series.
|
||||
/// </summary>
|
||||
Season = 10,
|
||||
|
||||
/// <summary>
|
||||
/// A series.
|
||||
/// </summary>
|
||||
Series = 11,
|
||||
|
||||
/// <summary>
|
||||
/// A music track.
|
||||
/// </summary>
|
||||
Track = 12
|
||||
}
|
||||
}
|
||||
Loading…
Reference in new issue