jellyfin/MediaBrowser.Model/Providers/ExternalIdInfo.cs

35 lines
1.3 KiB
C#
Raw Normal View History

2018-12-28 00:27:57 +01:00
namespace MediaBrowser.Model.Providers
{
/// <summary>
/// Represents the external id information for serialization to the client.
/// </summary>
2018-12-28 00:27:57 +01:00
public class ExternalIdInfo
{
/// <summary>
2020-05-17 20:22:36 +02:00
/// Gets or sets the display name of the external id provider (IE: IMDB, MusicBrainz, etc).
2018-12-28 00:27:57 +01:00
/// </summary>
2020-05-17 23:35:43 +02:00
// TODO: This should be renamed to ProviderName
2018-12-28 00:27:57 +01:00
public string Name { get; set; }
/// <summary>
/// Gets or sets the unique key for this id. This key should be unique across all providers.
2018-12-28 00:27:57 +01:00
/// </summary>
2020-05-17 22:24:28 +02:00
// TODO: This property is not actually unique across the concrete types at the moment. It should be updated to be unique.
2018-12-28 00:27:57 +01:00
public string Key { get; set; }
/// <summary>
2020-05-17 22:24:28 +02:00
/// 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.
/// </summary>
/// <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; }
2018-12-28 00:27:57 +01:00
/// <summary>
/// Gets or sets the URL format string.
/// </summary>
public string UrlFormatString { get; set; }
}
}