Clean up and document Permission.cs

pull/4034/head
Patrick Barron 4 years ago
parent 4a05943327
commit 617df5e0e6

@ -1,5 +1,3 @@
#pragma warning disable CS1591
using System.ComponentModel.DataAnnotations; using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema; using System.ComponentModel.DataAnnotations.Schema;
using Jellyfin.Data.Enums; using Jellyfin.Data.Enums;
@ -10,7 +8,7 @@ namespace Jellyfin.Data.Entities
/// <summary> /// <summary>
/// An entity representing whether the associated user has a specific permission. /// An entity representing whether the associated user has a specific permission.
/// </summary> /// </summary>
public partial class Permission : IHasConcurrencyToken public class Permission : IHasConcurrencyToken
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="Permission"/> class. /// Initializes a new instance of the <see cref="Permission"/> class.
@ -22,8 +20,6 @@ namespace Jellyfin.Data.Entities
{ {
Kind = kind; Kind = kind;
Value = value; Value = value;
Init();
} }
/// <summary> /// <summary>
@ -32,21 +28,14 @@ namespace Jellyfin.Data.Entities
/// </summary> /// </summary>
protected Permission() protected Permission()
{ {
Init();
} }
/*************************************************************************
* Properties
*************************************************************************/
/// <summary> /// <summary>
/// Gets or sets the id of this permission. /// Gets or sets the id of this permission.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// Identity, Indexed, Required. /// Identity, Indexed, Required.
/// </remarks> /// </remarks>
[Key]
[Required]
[DatabaseGenerated(DatabaseGeneratedOption.Identity)] [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
public int Id { get; protected set; } public int Id { get; protected set; }
@ -56,7 +45,6 @@ namespace Jellyfin.Data.Entities
/// <remarks> /// <remarks>
/// Required. /// Required.
/// </remarks> /// </remarks>
[Required]
public PermissionKind Kind { get; protected set; } public PermissionKind Kind { get; protected set; }
/// <summary> /// <summary>
@ -65,36 +53,16 @@ namespace Jellyfin.Data.Entities
/// <remarks> /// <remarks>
/// Required. /// Required.
/// </remarks> /// </remarks>
[Required]
public bool Value { get; set; } public bool Value { get; set; }
/// <summary> /// <inheritdoc />
/// Gets or sets the row version.
/// </summary>
/// <remarks>
/// Required, ConcurrencyToken.
/// </remarks>
[ConcurrencyCheck] [ConcurrencyCheck]
[Required]
public uint RowVersion { get; set; } public uint RowVersion { get; set; }
/// <summary>
/// Static create function (for use in LINQ queries, etc.)
/// </summary>
/// <param name="kind">The permission kind.</param>
/// <param name="value">The value of this permission.</param>
/// <returns>The newly created instance.</returns>
public static Permission Create(PermissionKind kind, bool value)
{
return new Permission(kind, value);
}
/// <inheritdoc/> /// <inheritdoc/>
public void OnSavingChanges() public void OnSavingChanges()
{ {
RowVersion++; RowVersion++;
} }
partial void Init();
} }
} }

Loading…
Cancel
Save