jellyfin/MediaBrowser.Model/Providers/ExternalIdInfo.cs

37 lines
1.5 KiB
C#
Raw Normal View History

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