Document and fix warnings in Group.cs
This commit is contained in:
parent
e8b6da3cd7
commit
e72fd88913
|
@ -7,15 +7,26 @@ using Jellyfin.Data.Enums;
|
||||||
|
|
||||||
namespace Jellyfin.Data.Entities
|
namespace Jellyfin.Data.Entities
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// An entity representing a group.
|
||||||
|
/// </summary>
|
||||||
public partial class Group : IHasPermissions, ISavingChanges
|
public partial class Group : IHasPermissions, ISavingChanges
|
||||||
{
|
{
|
||||||
partial void Init();
|
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Default constructor. Protected due to required properties, but present because EF needs it.
|
/// Initializes a new instance of the <see cref="Group"/> class.
|
||||||
|
/// Public constructor with required data.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
protected Group()
|
/// <param name="name">The name of the group.</param>
|
||||||
|
public Group(string name)
|
||||||
{
|
{
|
||||||
|
if (string.IsNullOrEmpty(name))
|
||||||
|
{
|
||||||
|
throw new ArgumentNullException(nameof(name));
|
||||||
|
}
|
||||||
|
|
||||||
|
Name = name;
|
||||||
|
Id = Guid.NewGuid();
|
||||||
|
|
||||||
Permissions = new HashSet<Permission>();
|
Permissions = new HashSet<Permission>();
|
||||||
ProviderMappings = new HashSet<ProviderMapping>();
|
ProviderMappings = new HashSet<ProviderMapping>();
|
||||||
Preferences = new HashSet<Preference>();
|
Preferences = new HashSet<Preference>();
|
||||||
|
@ -24,59 +35,45 @@ namespace Jellyfin.Data.Entities
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Public constructor with required data
|
/// Initializes a new instance of the <see cref="Group"/> class.
|
||||||
|
/// Default constructor. Protected due to required properties, but present because EF needs it.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="name"></param>
|
protected Group()
|
||||||
/// <param name="user"></param>
|
|
||||||
public Group(string name, User user)
|
|
||||||
{
|
{
|
||||||
if (string.IsNullOrEmpty(name))
|
|
||||||
{
|
|
||||||
throw new ArgumentNullException(nameof(name));
|
|
||||||
}
|
|
||||||
|
|
||||||
this.Name = name;
|
|
||||||
user.Groups.Add(this);
|
|
||||||
|
|
||||||
this.Permissions = new HashSet<Permission>();
|
|
||||||
this.ProviderMappings = new HashSet<ProviderMapping>();
|
|
||||||
this.Preferences = new HashSet<Preference>();
|
|
||||||
|
|
||||||
Init();
|
Init();
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Static create function (for use in LINQ queries, etc.)
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="name"></param>
|
|
||||||
/// <param name="_user0"></param>
|
|
||||||
public static Group Create(string name, User user)
|
|
||||||
{
|
|
||||||
return new Group(name, user);
|
|
||||||
}
|
|
||||||
|
|
||||||
/*************************************************************************
|
/*************************************************************************
|
||||||
* Properties
|
* Properties
|
||||||
*************************************************************************/
|
*************************************************************************/
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Identity, Indexed, Required
|
/// Gets or sets the id of this group.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
/// <remarks>
|
||||||
|
/// Identity, Indexed, Required.
|
||||||
|
/// </remarks>
|
||||||
[Key]
|
[Key]
|
||||||
[Required]
|
[Required]
|
||||||
public Guid Id { get; protected set; }
|
public Guid Id { get; protected set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Required, Max length = 255
|
/// Gets or sets the group's name.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
/// <remarks>
|
||||||
|
/// Required, Max length = 255.
|
||||||
|
/// </remarks>
|
||||||
[Required]
|
[Required]
|
||||||
[MaxLength(255)]
|
[MaxLength(255)]
|
||||||
[StringLength(255)]
|
[StringLength(255)]
|
||||||
public string Name { get; set; }
|
public string Name { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Required, ConcurrenyToken
|
/// Gets or sets the row version.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
/// <remarks>
|
||||||
|
/// Required, Concurrency Token.
|
||||||
|
/// </remarks>
|
||||||
[ConcurrencyCheck]
|
[ConcurrencyCheck]
|
||||||
[Required]
|
[Required]
|
||||||
public uint RowVersion { get; set; }
|
public uint RowVersion { get; set; }
|
||||||
|
@ -99,14 +96,27 @@ namespace Jellyfin.Data.Entities
|
||||||
[ForeignKey("Preference_Preferences_Id")]
|
[ForeignKey("Preference_Preferences_Id")]
|
||||||
public virtual ICollection<Preference> Preferences { get; protected set; }
|
public virtual ICollection<Preference> Preferences { get; protected set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Static create function (for use in LINQ queries, etc.)
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="name">The name of this group</param>
|
||||||
|
public static Group Create(string name)
|
||||||
|
{
|
||||||
|
return new Group(name);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <inheritdoc/>
|
||||||
public bool HasPermission(PermissionKind kind)
|
public bool HasPermission(PermissionKind kind)
|
||||||
{
|
{
|
||||||
return Permissions.First(p => p.Kind == kind).Value;
|
return Permissions.First(p => p.Kind == kind).Value;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <inheritdoc/>
|
||||||
public void SetPermission(PermissionKind kind, bool value)
|
public void SetPermission(PermissionKind kind, bool value)
|
||||||
{
|
{
|
||||||
Permissions.First(p => p.Kind == kind).Value = value;
|
Permissions.First(p => p.Kind == kind).Value = value;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
partial void Init();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue
Block a user