aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Controller/IDisplayPreferencesManager.cs
diff options
context:
space:
mode:
authorNyanmisaka <nst799610810@gmail.com>2020-08-03 14:58:44 +0800
committerGitHub <noreply@github.com>2020-08-03 14:58:44 +0800
commitc23d991c95a45b9cb60f546c2490ca8f2a8d9dc0 (patch)
treeef1b97d10cdd078fb828a51dd87b2395305b7319 /MediaBrowser.Controller/IDisplayPreferencesManager.cs
parent7b3f76b81fd92d30ac8783508fb7b6793d32ec95 (diff)
parent47e63def20c0f3bc3d63579be7ac28cc1bf20bc2 (diff)
Merge branch 'master' into tonemap
Diffstat (limited to 'MediaBrowser.Controller/IDisplayPreferencesManager.cs')
-rw-r--r--MediaBrowser.Controller/IDisplayPreferencesManager.cs49
1 files changed, 49 insertions, 0 deletions
diff --git a/MediaBrowser.Controller/IDisplayPreferencesManager.cs b/MediaBrowser.Controller/IDisplayPreferencesManager.cs
new file mode 100644
index 000000000..b6bfed3e5
--- /dev/null
+++ b/MediaBrowser.Controller/IDisplayPreferencesManager.cs
@@ -0,0 +1,49 @@
+using System;
+using System.Collections.Generic;
+using Jellyfin.Data.Entities;
+
+namespace MediaBrowser.Controller
+{
+ /// <summary>
+ /// Manages the storage and retrieval of display preferences.
+ /// </summary>
+ public interface IDisplayPreferencesManager
+ {
+ /// <summary>
+ /// Gets the display preferences for the user and client.
+ /// </summary>
+ /// <param name="userId">The user's id.</param>
+ /// <param name="client">The client string.</param>
+ /// <returns>The associated display preferences.</returns>
+ DisplayPreferences GetDisplayPreferences(Guid userId, string client);
+
+ /// <summary>
+ /// Gets the default item display preferences for the user and client.
+ /// </summary>
+ /// <param name="userId">The user id.</param>
+ /// <param name="itemId">The item id.</param>
+ /// <param name="client">The client string.</param>
+ /// <returns>The item display preferences.</returns>
+ ItemDisplayPreferences GetItemDisplayPreferences(Guid userId, Guid itemId, string client);
+
+ /// <summary>
+ /// Gets all of the item display preferences for the user and client.
+ /// </summary>
+ /// <param name="userId">The user id.</param>
+ /// <param name="client">The client string.</param>
+ /// <returns>A list of item display preferences.</returns>
+ IList<ItemDisplayPreferences> ListItemDisplayPreferences(Guid userId, string client);
+
+ /// <summary>
+ /// Saves changes to the provided display preferences.
+ /// </summary>
+ /// <param name="preferences">The display preferences to save.</param>
+ void SaveChanges(DisplayPreferences preferences);
+
+ /// <summary>
+ /// Saves changes to the provided item display preferences.
+ /// </summary>
+ /// <param name="preferences">The item display preferences to save.</param>
+ void SaveChanges(ItemDisplayPreferences preferences);
+ }
+}