mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-4249] Updates for doc review (#4454)
* [ADF-4249] Updates for doc review * [ADF-4249] Clarified text slightly
This commit is contained in:
committed by
Eugenio Romano
parent
34b5c5a1b3
commit
7fe066b068
@@ -2,7 +2,7 @@
|
||||
Title: About Component
|
||||
Added: v2.4.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2018-11-14
|
||||
Last reviewed: 2019-03-19
|
||||
---
|
||||
|
||||
# [About Component](../../../lib/core/about/about.component.ts "Defined in about.component.ts")
|
||||
@@ -10,33 +10,38 @@ Last reviewed: 2018-11-14
|
||||
Shows a general version and status overview of the installed ADF library.
|
||||
|
||||
## Basic Usage
|
||||
|
||||
With default input values
|
||||
|
||||
```html
|
||||
<adf-about></adf-about>
|
||||
```
|
||||
|
||||
With custom input values:
|
||||
|
||||
```html
|
||||
<adf-about
|
||||
githubUrlCommitAlpha="https://githubcom/Alfresco/alfresco-ng2-components/commits/"
|
||||
githubUrlCommitAlpha="https://github.com/Alfresco/alfresco-ng2-components/commits/"
|
||||
showExtensions="false"
|
||||
regexp="^(@alfresco)"
|
||||
></adf-about>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| githubUrlCommitAlpha | `string` | https://githubcom/Alfresco/alfresco-ng2-components/commits/ | Version of ADF to be used |
|
||||
| showExtensions | `boolean` | true | Parameter for hide or show extensions block |
|
||||
| regexp | `string` | ^(@alfresco) | Regular expression for filtering dependencies packages |
|
||||
| githubUrlCommitAlpha | `string` | | Commit corresponding to the version of ADF to be used. |
|
||||
| regexp | `string` | "^(@alfresco)" | Regular expression for filtering dependencies packages. |
|
||||
| showExtensions | `boolean` | true | Toggles showing/hiding of extensions block. |
|
||||
|
||||
## Details
|
||||
|
||||
Use this component to get a general overview of the version of ADF installed and the status of the [Content service](../services/content.service.md) and [Process service](../../process-services/services/process.service.md).
|
||||
|
||||
Note at the moment this component is mostly for internal use and it requires you to:
|
||||
Note that at the moment this component is mostly for internal use and it requires you to:
|
||||
|
||||
- create a version file : `npm list --depth=0 --json=true --prod=true > versions.json`
|
||||
- provide this version file in the `dist` folder
|
||||
|
@@ -2,11 +2,12 @@
|
||||
Title: Auth Guard SSO Role service
|
||||
Added: v3.1.0
|
||||
Status: Active
|
||||
Last reviewed: 2019-03-19
|
||||
---
|
||||
|
||||
# [Auth Guard SSO role service](../../../lib/core/services/auth-guard-sso-role.service.ts "Defined in auth-guard-sso-role.service.ts")
|
||||
|
||||
Allow to check the user roles of a user
|
||||
Checks the user roles of a user.
|
||||
|
||||
## Details
|
||||
|
||||
@@ -28,11 +29,11 @@ const appRoutes: Routes = [
|
||||
]
|
||||
```
|
||||
|
||||
If the user now clicks on a link or button that follows this route, they will be not able to access to this content if the user does not have the roles.
|
||||
If the user now clicks on a link or button that follows this route, they will be not able to access this content if they do not have the roles.
|
||||
|
||||
## Redirect over forbidden
|
||||
|
||||
If the you want to redirect the user to a different page over a forbidden error you can use the **redirectUrl** as the example below:
|
||||
If the you want to redirect the user to a page after a forbidden access, you can use the **redirectUrl** as in the example below:
|
||||
|
||||
```ts
|
||||
const appRoutes: Routes = [
|
||||
@@ -47,7 +48,7 @@ const appRoutes: Routes = [
|
||||
]
|
||||
```
|
||||
|
||||
Note: you can use this Guard in and with the other ADF auth guard.
|
||||
**Note**: you can use this Guard in and with the other ADF auth guards.
|
||||
|
||||
## See also
|
||||
|
||||
|
@@ -2,7 +2,7 @@
|
||||
Title: Authentication Service
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-11-19
|
||||
Last reviewed: 2019-03-19
|
||||
---
|
||||
|
||||
# [Authentication Service](../../../lib/core/services/authentication.service.ts "Defined in authentication.service.ts")
|
||||
@@ -73,8 +73,8 @@ Provides authentication to ACS and APS.
|
||||
Checks whether the "remember me" cookie was set or not.
|
||||
- **Returns** `boolean` - True if set, false otherwise
|
||||
- **isSSODiscoveryConfigured**(): `boolean`<br/>
|
||||
Check if SSO is configured correctly
|
||||
- **Returns** `boolean` -
|
||||
Checks if SSO is configured correctly.
|
||||
- **Returns** `boolean` - True if configured correctly, false otherwise
|
||||
- **login**(username: `string`, password: `string`, rememberMe: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)`<Function>`<br/>
|
||||
Logs the user in.
|
||||
- _username:_ `string` - Username for the login
|
||||
|
@@ -2,7 +2,7 @@
|
||||
Title: Content service
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2019-02-13
|
||||
Last reviewed: 2019-03-13
|
||||
---
|
||||
|
||||
# [Content service](../../../lib/core/services/content.service.ts "Defined in content.service.ts")
|
||||
@@ -58,7 +58,7 @@ Accesses app-generated data objects via URLs and file downloads.
|
||||
- **hasPermissions**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md), permission: [`PermissionsEnum`](../../../lib/core/models/permissions.enum.ts)`|string`): `boolean`<br/>
|
||||
Checks if the user has permission on that node
|
||||
- _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) to check permissions
|
||||
- _permission:_ [`PermissionsEnum`](../../../lib/core/models/permissions.enum.ts)`|string` -
|
||||
- _permission:_ [`PermissionsEnum`](../../../lib/core/models/permissions.enum.ts)`|string` - Required permission type
|
||||
- **Returns** `boolean` - True if the user has the required permissions, false otherwise
|
||||
|
||||
## Details
|
||||
|
Reference in New Issue
Block a user