mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
review documentation (#5407)
This commit is contained in:
@@ -46,6 +46,7 @@ Defines column properties for DataTable, Tasklist, Document List and other compo
|
||||
| copyContent | `boolean` | | Enables/disables a [Clipboard directive](../../core/directives/clipboard.directive.md) to allow copying of cell contents. |
|
||||
| cssClass | `string` | | Additional CSS class to be applied to column (header and cells). |
|
||||
| editable | `boolean` | false | Toggles the editing support of the column data. |
|
||||
| focus | `boolean` | true | Enable or disable cell focus |
|
||||
| format | `string` | | Value format (if supported by the parent component), for example format of the date. |
|
||||
| formatTooltip | `Function` | | Custom tooltip formatter function. |
|
||||
| key | `string` | | Data source key. Can be either a column/property key like `title` or a property path like `createdBy.name`. |
|
||||
@@ -53,7 +54,6 @@ Defines column properties for DataTable, Tasklist, Document List and other compo
|
||||
| srTitle | `string` | | Title to be used for screen readers. |
|
||||
| title | `string` | "" | Display title of the column, typically used for column headers. You can use the i18n resource key to get it translated automatically. |
|
||||
| type | `string` | "text" | Value type for the column. Possible settings are 'text', 'image', 'date', 'fileSize', 'location', and 'json'. |
|
||||
| focus | `boolean` | "true" | Toggles keyboard focus for a column. This should be use for custom template columns that contain actions elements |
|
||||
|
||||
## Details
|
||||
|
||||
|
@@ -346,16 +346,14 @@ To enable public accessible urls, that don't need authentication, these must be
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
### Kerberos
|
||||
|
||||
The configuration for Kerberos authentication will allow users to access Alfresco products by entering their credentials only once when first logging into their Windows environment.
|
||||
|
||||
**You don't need to use the login component in order to enable Kerberos SSO in ADF**.
|
||||
**You don't need to use the [login component](../../core/components/login.component.md) in order to enable Kerberos SSO in ADF**.
|
||||
|
||||
See [Kerberos Configuration](../../../docs/user-guide/kerberos.md) for instructions on configuring Kerberos for an ADF app.
|
||||
|
||||
|
||||
## See Also
|
||||
|
||||
- [Logout directive](../directives/logout.directive.md)
|
||||
|
@@ -5,7 +5,7 @@ Status: Active
|
||||
Last reviewed: 2019-09-17
|
||||
---
|
||||
|
||||
# [Edit JSON Dialog](../../../ "Defined in ")
|
||||
# [Edit JSON Dialog](../../../lib/testing/src/lib/core/dialog/edit-json-dialog.ts "Defined in edit-json-dialog.ts")
|
||||
|
||||
Allows a user to preview or edit a JSON content in a dialog.
|
||||
|
||||
|
@@ -24,12 +24,11 @@ Logs the user out when the decorated element is clicked.
|
||||
| enableRedirect | `boolean` | true | Enable redirecting after logout |
|
||||
| redirectUri | `string` | "/login" | URI to redirect to after logging out. |
|
||||
|
||||
|
||||
## Kerberos
|
||||
|
||||
The configuration for Kerberos authentication will allow users to access Alfresco products by entering their credentials only once when logging into their Windows environment.
|
||||
|
||||
**You don't need to use the logout directive when Kerberos SSO is enabled in ADF**.
|
||||
**You don't need to use the [logout directive](../../core/directives/logout.directive.md) when Kerberos SSO is enabled in ADF**.
|
||||
|
||||
See [Kerberos Configuration](../../../docs/user-guide/kerberos.md) for instructions on configuring Kerberos for an ADF app.
|
||||
|
||||
|
@@ -125,7 +125,7 @@ Picard's birthday (47457.1):
|
||||
export class MyModule {}
|
||||
```
|
||||
|
||||
4. Bind your custom component to the custom model type so that Angular's dynamic component
|
||||
4. Bind your custom component to the [custom model](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/api/customModel.api.ts) type so that Angular's dynamic component
|
||||
loader can find it.
|
||||
|
||||
```ts
|
||||
|
@@ -69,6 +69,10 @@ Provides authentication to ACS and APS.
|
||||
- **isOauth**(): `boolean`<br/>
|
||||
Does the provider support OAuth?
|
||||
- **Returns** `boolean` - True if supported, false otherwise
|
||||
- **isPublicUrl**(): `boolean`<br/>
|
||||
|
||||
- **Returns** `boolean` -
|
||||
|
||||
- **isRememberMeSet**(): `boolean`<br/>
|
||||
Checks whether the "remember me" cookie was set or not.
|
||||
- **Returns** `boolean` - True if set, false otherwise
|
||||
|
@@ -37,10 +37,10 @@ Performs CRUD operations on identity groups.
|
||||
Deletes Group.
|
||||
- _groupId:_ `string` - Id of the group.
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the group deleted.
|
||||
- **findGroupsByName**(searchParams: [`IdentityGroupSearchParam`](../../../lib/core/models/identity-group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
- **findGroupsByName**(searchParams: [`IdentityGroupSearchParam`](../../../lib/core/models/identity-group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>`<br/>
|
||||
Finds groups filtered by name.
|
||||
- _searchParams:_ [`IdentityGroupSearchParam`](../../../lib/core/models/identity-group.model.ts) - Object containing the name filter string
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - List of group information
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>` - List of group information
|
||||
- **getClientIdByApplicationName**(applicationName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string>`<br/>
|
||||
Gets the client Id using the app name.
|
||||
- _applicationName:_ `string` - Name of the app
|
||||
|
@@ -58,22 +58,22 @@ Gets OAuth2 personal details and roles for users and performs CRUD operations on
|
||||
Deletes User.
|
||||
- _userId:_ `string` - Id of the user.
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the user deleted.
|
||||
- **findUserByEmail**(email: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
- **findUserByEmail**(email: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`<br/>
|
||||
Find users based on email input.
|
||||
- _email:_ `string` - Search query string
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - List of users
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - List of users
|
||||
- **findUserById**(id: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
Find users based on id input.
|
||||
- _id:_ `string` - Search query string
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - users object
|
||||
- **findUserByUsername**(username: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
- **findUserByUsername**(username: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`<br/>
|
||||
Find users based on username input.
|
||||
- _username:_ `string` - Search query string
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - List of users
|
||||
- **findUsersByName**(search: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - List of users
|
||||
- **findUsersByName**(search: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`<br/>
|
||||
Find users based on search input.
|
||||
- _search:_ `string` - Search query string
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - List of users
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - List of users
|
||||
- **getAssignedRoles**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`<br/>
|
||||
Gets assigned roles.
|
||||
- _userId:_ `string` - Id of the user.
|
||||
|
@@ -32,8 +32,8 @@ Decodes a JSON Web Token (JWT) to a JavaScript object.
|
||||
- _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` -
|
||||
- _accessToken:_ `string` - your SSO access token where the value is encode
|
||||
- _key:_ `string` - Key name of the field to retrieve
|
||||
- **hasClientRole**(clientName: `string`, role: `string`): `boolean`<br/>
|
||||
Checks for client role.
|
||||
- _clientName:_ `string` - Targeted client name
|
||||
|
@@ -24,7 +24,7 @@ be concatenated with the `value` parameter when `setTitle` is called, giving
|
||||
a result of the form "PageName - AppName" (see
|
||||
[App Config service](app-config.service.md) for more information). If `value`
|
||||
is not supplied then just the app name is used; this will default to
|
||||
"Alfresco ADF Application" when no app name set in the config file.
|
||||
"Alfresco ADF [Application"](../../../lib/testing/src/lib/core/structure/application.ts) when no app name set in the config file.
|
||||
|
||||
## See also
|
||||
|
||||
|
@@ -62,9 +62,10 @@ In order to achieve this, you will only need to set your app identifier under th
|
||||
This identifier must be unique to the app to guarantee that it has its own storage.
|
||||
|
||||
### SSO storagePrefix related scenario
|
||||
|
||||
The storagePrefix can allow you to login with multiple user in the same browser only if:
|
||||
- Or You don't use the implicit flow
|
||||
- Or You use implicit flow you use different AIMS instances for any app
|
||||
\- Or You don't use the implicit flow
|
||||
\- Or You use implicit flow you use different AIMS instances for any app
|
||||
|
||||
## See also
|
||||
|
||||
|
Reference in New Issue
Block a user