aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Controller/Channels/IChannel.cs
diff options
context:
space:
mode:
authorAndrew Rabert <ar@nullsum.net>2018-12-27 18:27:57 -0500
committerAndrew Rabert <ar@nullsum.net>2018-12-27 18:27:57 -0500
commita86b71899ec52c44ddc6c3018e8cc5e9d7ff4d62 (patch)
treea74f6ea4a8abfa1664a605d31d48bc38245ccf58 /MediaBrowser.Controller/Channels/IChannel.cs
parent9bac3ac616b01f67db98381feb09d34ebe821f9a (diff)
Add GPL modules
Diffstat (limited to 'MediaBrowser.Controller/Channels/IChannel.cs')
-rw-r--r--MediaBrowser.Controller/Channels/IChannel.cs76
1 files changed, 76 insertions, 0 deletions
diff --git a/MediaBrowser.Controller/Channels/IChannel.cs b/MediaBrowser.Controller/Channels/IChannel.cs
new file mode 100644
index 000000000..dc1d9b00a
--- /dev/null
+++ b/MediaBrowser.Controller/Channels/IChannel.cs
@@ -0,0 +1,76 @@
+using MediaBrowser.Controller.Providers;
+using MediaBrowser.Model.Entities;
+using System.Collections.Generic;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace MediaBrowser.Controller.Channels
+{
+ public interface IChannel
+ {
+ /// <summary>
+ /// Gets the name.
+ /// </summary>
+ /// <value>The name.</value>
+ string Name { get; }
+
+ /// <summary>
+ /// Gets the description.
+ /// </summary>
+ /// <value>The description.</value>
+ string Description { get; }
+
+ /// <summary>
+ /// Gets the data version.
+ /// </summary>
+ /// <value>The data version.</value>
+ string DataVersion { get; }
+
+ /// <summary>
+ /// Gets the home page URL.
+ /// </summary>
+ /// <value>The home page URL.</value>
+ string HomePageUrl { get; }
+
+ /// <summary>
+ /// Gets the parental rating.
+ /// </summary>
+ /// <value>The parental rating.</value>
+ ChannelParentalRating ParentalRating { get; }
+
+ /// <summary>
+ /// Gets the channel information.
+ /// </summary>
+ /// <returns>ChannelFeatures.</returns>
+ InternalChannelFeatures GetChannelFeatures();
+
+ /// <summary>
+ /// Determines whether [is enabled for] [the specified user].
+ /// </summary>
+ /// <param name="userId">The user identifier.</param>
+ /// <returns><c>true</c> if [is enabled for] [the specified user]; otherwise, <c>false</c>.</returns>
+ bool IsEnabledFor(string userId);
+
+ /// <summary>
+ /// Gets the channel items.
+ /// </summary>
+ /// <param name="query">The query.</param>
+ /// <param name="cancellationToken">The cancellation token.</param>
+ /// <returns>Task{IEnumerable{ChannelItem}}.</returns>
+ Task<ChannelItemResult> GetChannelItems(InternalChannelItemQuery query, CancellationToken cancellationToken);
+
+ /// <summary>
+ /// Gets the channel image.
+ /// </summary>
+ /// <param name="type">The type.</param>
+ /// <param name="cancellationToken">The cancellation token.</param>
+ /// <returns>Task{DynamicImageInfo}.</returns>
+ Task<DynamicImageResponse> GetChannelImage(ImageType type, CancellationToken cancellationToken);
+
+ /// <summary>
+ /// Gets the supported channel images.
+ /// </summary>
+ /// <returns>IEnumerable{ImageType}.</returns>
+ IEnumerable<ImageType> GetSupportedChannelImages();
+ }
+}