diff --git a/MediaBrowser.Controller/Channels/ChannelItemResult.cs b/MediaBrowser.Controller/Channels/ChannelItemResult.cs
index ca7721991d..9557c91964 100644
--- a/MediaBrowser.Controller/Channels/ChannelItemResult.cs
+++ b/MediaBrowser.Controller/Channels/ChannelItemResult.cs
@@ -1,19 +1,29 @@
-#pragma warning disable CS1591
-
using System;
using System.Collections.Generic;
namespace MediaBrowser.Controller.Channels
{
+ ///
+ /// The result of a channel item query.
+ ///
public class ChannelItemResult
{
+ ///
+ /// Initializes a new instance of the class.
+ ///
public ChannelItemResult()
{
Items = Array.Empty();
}
+ ///
+ /// Gets or sets the items.
+ ///
public IReadOnlyList Items { get; set; }
+ ///
+ /// Gets or sets the total record count.
+ ///
public int? TotalRecordCount { get; set; }
}
}
diff --git a/MediaBrowser.Controller/Channels/ChannelItemType.cs b/MediaBrowser.Controller/Channels/ChannelItemType.cs
index 3ce920e236..2608cb4c88 100644
--- a/MediaBrowser.Controller/Channels/ChannelItemType.cs
+++ b/MediaBrowser.Controller/Channels/ChannelItemType.cs
@@ -1,11 +1,18 @@
-#pragma warning disable CS1591
-
namespace MediaBrowser.Controller.Channels
{
+ ///
+ /// The type of a channel item.
+ ///
public enum ChannelItemType
{
+ ///
+ /// The item is a media item.
+ ///
Media = 0,
+ ///
+ /// The item is a folder.
+ ///
Folder = 1
}
}
diff --git a/MediaBrowser.Controller/Channels/ChannelLatestMediaSearch.cs b/MediaBrowser.Controller/Channels/ChannelLatestMediaSearch.cs
index ebbe13763b..c6530814b9 100644
--- a/MediaBrowser.Controller/Channels/ChannelLatestMediaSearch.cs
+++ b/MediaBrowser.Controller/Channels/ChannelLatestMediaSearch.cs
@@ -1,11 +1,15 @@
#nullable disable
-#pragma warning disable CS1591
-
namespace MediaBrowser.Controller.Channels
{
+ ///
+ /// The request for a latest media search in a channel.
+ ///
public class ChannelLatestMediaSearch
{
+ ///
+ /// Gets or sets the user id.
+ ///
public string UserId { get; set; }
}
}
diff --git a/MediaBrowser.Controller/Channels/ChannelParentalRating.cs b/MediaBrowser.Controller/Channels/ChannelParentalRating.cs
index f77d81c166..a5a1ba5bf6 100644
--- a/MediaBrowser.Controller/Channels/ChannelParentalRating.cs
+++ b/MediaBrowser.Controller/Channels/ChannelParentalRating.cs
@@ -1,17 +1,33 @@
-#pragma warning disable CS1591
-
namespace MediaBrowser.Controller.Channels
{
+ ///
+ /// The parental rating of a channel.
+ ///
public enum ChannelParentalRating
{
+ ///
+ /// Suitable for a general audience.
+ ///
GeneralAudience = 0,
+ ///
+ /// Parental guidance suggested (US PG).
+ ///
UsPG = 1,
+ ///
+ /// Parents strongly cautioned (US PG-13).
+ ///
UsPG13 = 2,
+ ///
+ /// Restricted (US R).
+ ///
UsR = 3,
+ ///
+ /// Suitable for adults only.
+ ///
Adult = 4
}
}
diff --git a/MediaBrowser.Controller/Channels/ChannelSearchInfo.cs b/MediaBrowser.Controller/Channels/ChannelSearchInfo.cs
index 990b025bcb..d172b98b25 100644
--- a/MediaBrowser.Controller/Channels/ChannelSearchInfo.cs
+++ b/MediaBrowser.Controller/Channels/ChannelSearchInfo.cs
@@ -1,13 +1,20 @@
#nullable disable
-#pragma warning disable CS1591
-
namespace MediaBrowser.Controller.Channels
{
+ ///
+ /// The request for a search in a channel.
+ ///
public class ChannelSearchInfo
{
+ ///
+ /// Gets or sets the search term.
+ ///
public string SearchTerm { get; set; }
+ ///
+ /// Gets or sets the user id.
+ ///
public string UserId { get; set; }
}
}
diff --git a/MediaBrowser.Controller/Channels/IHasCacheKey.cs b/MediaBrowser.Controller/Channels/IHasCacheKey.cs
index 7d5207c34a..4cdda38bd9 100644
--- a/MediaBrowser.Controller/Channels/IHasCacheKey.cs
+++ b/MediaBrowser.Controller/Channels/IHasCacheKey.cs
@@ -1,14 +1,15 @@
-#pragma warning disable CS1591
-
namespace MediaBrowser.Controller.Channels
{
+ ///
+ /// Interface for channels that provide a cache key.
+ ///
public interface IHasCacheKey
{
///
/// Gets the cache key.
///
/// The user identifier.
- /// System.String.
+ /// The cache key.
string? GetCacheKey(string? userId);
}
}
diff --git a/MediaBrowser.Controller/Channels/ISupportsDelete.cs b/MediaBrowser.Controller/Channels/ISupportsDelete.cs
index 0110bfa7a3..194654ca9e 100644
--- a/MediaBrowser.Controller/Channels/ISupportsDelete.cs
+++ b/MediaBrowser.Controller/Channels/ISupportsDelete.cs
@@ -1,15 +1,27 @@
-#pragma warning disable CS1591
-
using System.Threading;
using System.Threading.Tasks;
using MediaBrowser.Controller.Entities;
namespace MediaBrowser.Controller.Channels
{
+ ///
+ /// Interface for channels that support deleting items.
+ ///
public interface ISupportsDelete
{
+ ///
+ /// Gets a value indicating whether the item can be deleted.
+ ///
+ /// The item.
+ /// true if the item can be deleted, false otherwise.
bool CanDelete(BaseItem item);
+ ///
+ /// Deletes the item with the provided id.
+ ///
+ /// The item id.
+ /// The cancellation token.
+ /// A task representing the deletion of the item.
Task DeleteItem(string id, CancellationToken cancellationToken);
}
}
diff --git a/MediaBrowser.Controller/Channels/ISupportsLatestMedia.cs b/MediaBrowser.Controller/Channels/ISupportsLatestMedia.cs
index 1935ec0f5f..82ca45d3ad 100644
--- a/MediaBrowser.Controller/Channels/ISupportsLatestMedia.cs
+++ b/MediaBrowser.Controller/Channels/ISupportsLatestMedia.cs
@@ -1,11 +1,12 @@
-#pragma warning disable CS1591
-
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
namespace MediaBrowser.Controller.Channels
{
+ ///
+ /// Interface for channels that support retrieving the latest media.
+ ///
public interface ISupportsLatestMedia
{
///