| | | 1 | | namespace MediaBrowser.Model.Providers |
| | | 2 | | { |
| | | 3 | | /// <summary> |
| | | 4 | | /// Represents the external id information for serialization to the client. |
| | | 5 | | /// </summary> |
| | | 6 | | public class ExternalIdInfo |
| | | 7 | | { |
| | | 8 | | /// <summary> |
| | | 9 | | /// Initializes a new instance of the <see cref="ExternalIdInfo"/> class. |
| | | 10 | | /// </summary> |
| | | 11 | | /// <param name="name">Name of the external id provider (IE: IMDB, MusicBrainz, etc).</param> |
| | | 12 | | /// <param name="key">Key for this id. This key should be unique across all providers.</param> |
| | | 13 | | /// <param name="type">Specific media type for this id.</param> |
| | | 14 | | public ExternalIdInfo(string name, string key, ExternalIdMediaType? type) |
| | | 15 | | { |
| | 20 | 16 | | Name = name; |
| | 20 | 17 | | Key = key; |
| | 20 | 18 | | Type = type; |
| | 20 | 19 | | } |
| | | 20 | | |
| | | 21 | | /// <summary> |
| | | 22 | | /// Gets or sets the display name of the external id provider (IE: IMDB, MusicBrainz, etc). |
| | | 23 | | /// </summary> |
| | | 24 | | // TODO: This should be renamed to ProviderName |
| | | 25 | | public string Name { get; set; } |
| | | 26 | | |
| | | 27 | | /// <summary> |
| | | 28 | | /// Gets or sets the unique key for this id. This key should be unique across all providers. |
| | | 29 | | /// </summary> |
| | | 30 | | // TODO: This property is not actually unique across the concrete types at the moment. It should be updated to b |
| | | 31 | | public string Key { get; set; } |
| | | 32 | | |
| | | 33 | | /// <summary> |
| | | 34 | | /// Gets or sets the specific media type for this id. This is used to distinguish between the different |
| | | 35 | | /// external id types for providers with multiple ids. |
| | | 36 | | /// A null value indicates there is no specific media type associated with the external id, or this is the |
| | | 37 | | /// default id for the external provider so there is no need to specify a type. |
| | | 38 | | /// </summary> |
| | | 39 | | /// <remarks> |
| | | 40 | | /// This can be used along with the <see cref="Name"/> to localize the external id on the client. |
| | | 41 | | /// </remarks> |
| | | 42 | | public ExternalIdMediaType? Type { get; set; } |
| | | 43 | | } |
| | | 44 | | } |