diff --git a/Jellyfin.Data/Entities/DisplayPreferences.cs b/Jellyfin.Data/Entities/DisplayPreferences.cs
index 668030149b..928407e7a0 100644
--- a/Jellyfin.Data/Entities/DisplayPreferences.cs
+++ b/Jellyfin.Data/Entities/DisplayPreferences.cs
@@ -6,8 +6,16 @@ using Jellyfin.Data.Enums;
namespace Jellyfin.Data.Entities
{
+ ///
+ /// An entity representing a user's display preferences.
+ ///
public class DisplayPreferences
{
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ /// The client string.
+ /// The user's id.
public DisplayPreferences(string client, Guid userId)
{
RememberIndexing = false;
@@ -18,14 +26,29 @@ namespace Jellyfin.Data.Entities
HomeSections = new HashSet();
}
+ ///
+ /// Initializes a new instance of the class.
+ ///
protected DisplayPreferences()
{
}
+ ///
+ /// Gets or sets the Id.
+ ///
+ ///
+ /// Required.
+ ///
[Required]
[DatabaseGenerated(DatabaseGeneratedOption.Identity)]
public int Id { get; protected set; }
+ ///
+ /// Gets or sets the user Id.
+ ///
+ ///
+ /// Required.
+ ///
[Required]
public Guid UserId { get; set; }
@@ -38,35 +61,89 @@ namespace Jellyfin.Data.Entities
///
public Guid? ItemId { get; set; }
+ ///
+ /// Gets or sets the client string.
+ ///
+ ///
+ /// Required. Max Length = 64.
+ ///
[Required]
[MaxLength(64)]
[StringLength(64)]
public string Client { get; set; }
+ ///
+ /// Gets or sets a value indicating whether the indexing should be remembered.
+ ///
+ ///
+ /// Required.
+ ///
[Required]
public bool RememberIndexing { get; set; }
+ ///
+ /// Gets or sets a value indicating whether the sorting type should be remembered.
+ ///
+ ///
+ /// Required.
+ ///
[Required]
public bool RememberSorting { get; set; }
+ ///
+ /// Gets or sets the sort order.
+ ///
+ ///
+ /// Required.
+ ///
[Required]
public SortOrder SortOrder { get; set; }
+ ///
+ /// Gets or sets a value indicating whether to show the sidebar.
+ ///
+ ///
+ /// Required.
+ ///
[Required]
public bool ShowSidebar { get; set; }
+ ///
+ /// Gets or sets a value indicating whether to show the backdrop.
+ ///
+ ///
+ /// Required.
+ ///
[Required]
public bool ShowBackdrop { get; set; }
+ ///
+ /// Gets or sets what the view should be sorted by.
+ ///
public string SortBy { get; set; }
+ ///
+ /// Gets or sets the view type.
+ ///
public ViewType? ViewType { get; set; }
+ ///
+ /// Gets or sets the scroll direction.
+ ///
+ ///
+ /// Required.
+ ///
[Required]
public ScrollDirection ScrollDirection { get; set; }
+ ///
+ /// Gets or sets what the view should be indexed by.
+ ///
public IndexingKind? IndexBy { get; set; }
+ ///
+ /// Gets or sets the home sections.
+ ///
public virtual ICollection HomeSections { get; protected set; }
}
}