aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Controller/Providers/IExternalId.cs
diff options
context:
space:
mode:
Diffstat (limited to 'MediaBrowser.Controller/Providers/IExternalId.cs')
-rw-r--r--MediaBrowser.Controller/Providers/IExternalId.cs27
1 files changed, 9 insertions, 18 deletions
diff --git a/MediaBrowser.Controller/Providers/IExternalId.cs b/MediaBrowser.Controller/Providers/IExternalId.cs
index 157a2076e..c877ffe1f 100644
--- a/MediaBrowser.Controller/Providers/IExternalId.cs
+++ b/MediaBrowser.Controller/Providers/IExternalId.cs
@@ -2,33 +2,24 @@ using MediaBrowser.Model.Entities;
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>
string Name { get; }
+ /// <summary>Gets the unique key to distinguish this provider/type pair. This should be unique across providers.</summary>
string Key { get; }
- ExternalIdType Type { get; }
+ /// <summary>Gets the specific media type for this id.</summary>
+ ExternalIdMediaType Type { get; }
+ /// <summary>Gets the url format string for this id.</summary>
string UrlFormatString { get; }
+ /// <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);
}
-
- public enum ExternalIdType
- {
- None,
- Album,
- AlbumArtist,
- Artist,
- BoxSet,
- Episode,
- Movie,
- OtherArtist,
- Person,
- ReleaseGroup,
- Season,
- Series,
- Track
- }
}