Update acl-resource.md
This commit is contained in:
parent
3a4be69fe9
commit
5ec875efb7
@ -1,57 +1,59 @@
|
|||||||
# ACLResource
|
# ACLResource
|
||||||
|
|
||||||
ACLResource,ACL 系统中的资源类。在 ACL 系统中,为用户授予权限时会自动创建对应的资源。
|
ACLResource is the resource class in ACL system. In ACL systems, the corresponding resource is created automatically when granting permission to user.
|
||||||
|
|
||||||
|
## Class Methods
|
||||||
## 类方法
|
|
||||||
|
|
||||||
### `constructor()`
|
### `constructor()`
|
||||||
构造函数
|
|
||||||
|
|
||||||
**签名**
|
Constructor.
|
||||||
|
|
||||||
|
**Signature**
|
||||||
* `constructor(options: AclResourceOptions)`
|
* `constructor(options: AclResourceOptions)`
|
||||||
|
|
||||||
**类型**
|
**Type**
|
||||||
```typescript
|
```typescript
|
||||||
type ResourceActions = { [key: string]: RoleActionParams };
|
type ResourceActions = { [key: string]: RoleActionParams };
|
||||||
|
|
||||||
interface AclResourceOptions {
|
interface AclResourceOptions {
|
||||||
name: string; // 资源名称
|
name: string; // Name of the resource
|
||||||
role: ACLRole; // 资源所属角色
|
role: ACLRole; // Role to which the resource belongs
|
||||||
actions?: ResourceActions;
|
actions?: ResourceActions;
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
**详细信息**
|
**Detailed Information**
|
||||||
|
|
||||||
`RoleActionParams`详见 [`aclRole.grantAction`](./acl-role.md#grantaction)
|
Refer to [`aclRole.grantAction`](./acl-role.md#grantaction) for details about `RoleActionParams`.
|
||||||
|
|
||||||
### `getActions()`
|
### `getActions()`
|
||||||
|
|
||||||
获取资源的所有 Action,返回结果为 `ResourceActions` 对象。
|
Get all actions of the resource, the return is `ResourceActions` object.
|
||||||
|
|
||||||
### `getAction()`
|
### `getAction()`
|
||||||
根据名称返回 Action 的参数配置,返回结果为 `RoleActionParams` 对象。
|
|
||||||
|
|
||||||
**详细信息**
|
Get the parameter configuration of the action by name, the return is `RoleActionParams` object.
|
||||||
|
|
||||||
`RoleActionParams`详见 [`aclRole.grantAction`](./acl-role.md#grantaction)
|
**Detailed Information**
|
||||||
|
|
||||||
|
Refer to [`aclRole.grantAction`](./acl-role.md#grantaction) for
|
||||||
|
`RoleActionParams`.
|
||||||
|
|
||||||
### `setAction()`
|
### `setAction()`
|
||||||
|
|
||||||
在资源内部设置一个 Action 的参数配置,返回结果为 `RoleActionParams` 对象。
|
Set the parameter configuration of an action inside the resource, the return is `RoleActionParams` object.
|
||||||
|
|
||||||
**签名**
|
**Signature**
|
||||||
* `setAction(name: string, params: RoleActionParams)`
|
* `setAction(name: string, params: RoleActionParams)`
|
||||||
|
|
||||||
**详细信息**
|
**Detailed Information**
|
||||||
|
|
||||||
* name - 要设置的 action 名称
|
* name - Name of the action to set
|
||||||
* `RoleActionParams`详见 [`aclRole.grantAction`](./acl-role.md#grantaction)
|
* Refer to [`aclRole.grantAction`](./acl-role.md#grantaction) for details about `RoleActionParams`.
|
||||||
|
|
||||||
### `setActions()`
|
### `setActions()`
|
||||||
|
|
||||||
**签名**
|
**Signature**
|
||||||
* `setActions(actions: ResourceActions)`
|
* `setActions(actions: ResourceActions)`
|
||||||
|
|
||||||
批量调用 `setAction` 的便捷方法
|
A shortcut for calling `setAction` in batches.
|
||||||
|
Loading…
Reference in New Issue
Block a user