Document most models

This commit is contained in:
ijungleboy
2021-05-21 18:28:21 +02:00
parent e4b12aa87f
commit 074b998bbc
17 changed files with 696 additions and 18 deletions

View File

@ -1,19 +1,49 @@
using System;
using System;
namespace Oqtane.Models
{
/// <summary>
/// Describes a Security Role in Oqtane.
/// </summary>
public class Role : IAuditable
{
/// <summary>
/// Primary ID
/// </summary>
public int RoleId { get; set; }
/// <summary>
/// Reference to a <see cref="Site"/> if applicable.
/// </summary>
public int? SiteId { get; set; }
/// <summary>
/// Role name to show in Admin dialogs.
/// </summary>
public string Name { get; set; }
/// <summary>
/// Brief description for Admin dialogs.
/// </summary>
public string Description { get; set; }
/// <summary>
/// Determines if users automatically get assigned to this role.
/// </summary>
public bool IsAutoAssigned { get; set; }
public bool IsSystem { get; set; }
#region IAuditable Properties
/// <inheritdoc/>
public string CreatedBy { get; set; }
/// <inheritdoc/>
public DateTime CreatedOn { get; set; }
/// <inheritdoc/>
public string ModifiedBy { get; set; }
/// <inheritdoc/>
public DateTime ModifiedOn { get; set; }
#endregion
}
}