aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Controller/LiveTv/ISchedulesDirectService.cs
diff options
context:
space:
mode:
Diffstat (limited to 'MediaBrowser.Controller/LiveTv/ISchedulesDirectService.cs')
-rw-r--r--MediaBrowser.Controller/LiveTv/ISchedulesDirectService.cs31
1 files changed, 31 insertions, 0 deletions
diff --git a/MediaBrowser.Controller/LiveTv/ISchedulesDirectService.cs b/MediaBrowser.Controller/LiveTv/ISchedulesDirectService.cs
new file mode 100644
index 0000000000..6953650952
--- /dev/null
+++ b/MediaBrowser.Controller/LiveTv/ISchedulesDirectService.cs
@@ -0,0 +1,31 @@
+using System.IO;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace MediaBrowser.Controller.LiveTv;
+
+/// <summary>
+/// Provides Schedules Direct specific operations.
+/// </summary>
+public interface ISchedulesDirectService
+{
+ /// <summary>
+ /// Gets the available countries from the Schedules Direct API, using a file cache.
+ /// </summary>
+ /// <param name="cancellationToken">The cancellation token.</param>
+ /// <returns>A stream containing the raw JSON response.</returns>
+ Task<Stream> GetAvailableCountries(CancellationToken cancellationToken);
+
+ /// <summary>
+ /// Gets a value indicating whether the Schedules Direct daily image download limit is currently active.
+ /// </summary>
+ /// <returns><c>true</c> if the image limit has been hit and has not yet reset; otherwise <c>false</c>.</returns>
+ bool IsImageDailyLimitActive();
+
+ /// <summary>
+ /// Gets a value indicating whether the Schedules Direct service is available.
+ /// Returns <c>false</c> if a permanent account error has occurred or a transient backoff is active.
+ /// </summary>
+ /// <returns><c>true</c> if the service can accept requests; otherwise <c>false</c>.</returns>
+ bool IsServiceAvailable();
+}