@rxap/authorization
Version:
Provides an Angular module and directives to manage authorization and permissions in your application. It allows you to control the visibility and enabled state of UI elements based on user permissions. The package includes an `AuthorizationService` to ch
152 lines (76 loc) • 3.39 kB
Markdown
[@rxap/authorization](../wiki/globals) / AuthorizationService
# Class: AuthorizationService
Defined in: [authorization.service.ts:18](https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/authorization/src/lib/authorization.service.ts#L18)
## Constructors
### new AuthorizationService()
> **new AuthorizationService**(): [`AuthorizationService`](../wiki/Class.AuthorizationService)
#### Returns
[`AuthorizationService`](../wiki/Class.AuthorizationService)
## Properties
### disabled
> `readonly` **disabled**: `boolean`
Defined in: [authorization.service.ts:22](https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/authorization/src/lib/authorization.service.ts#L22)
***
### permissions$
> `protected` `readonly` **permissions$**: `BehaviorSubject`\<`string`[]\>
Defined in: [authorization.service.ts:20](https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/authorization/src/lib/authorization.service.ts#L20)
## Methods
### checkPermission()
> **checkPermission**(`identifier`, `permissions`, `scope`?): `boolean`
Defined in: [authorization.service.ts:28](https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/authorization/src/lib/authorization.service.ts#L28)
#### Parameters
##### identifier
`string` | `string`[]
##### permissions
`string`[]
##### scope?
`null` | `string`
#### Returns
`boolean`
***
### getPermissions()
> **getPermissions**(): `string`[]
Defined in: [authorization.service.ts:130](https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/authorization/src/lib/authorization.service.ts#L130)
#### Returns
`string`[]
***
### getPermissions$()
> **getPermissions$**(): `Observable`\<`string`[]\>
Defined in: [authorization.service.ts:126](https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/authorization/src/lib/authorization.service.ts#L126)
#### Returns
`Observable`\<`string`[]\>
***
### hasPermission()
> **hasPermission**(`identifier`, `scope`?, `ignorePermissionList`?): `boolean`
Defined in: [authorization.service.ts:113](https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/authorization/src/lib/authorization.service.ts#L113)
#### Parameters
##### identifier
`string` | `string`[]
##### scope?
`null` | `string`
##### ignorePermissionList?
`string`[]
#### Returns
`boolean`
***
### hasPermission$()
> **hasPermission$**(`identifier`, `scope`?, `ignorePermissionList`?): `Observable`\<`boolean`\>
Defined in: [authorization.service.ts:97](https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/authorization/src/lib/authorization.service.ts#L97)
#### Parameters
##### identifier
`string` | `string`[]
##### scope?
`null` | `string`
##### ignorePermissionList?
`string`[]
#### Returns
`Observable`\<`boolean`\>
***
### setPermissions()
> **setPermissions**(`permissions`): `void`
Defined in: [authorization.service.ts:24](https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/authorization/src/lib/authorization.service.ts#L24)
#### Parameters
##### permissions
`string`[]
#### Returns
`void`