Add documentation around Name, Id, and Type. Changed ExternalIdType to ExternalIdMediaType

This commit is contained in:
Luke Foust
2020-03-26 14:26:12 -07:00
parent ae4e727b24
commit 0fb78cf54b
13 changed files with 84 additions and 49 deletions

View File

@@ -1,31 +1,30 @@
#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 name of the external id provider (IE: IMDB, MusicBrainz, etc).
/// </summary>
/// <value>The name.</value>
public string Name { get; set; }
/// <summary>
/// Gets or sets the key.
/// Gets or sets the unique key for this id. This key should be unique across all providers.
/// </summary>
/// <value>The key.</value>
public string Key { get; set; }
/// <summary>
/// Gets or sets the type.
/// Gets or sets the media type (Album, Artist, etc).
/// This can be null if there is no specific type.
/// This string is also used to localize the media type on the client.
/// </summary>
/// <value>The type.</value>
public string Type { get; set; }
/// <summary>
/// Gets or sets the URL format string.
/// </summary>
/// <value>The URL format string.</value>
public string UrlFormatString { get; set; }
}
}