Browse Source

Merge pull request #11350 from abpframework/EngincanV/permission-definition-summaries

Add summaries to methods for IPermissionDefinitionContext
pull/11365/head
maliming 4 years ago
committed by GitHub
parent
commit
a03339e56d
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 20
      framework/src/Volo.Abp.Authorization.Abstractions/Volo/Abp/Authorization/Permissions/IPermissionDefinitionContext.cs

20
framework/src/Volo.Abp.Authorization.Abstractions/Volo/Abp/Authorization/Permissions/IPermissionDefinitionContext.cs

@ -25,17 +25,33 @@ public interface IPermissionDefinitionContext
/// </summary> /// </summary>
/// <param name="name">Name of the group</param> /// <param name="name">Name of the group</param>
/// <returns></returns> /// <returns></returns>
[NotNull] [CanBeNull]
PermissionGroupDefinition GetGroupOrNull(string name); PermissionGroupDefinition GetGroupOrNull(string name);
[CanBeNull] /// <summary>
/// Tries to add a new permission group.
/// Throws <see cref="AbpException"/> if there is a group with the name.
/// <param name="name">Name of the group</param>
/// <param name="displayName">Localized display name of the group</param>
/// <param name="multiTenancySide">Select a multi-tenancy side</param>
/// </summary>
PermissionGroupDefinition AddGroup( PermissionGroupDefinition AddGroup(
[NotNull] string name, [NotNull] string name,
ILocalizableString displayName = null, ILocalizableString displayName = null,
MultiTenancySides multiTenancySide = MultiTenancySides.Both); MultiTenancySides multiTenancySide = MultiTenancySides.Both);
/// <summary>
/// Tries to remove a permission group.
/// Throws <see cref="AbpException"/> if there is not any group with the name.
/// <param name="name">Name of the group</param>
/// </summary>
void RemoveGroup(string name); void RemoveGroup(string name);
/// <summary>
/// Tries to get a pre-defined permission group.
/// Returns null if can not find the given group.
/// <param name="name">Name of the group</param>
/// </summary>
[CanBeNull] [CanBeNull]
PermissionDefinition GetPermissionOrNull([NotNull] string name); PermissionDefinition GetPermissionOrNull([NotNull] string name);
} }

Loading…
Cancel
Save