diff options
Diffstat (limited to 'MediaBrowser.Controller/Providers/IExternalId.cs')
| -rw-r--r-- | MediaBrowser.Controller/Providers/IExternalId.cs | 21 |
1 files changed, 16 insertions, 5 deletions
diff --git a/MediaBrowser.Controller/Providers/IExternalId.cs b/MediaBrowser.Controller/Providers/IExternalId.cs index c877ffe1f..f362c42eb 100644 --- a/MediaBrowser.Controller/Providers/IExternalId.cs +++ b/MediaBrowser.Controller/Providers/IExternalId.cs @@ -5,19 +5,30 @@ namespace MediaBrowser.Controller.Providers /// <summary>Represents and identifier for an external provider.</summary> public interface IExternalId { - /// <summary>Gets the name used to identify this provider</summary> + /// <summary> + /// Gets the display name of the provider associated with this ID type. + /// </summary> string Name { get; } - /// <summary>Gets the unique key to distinguish this provider/type pair. This should be unique across providers.</summary> + /// <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 at the moment. It should be updated to be unique. string Key { get; } - /// <summary>Gets the specific media type for this id.</summary> + /// <summary> + /// Gets the specific media type for this id. + /// </summary> ExternalIdMediaType Type { get; } - /// <summary>Gets the url format string for this id.</summary> + /// <summary> + /// Gets the URL format string for this id. + /// </summary> string UrlFormatString { get; } - /// <summary>Determines whether this id supports a given item type.</summary> + /// <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); |