Abp.Zero.xml 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Abp.Zero</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Abp.Authorization.PermissionChecker`2">
  8. <summary>
  9. Application should inherit this class to implement <see cref="T:Abp.Authorization.IPermissionChecker"/>.
  10. </summary>
  11. <typeparam name="TRole"></typeparam>
  12. <typeparam name="TUser"></typeparam>
  13. </member>
  14. <member name="M:Abp.Authorization.PermissionChecker`2.#ctor(Abp.Authorization.Users.AbpUserManager{`0,`1})">
  15. <summary>
  16. Constructor.
  17. </summary>
  18. </member>
  19. <member name="T:Abp.Authorization.Roles.AbpRole`1">
  20. <summary>
  21. Represents a role in an application. A role is used to group permissions.
  22. </summary>
  23. <remarks>
  24. Application should use permissions to check if user is granted to perform an operation.
  25. Checking 'if a user has a role' is not possible until the role is static (<see cref="P:Abp.Authorization.Roles.AbpRoleBase.IsStatic"/>).
  26. Static roles can be used in the code and can not be deleted by users.
  27. Non-static (dynamic) roles can be added/removed by users and we can not know their name while coding.
  28. A user can have multiple roles. Thus, user will have all permissions of all assigned roles.
  29. </remarks>
  30. </member>
  31. <member name="P:Abp.Authorization.Roles.AbpRole`1.NormalizedName">
  32. <summary>
  33. Unique name of this role.
  34. </summary>
  35. </member>
  36. <member name="M:Abp.Authorization.Roles.AbpRole`1.#ctor(System.Nullable{System.Int32},System.String)">
  37. <summary>
  38. Creates a new <see cref="T:Abp.Authorization.Roles.AbpRole`1"/> object.
  39. </summary>
  40. <param name="tenantId">TenantId or null (if this is not a tenant-level role)</param>
  41. <param name="displayName">Display name of the role</param>
  42. </member>
  43. <member name="M:Abp.Authorization.Roles.AbpRole`1.#ctor(System.Nullable{System.Int32},System.String,System.String)">
  44. <summary>
  45. Creates a new <see cref="T:Abp.Authorization.Roles.AbpRole`1"/> object.
  46. </summary>
  47. <param name="tenantId">TenantId or null (if this is not a tenant-level role)</param>
  48. <param name="name">Unique role name</param>
  49. <param name="displayName">Display name of the role</param>
  50. </member>
  51. <member name="T:Abp.Authorization.Roles.AbpRoleManager`2">
  52. <summary>
  53. Extends <see cref="T:Microsoft.AspNet.Identity.RoleManager`2"/> of ASP.NET Identity Framework.
  54. Applications should derive this class with appropriate generic arguments.
  55. </summary>
  56. </member>
  57. <member name="M:Abp.Authorization.Roles.AbpRoleManager`2.#ctor(Abp.Authorization.Roles.AbpRoleStore{`0,`1},Abp.Authorization.IPermissionManager,Abp.Zero.Configuration.IRoleManagementConfig,Abp.Runtime.Caching.ICacheManager,Abp.Domain.Uow.IUnitOfWorkManager,Abp.Domain.Repositories.IRepository{Abp.Organizations.OrganizationUnit,System.Int64},Abp.Domain.Repositories.IRepository{Abp.Organizations.OrganizationUnitRole,System.Int64})">
  58. <summary>
  59. Constructor.
  60. </summary>
  61. </member>
  62. <member name="M:Abp.Authorization.Roles.AbpRoleManager`2.IsGrantedAsync(System.String,System.String)">
  63. <summary>
  64. Checks if a role is granted for a permission.
  65. </summary>
  66. <param name="roleName">The role's name to check it's permission</param>
  67. <param name="permissionName">Name of the permission</param>
  68. <returns>True, if the role has the permission</returns>
  69. </member>
  70. <member name="M:Abp.Authorization.Roles.AbpRoleManager`2.IsGrantedAsync(System.Int32,System.String)">
  71. <summary>
  72. Checks if a role has a permission.
  73. </summary>
  74. <param name="roleId">The role's id to check it's permission</param>
  75. <param name="permissionName">Name of the permission</param>
  76. <returns>True, if the role has the permission</returns>
  77. </member>
  78. <member name="M:Abp.Authorization.Roles.AbpRoleManager`2.IsGrantedAsync(`0,Abp.Authorization.Permission)">
  79. <summary>
  80. Checks if a role is granted for a permission.
  81. </summary>
  82. <param name="role">The role</param>
  83. <param name="permission">The permission</param>
  84. <returns>True, if the role has the permission</returns>
  85. </member>
  86. <member name="M:Abp.Authorization.Roles.AbpRoleManager`2.IsGrantedAsync(System.Int32,Abp.Authorization.Permission)">
  87. <summary>
  88. Checks if a role is granted for a permission.
  89. </summary>
  90. <param name="roleId">role id</param>
  91. <param name="permission">The permission</param>
  92. <returns>True, if the role has the permission</returns>
  93. </member>
  94. <member name="M:Abp.Authorization.Roles.AbpRoleManager`2.GetGrantedPermissionsAsync(System.Int32)">
  95. <summary>
  96. Gets granted permission names for a role.
  97. </summary>
  98. <param name="roleId">Role id</param>
  99. <returns>List of granted permissions</returns>
  100. </member>
  101. <member name="M:Abp.Authorization.Roles.AbpRoleManager`2.GetGrantedPermissionsAsync(System.String)">
  102. <summary>
  103. Gets granted permission names for a role.
  104. </summary>
  105. <param name="roleName">Role name</param>
  106. <returns>List of granted permissions</returns>
  107. </member>
  108. <member name="M:Abp.Authorization.Roles.AbpRoleManager`2.GetGrantedPermissionsAsync(`0)">
  109. <summary>
  110. Gets granted permissions for a role.
  111. </summary>
  112. <param name="role">Role</param>
  113. <returns>List of granted permissions</returns>
  114. </member>
  115. <member name="M:Abp.Authorization.Roles.AbpRoleManager`2.SetGrantedPermissionsAsync(System.Int32,System.Collections.Generic.IEnumerable{Abp.Authorization.Permission})">
  116. <summary>
  117. Sets all granted permissions of a role at once.
  118. Prohibits all other permissions.
  119. </summary>
  120. <param name="roleId">Role id</param>
  121. <param name="permissions">Permissions</param>
  122. </member>
  123. <member name="M:Abp.Authorization.Roles.AbpRoleManager`2.SetGrantedPermissionsAsync(`0,System.Collections.Generic.IEnumerable{Abp.Authorization.Permission})">
  124. <summary>
  125. Sets all granted permissions of a role at once.
  126. Prohibits all other permissions.
  127. </summary>
  128. <param name="role">The role</param>
  129. <param name="permissions">Permissions</param>
  130. </member>
  131. <member name="M:Abp.Authorization.Roles.AbpRoleManager`2.GrantPermissionAsync(`0,Abp.Authorization.Permission)">
  132. <summary>
  133. Grants a permission for a role.
  134. </summary>
  135. <param name="role">Role</param>
  136. <param name="permission">Permission</param>
  137. </member>
  138. <member name="M:Abp.Authorization.Roles.AbpRoleManager`2.ProhibitPermissionAsync(`0,Abp.Authorization.Permission)">
  139. <summary>
  140. Prohibits a permission for a role.
  141. </summary>
  142. <param name="role">Role</param>
  143. <param name="permission">Permission</param>
  144. </member>
  145. <member name="M:Abp.Authorization.Roles.AbpRoleManager`2.ProhibitAllPermissionsAsync(`0)">
  146. <summary>
  147. Prohibits all permissions for a role.
  148. </summary>
  149. <param name="role">Role</param>
  150. </member>
  151. <member name="M:Abp.Authorization.Roles.AbpRoleManager`2.ResetAllPermissionsAsync(`0)">
  152. <summary>
  153. Resets all permission settings for a role.
  154. It removes all permission settings for the role.
  155. </summary>
  156. <param name="role">Role</param>
  157. </member>
  158. <member name="M:Abp.Authorization.Roles.AbpRoleManager`2.CreateAsync(`0)">
  159. <summary>
  160. Creates a role.
  161. </summary>
  162. <param name="role">Role</param>
  163. </member>
  164. <member name="M:Abp.Authorization.Roles.AbpRoleManager`2.DeleteAsync(`0)">
  165. <summary>
  166. Deletes a role.
  167. </summary>
  168. <param name="role">Role</param>
  169. </member>
  170. <member name="M:Abp.Authorization.Roles.AbpRoleManager`2.GetRoleByIdAsync(System.Int32)">
  171. <summary>
  172. Gets a role by given id.
  173. Throws exception if no role with given id.
  174. </summary>
  175. <param name="roleId">Role id</param>
  176. <returns>Role</returns>
  177. <exception cref="T:Abp.AbpException">Throws exception if no role with given id</exception>
  178. </member>
  179. <member name="M:Abp.Authorization.Roles.AbpRoleManager`2.GetRoleByNameAsync(System.String)">
  180. <summary>
  181. Gets a role by given name.
  182. Throws exception if no role with given roleName.
  183. </summary>
  184. <param name="roleName">Role name</param>
  185. <returns>Role</returns>
  186. <exception cref="T:Abp.AbpException">Throws exception if no role with given roleName</exception>
  187. </member>
  188. <member name="T:Abp.Authorization.Roles.AbpRoleStore`2">
  189. <summary>
  190. Implements 'Role Store' of ASP.NET Identity Framework.
  191. </summary>
  192. </member>
  193. <member name="M:Abp.Authorization.Roles.AbpRoleStore`2.#ctor(Abp.Domain.Repositories.IRepository{`0},Abp.Domain.Repositories.IRepository{Abp.Authorization.Users.UserRole,System.Int64},Abp.Domain.Repositories.IRepository{Abp.Authorization.Roles.RolePermissionSetting,System.Int64})">
  194. <summary>
  195. Constructor.
  196. </summary>
  197. </member>
  198. <member name="M:Abp.Authorization.Roles.AbpRoleStore`2.AddPermissionAsync(`0,Abp.Authorization.PermissionGrantInfo)">
  199. <inheritdoc/>
  200. </member>
  201. <member name="M:Abp.Authorization.Roles.AbpRoleStore`2.RemovePermissionAsync(`0,Abp.Authorization.PermissionGrantInfo)">
  202. <inheritdoc/>
  203. </member>
  204. <member name="M:Abp.Authorization.Roles.AbpRoleStore`2.GetPermissionsAsync(`0)">
  205. <inheritdoc/>
  206. </member>
  207. <member name="M:Abp.Authorization.Roles.AbpRoleStore`2.HasPermissionAsync(System.Int32,Abp.Authorization.PermissionGrantInfo)">
  208. <inheritdoc/>
  209. </member>
  210. <member name="M:Abp.Authorization.Roles.AbpRoleStore`2.RemoveAllPermissionSettingsAsync(`0)">
  211. <inheritdoc/>
  212. </member>
  213. <member name="T:Abp.Authorization.Users.AbpUser`1">
  214. <summary>
  215. Represents a user.
  216. </summary>
  217. </member>
  218. <member name="P:Abp.Authorization.Users.AbpUser`1.NormalizedUserName">
  219. <summary>
  220. User name.
  221. User name must be unique for it's tenant.
  222. </summary>
  223. </member>
  224. <member name="P:Abp.Authorization.Users.AbpUser`1.NormalizedEmailAddress">
  225. <summary>
  226. Email address of the user.
  227. Email address must be unique for it's tenant.
  228. </summary>
  229. </member>
  230. <member name="T:Abp.Authorization.Users.AbpUserManager`2">
  231. <summary>
  232. Extends <see cref="T:Microsoft.AspNet.Identity.UserManager`2"/> of ASP.NET Identity Framework.
  233. </summary>
  234. </member>
  235. <member name="M:Abp.Authorization.Users.AbpUserManager`2.IsGrantedAsync(System.Int64,System.String)">
  236. <summary>
  237. Check whether a user is granted for a permission.
  238. </summary>
  239. <param name="userId">User id</param>
  240. <param name="permissionName">Permission name</param>
  241. </member>
  242. <member name="M:Abp.Authorization.Users.AbpUserManager`2.IsGrantedAsync(`1,Abp.Authorization.Permission)">
  243. <summary>
  244. Check whether a user is granted for a permission.
  245. </summary>
  246. <param name="user">User</param>
  247. <param name="permission">Permission</param>
  248. </member>
  249. <member name="M:Abp.Authorization.Users.AbpUserManager`2.IsGrantedAsync(System.Int64,Abp.Authorization.Permission)">
  250. <summary>
  251. Check whether a user is granted for a permission.
  252. </summary>
  253. <param name="userId">User id</param>
  254. <param name="permission">Permission</param>
  255. </member>
  256. <member name="M:Abp.Authorization.Users.AbpUserManager`2.GetGrantedPermissionsAsync(`1)">
  257. <summary>
  258. Gets granted permissions for a user.
  259. </summary>
  260. <param name="user">Role</param>
  261. <returns>List of granted permissions</returns>
  262. </member>
  263. <member name="M:Abp.Authorization.Users.AbpUserManager`2.SetGrantedPermissionsAsync(`1,System.Collections.Generic.IEnumerable{Abp.Authorization.Permission})">
  264. <summary>
  265. Sets all granted permissions of a user at once.
  266. Prohibits all other permissions.
  267. </summary>
  268. <param name="user">The user</param>
  269. <param name="permissions">Permissions</param>
  270. </member>
  271. <member name="M:Abp.Authorization.Users.AbpUserManager`2.ProhibitAllPermissionsAsync(`1)">
  272. <summary>
  273. Prohibits all permissions for a user.
  274. </summary>
  275. <param name="user">User</param>
  276. </member>
  277. <member name="M:Abp.Authorization.Users.AbpUserManager`2.ResetAllPermissionsAsync(`1)">
  278. <summary>
  279. Resets all permission settings for a user.
  280. It removes all permission settings for the user.
  281. User will have permissions according to his roles.
  282. This method does not prohibit all permissions.
  283. For that, use <see cref="M:Abp.Authorization.Users.AbpUserManager`2.ProhibitAllPermissionsAsync(`1)"/>.
  284. </summary>
  285. <param name="user">User</param>
  286. </member>
  287. <member name="M:Abp.Authorization.Users.AbpUserManager`2.GrantPermissionAsync(`1,Abp.Authorization.Permission)">
  288. <summary>
  289. Grants a permission for a user if not already granted.
  290. </summary>
  291. <param name="user">User</param>
  292. <param name="permission">Permission</param>
  293. </member>
  294. <member name="M:Abp.Authorization.Users.AbpUserManager`2.ProhibitPermissionAsync(`1,Abp.Authorization.Permission)">
  295. <summary>
  296. Prohibits a permission for a user if it's granted.
  297. </summary>
  298. <param name="user">User</param>
  299. <param name="permission">Permission</param>
  300. </member>
  301. <member name="M:Abp.Authorization.Users.AbpUserManager`2.GetUserByIdAsync(System.Int64)">
  302. <summary>
  303. Gets a user by given id.
  304. Throws exception if no user found with given id.
  305. </summary>
  306. <param name="userId">User id</param>
  307. <returns>User</returns>
  308. <exception cref="T:Abp.AbpException">Throws exception if no user found with given id</exception>
  309. </member>
  310. <member name="T:Abp.Authorization.Users.AbpUserManagerExtensions">
  311. <summary>
  312. Extension methods for <see cref="T:Abp.Authorization.Users.AbpUserManager`2"/>.
  313. </summary>
  314. </member>
  315. <member name="M:Abp.Authorization.Users.AbpUserManagerExtensions.IsGranted``2(Abp.Authorization.Users.AbpUserManager{``0,``1},System.Int64,System.String)">
  316. <summary>
  317. Check whether a user is granted for a permission.
  318. </summary>
  319. <param name="manager">User manager</param>
  320. <param name="userId">User id</param>
  321. <param name="permissionName">Permission name</param>
  322. </member>
  323. <member name="T:Abp.Authorization.Users.AbpUserStore`2">
  324. <summary>
  325. Implements 'User Store' of ASP.NET Identity Framework.
  326. </summary>
  327. </member>
  328. <member name="M:Abp.Authorization.Users.AbpUserStore`2.#ctor(Abp.Domain.Repositories.IRepository{`1,System.Int64},Abp.Domain.Repositories.IRepository{Abp.Authorization.Users.UserLogin,System.Int64},Abp.Domain.Repositories.IRepository{Abp.Authorization.Users.UserRole,System.Int64},Abp.Domain.Repositories.IRepository{`0},Abp.Domain.Repositories.IRepository{Abp.Authorization.Users.UserPermissionSetting,System.Int64},Abp.Domain.Uow.IUnitOfWorkManager,Abp.Domain.Repositories.IRepository{Abp.Authorization.Users.UserClaim,System.Int64},Abp.Domain.Repositories.IRepository{Abp.Authorization.Users.UserOrganizationUnit,System.Int64},Abp.Domain.Repositories.IRepository{Abp.Organizations.OrganizationUnitRole,System.Int64})">
  329. <summary>
  330. Constructor.
  331. </summary>
  332. </member>
  333. <member name="M:Abp.Authorization.Users.AbpUserStore`2.FindByNameOrEmailAsync(System.String)">
  334. <summary>
  335. Tries to find a user with user name or email address in current tenant.
  336. </summary>
  337. <param name="userNameOrEmailAddress">User name or email address</param>
  338. <returns>User or null</returns>
  339. </member>
  340. <member name="M:Abp.Authorization.Users.AbpUserStore`2.FindByNameOrEmailAsync(System.Nullable{System.Int32},System.String)">
  341. <summary>
  342. Tries to find a user with user name or email address in given tenant.
  343. </summary>
  344. <param name="tenantId">Tenant Id</param>
  345. <param name="userNameOrEmailAddress">User name or email address</param>
  346. <returns>User or null</returns>
  347. </member>
  348. <member name="M:Abp.IdentityFramework.IdentityResultExtensions.CheckErrors(Microsoft.AspNet.Identity.IdentityResult)">
  349. <summary>
  350. Checks errors of given <see cref="T:Microsoft.AspNet.Identity.IdentityResult"/> and throws <see cref="T:Abp.UI.UserFriendlyException"/> if it's not succeeded.
  351. </summary>
  352. <param name="identityResult">Identity result to check</param>
  353. </member>
  354. <member name="M:Abp.IdentityFramework.IdentityResultExtensions.CheckErrors(Microsoft.AspNet.Identity.IdentityResult,Abp.Localization.ILocalizationManager)">
  355. <summary>
  356. Checks errors of given <see cref="T:Microsoft.AspNet.Identity.IdentityResult"/> and throws <see cref="T:Abp.UI.UserFriendlyException"/> if it's not succeeded.
  357. </summary>
  358. <param name="identityResult">Identity result to check</param>
  359. <param name="localizationManager">Localization manager to localize error messages</param>
  360. </member>
  361. </members>
  362. </doc>