More documentation - almost all Models done

https://github.com/oqtane/oqtane.framework/issues/1382
Should not contain any code changes, just docs
This commit is contained in:
ijungleboy
2021-05-26 00:01:22 +02:00
parent 7ec3376308
commit bcff9caf5c
16 changed files with 479 additions and 9 deletions

View File

@ -2,14 +2,45 @@ using Oqtane.Shared;
namespace Oqtane.Models
{
/// <summary>
/// Resource Objects describe a JavaScript or CSS file which is needed by the Module to work.
/// </summary>
public class Resource
{
/// <summary>
/// A <see cref="ResourceType"/> so the Interop can properly create `script` or `link` tags
/// </summary>
public ResourceType ResourceType { get; set; }
/// <summary>
/// Path to the resources.
/// </summary>
public string Url { get; set; }
/// <summary>
/// Integrity checks to increase the security of resources accessed. Especially common in CDN resources.
/// </summary>
public string Integrity { get; set; }
/// <summary>
/// Cross-Origin rules for this Resources. Usually `anonymous`
/// </summary>
public string CrossOrigin { get; set; }
/// <summary>
/// Bundle ID in case this Resource belongs to a set of Resources, which may have already been loaded using LoadJS
/// </summary>
public string Bundle { get; set; }
/// <summary>
/// Determines if the Resource is global, meaning that the entire solution uses it or just some modules.
/// TODO: VERIFY that this explanation is correct.
/// </summary>
public ResourceDeclaration Declaration { get; set; }
/// <summary>
/// If the Resource should be included in the `head` of the HTML document or the `body`
/// </summary>
public ResourceLocation Location { get; set; }
}
}