Class PermissionUtils

Hierarchy

PermissionUtils

Index

Constructors

Methods

checkPermission checkPermissionList createPermissionValueObjectArray everyPermissionAccepted getAcceptedPermissionList somePermissionAccepted

Constructors

constructor

new PermissionUtils(): PermissionUtils
Returns PermissionUtils

Methods

`Static` checkPermission

checkPermission<T>(permission: T, acceptedPermissionList: PermissionList<T>): boolean
Validate a permission against a list of permissions

Returns
true if permission is included in the permissionList
Type Parameters
- T extends string
Parameters
- permission: T
  
  The permission to check for
- acceptedPermissionList: PermissionList<T>
  
  List of permissions that are accepted
Returns boolean
- Defined in fi/hg/core/PermissionUtils.ts:69

`Static` checkPermissionList

checkPermissionList<T>(checkPermissions: PermissionList<T>, targetPermissions: PermissionList<T>): PermissionObject
Checks against multiple permissions

Returns
PermissionObject State of each permission from checkPermissions
Type Parameters
- T extends string
Parameters
- checkPermissions: PermissionList<T>
  
  List of permissions that will be included in the return object
- targetPermissions: PermissionList<T>
  
  List of permissions the target has
Returns PermissionObject
- Defined in fi/hg/core/PermissionUtils.ts:87

`Static` createPermissionValueObjectArray

createPermissionValueObjectArray<T>(showPermissions: readonly T[], enabledPermissions: readonly T[]): readonly PermissionValueObject<T>[]
Populates an array of permission value objects
Type Parameters
- T extends string
Parameters
- showPermissions: readonly T[]
- enabledPermissions: readonly T[]
Returns readonly PermissionValueObject<T>[]
- Defined in fi/hg/core/PermissionUtils.ts:151

`Static` everyPermissionAccepted

everyPermissionAccepted(permissions: PermissionObject): boolean
Verify permission object has all permissions enabled

Returns
boolean true if every permission in the permissions object matches
Parameters
- permissions: PermissionObject
Returns boolean
- Defined in fi/hg/core/PermissionUtils.ts:112

`Static` getAcceptedPermissionList

getAcceptedPermissionList<T>(permissions: PermissionObject, isPermissionKey?: TestCallbackNonStandard): PermissionList<T>
Returns
List of permissions that were enabled
Type Parameters
- T extends string = string
Parameters
- permissions: PermissionObject
- isPermissionKey: TestCallbackNonStandard = isString
Returns PermissionList<T>
- Defined in fi/hg/core/PermissionUtils.ts:124

`Static` somePermissionAccepted

somePermissionAccepted(permissions: PermissionObject): boolean
Verify permission object has some permissions enabled

Returns
boolean true if some permissions in the permissions object matches
Parameters
- permissions: PermissionObject
Returns boolean
- Defined in fi/hg/core/PermissionUtils.ts:140

Class PermissionUtils

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns PermissionUtils

Methods

Static checkPermission

Returns

Type Parameters

T extends string

Parameters

permission: T

acceptedPermissionList: PermissionList<T>

Returns boolean

Static checkPermissionList

Returns

Type Parameters

T extends string

Parameters

checkPermissions: PermissionList<T>

targetPermissions: PermissionList<T>

Returns PermissionObject

Static createPermissionValueObjectArray

Type Parameters

T extends string

Parameters

showPermissions: readonly T[]

enabledPermissions: readonly T[]

Returns readonly PermissionValueObject<T>[]

Static everyPermissionAccepted

Returns

Parameters

permissions: PermissionObject

Returns boolean

Static getAcceptedPermissionList

Returns

Type Parameters

T extends string = string

Parameters

permissions: PermissionObject

isPermissionKey: TestCallbackNonStandard = isString

Returns PermissionList<T>

Static somePermissionAccepted

Returns

Parameters

permissions: PermissionObject

Returns boolean

Settings

Member Visibility

Theme

`Static` checkPermission

`Static` checkPermissionList

`Static` createPermissionValueObjectArray

`Static` everyPermissionAccepted

`Static` getAcceptedPermissionList

`Static` somePermissionAccepted