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

[ADF-3745] Updates for doc review (#4291)

Browse Source 
* [ADF-3745] Updates for doc review

* [ADF-3745] Fixed bad links to Content node selector page

* [ADF-3745] Updated index files
This commit is contained in:
Andy Stark
2019-02-08 21:21:06 +00:00
committed by Eugenio Romano
parent 581a0c5177
commit 1079361c2c
24 changed files with 277 additions and 180 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/core/icon.component.md
View File

@@ -2,7 +2,7 @@
Title: Icon Component
Added: v3.0.0
Status: Active
Last reviewed: 2019-01-10
Last reviewed: 2019-02-08
---
# [Icon Component](../../lib/core/icon/icon.component.ts "Defined in icon.component.ts")
@@ -72,7 +72,7 @@ In the HTML, you can now use the icon as shown below:
### Thumbnail Service
You can also reference the icons registered with the [Thumbnail Service](thumbnail.service.md)
by utilising the `adf:` namespace.
using the `adf:` namespace.
```html
<adf-icon value="adf:image/gif"></adf-icon>

7
docs/core/identity-user.service.md
View File

@@ -2,7 +2,7 @@
Title: Identity user service
Added: v3.0.0
Status: Active
Last reviewed: 2019-01-23
Last reviewed: 2019-02-08
---
# [Identity user service](../../lib/core/userinfo/services/identity-user.service.ts "Defined in identity-user.service.ts")
@@ -35,6 +35,11 @@ Gets OAuth2 personal details and roles for users.
- _userId:_ `string` - ID of the target user
- _clientId:_ `string` - ID of the client app
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the user has access, false otherwise
- **checkUserHasRole**(userId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
Checks if a user has one of the roles from a list.
- _userId:_ `string` - ID of the target user
- _roleNames:_ `string[]` - Array of roles to check for
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the user has one of the roles, false otherwise
- **findUsersByName**(search: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Find users based on search input.
- _search:_ `string` - Search query string

4
docs/core/infinite-pagination.component.md
View File

@@ -2,7 +2,7 @@
Title: Infinite Pagination component
Added: v2.0.0
Status: Active
Last reviewed: 2019-01-16
Last reviewed: 2019-02-08
---
# [Infinite Pagination component](../../lib/core/pagination/infinite-pagination.component.ts "Defined in infinite-pagination.component.ts")
@@ -46,7 +46,7 @@ Adds "infinite" pagination to the component it is used with.
| Name | Type | Description |
| ---- | ---- | ----------- |
| loadMore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../lib/core/models/pagination.model.ts)`>` | Emitted when the "Load More" button is clicked. |
| loadMore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`RequestPaginationModel`](../../lib/core/models/request-pagination.model.ts)`>` | Emitted when the "Load More" button is clicked. |
## Details

2
docs/core/login-dialog.service.md
View File

@@ -2,7 +2,7 @@
Title: Login Dialog service
Added: v2.6.0
Status: Active
Last reviewed: 2018-10-02
Last reviewed: 2019-02-08
---
# [Login Dialog service](../../lib/core/services/login-dialog.service.ts "Defined in login-dialog.service.ts")

2
docs/core/translation.service.md
View File

@@ -2,7 +2,7 @@
Title: Translation service
Added: v2.0.0
Status: Active
Last reviewed: 2018-06-07
Last reviewed: 2019-02-08
---
# [Translation service](../../lib/core/services/translation.service.ts "Defined in translation.service.ts")