inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation update 3.6.0 (#5257)

Browse Source 
* documentation update 3.6.0

* documentation update 3.6.0

* update missing doc
This commit is contained in:
Eugenio Romano
2019-11-18 12:34:28 +00:00
committed by GitHub
parent 7ca2f5d1e9
commit a6ad7a5ad0
113 changed files with 421 additions and 374 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/core/services/jwt-helper.service.md
View File

@@ -20,13 +20,38 @@ Decodes a JSON Web Token (JWT) to a JavaScript object.
- **getAccessToken**(): `string`<br/>
Gets access token
- **Returns** `string` - access token
- **getClientRoles**(clientName: `string`): `string[]`<br/>
Gets Client roles.
- _clientName:_ `string` -
- **Returns** `string[]` - Array of client roles
- **getRealmRoles**(): `string[]`<br/>
Gets realm roles.
- **Returns** `string[]` - Array of realm roles
- **getValueFromLocalAccessToken**(key: `string`)<br/>
Gets a named value from the user access token.
- _key:_ `string` - Key name of the field to retrieve
- **getValueFromToken**(accessToken: `string`, key: `string`)<br/>
Gets a named value from the user access token.
- _accessToken:_ `string` -
- _key:_ `string` -
- _key:_ `string` -
- **hasClientRole**(clientName: `string`, role: `string`): `boolean`<br/>
Checks for client role.
- _clientName:_ `string` - Targeted client name
- _role:_ `string` - Role name to check
- **Returns** `boolean` - True if it contains given role, false otherwise
- **hasRealmRole**(role: `string`): `boolean`<br/>
Checks for single realm role.
- _role:_ `string` - Role name to check
- **Returns** `boolean` - True if it contains given role, false otherwise
- **hasRealmRoles**(rolesToCheck: `string[]`): `boolean`<br/>
Checks for realm roles.
- _rolesToCheck:_ `string[]` - List of role names to check
- **Returns** `boolean` - True if it contains at least one of the given roles, false otherwise
- **hasRealmRolesForClientRole**(clientName: `string`, rolesToCheck: `string[]`): `boolean`<br/>
Checks for client roles.
- _clientName:_ `string` - Targeted client name
- _rolesToCheck:_ `string[]` - List of role names to check
- **Returns** `boolean` - True if it contains at least one of the given roles, false otherwise
## Details