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

* [ADF-3745] Updated tutorial text

* [ADF-3745] Updates for doc review
This commit is contained in:
Andy Stark
2018-11-14 19:43:23 +00:00
committed by Eugenio Romano
parent 7b3f400c48
commit 54cbd210a1
24 changed files with 129 additions and 133 deletions

View File

@@ -1,7 +1,7 @@
---
Added: v2.4.0
Status: Active
Last reviewed: 2018-05-03
Last reviewed: 2018-11-14
---
# Add Permission Panel Component

View File

@@ -1,7 +1,7 @@
---
Added: v2.1.0
Status: Active
Last reviewed: 2018-05-03
Last reviewed: 2018-11-14
---
# Content Node Dialog service
@@ -52,7 +52,7 @@ Displays and manages dialogs for selecting content to open, copy or upload.
Opens a dialog to choose folders to upload.
- _action:_ `string` - Name of the action to show in the title
- _contentEntry:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - Item to upload
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>` - Information about the chosed folder(s)
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>` - Information about the chosen folder(s)
## Details

View File

@@ -1,6 +1,7 @@
---
Added: v2.0.0
Status: Active
Last reviewed: 2018-11-14
---
# Like component

View File

@@ -1,7 +1,7 @@
---
Added: v2.0.0
Status: Active
Last reviewed: 2018-09-14
Last reviewed: 2018-11-14
---
# Node Permission service
@@ -15,7 +15,7 @@ Manages role permissions for content nodes.
- **getGroupMemberByGroupName**(groupName: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<GroupMemberPaging>`<br/>
Gets all members related to a group name.
- _groupName:_ `string` - Name of group to look for members
- _opts:_ `any` - (Optional) Extra options supported by JSAPI
- _opts:_ `any` - (Optional) Extra options supported by JS-API
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<GroupMemberPaging>` - List of members
- **getNodeRoles**(node: [`MinimalNodeEntryEntity`](../content-services/document-library.model.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>`<br/>
Gets a list of roles for the current node.

View File

@@ -1,12 +1,12 @@
---
Added: v2.0.0
Status: Active
Last reviewed: 2018-03-13
Last reviewed: 2018-11-14
---
# Search control component
Displays a input text which shows find-as-you-type suggestions.
Displays a input text that shows find-as-you-type suggestions.
![adf-search-control](../docassets/images/search-control-component.png)
@@ -54,8 +54,8 @@ You can show your own custom template when no results are found for the search:
| Name | Type | Description |
| ---- | ---- | ----------- |
| optionClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a file item from the list of "find-as-you-type" results is selected. |
| searchChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then the term is truncated to an empty string. |
| submit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the search is submitted pressing ENTER button. The search term is provided as value of the event. |
| searchChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then it is truncated to an empty string. |
| submit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the search is submitted by pressing the ENTER key. The search term is provided as the value of the event. |
## Details

View File

@@ -1,6 +1,7 @@
---
Added: v2.0.0
Status: Active
Last reviewed: 2018-11-14
---
# Tag List component

View File

@@ -1,6 +1,7 @@
---
Added: v2.0.0
Status: Active
Last reviewed: 2018-11-14
---
# Webscript component
@@ -112,15 +113,17 @@ This sample demonstrates how to implement a [Webscript component](../content-ser
</adf-webscript-get>
```
If you want to show the result from a webscript inside a ng2-alfresco-datatable you have to return from the GET of the webscript the datastructure below:
subdivide in data and schema
If you want to show the result from a webscript inside a
[datatable component](../core/datatable.component.md)
you have to return the data structure below (subdivided into data and
schema) from the GET method of the webscript:
```ts
data: [],
schema: []
```
this is an example:
Here is an example:
```ts
data: [
@@ -140,7 +143,7 @@ schema: [{
}]
```
or you can send just the array data and the component will create a schema for you:
Alternatively, you can send just the array data and the component will create a schema for you:
```ts
data: [
@@ -149,14 +152,14 @@ data: [
]]
```
that will render the following table
This will render the following table:
![Custom columns](../docassets/images/datatable.png)
### Webscript View JSON example
This sample demonstrates how to implement a [Webscript component](../content-services/webscript.component.md) that renders the JSON contents that come from a webscript
This sample Web Scripts reside in your Alfresco Server. You can access the folder webscript here:
This sample demonstrates how to implement a [Webscript component](../content-services/webscript.component.md) that renders the JSON contents that come from a webscript.
This sample webscript resides in your Alfresco Server. You can access the folder webscript here:
`http://localhost:8080/alfresco/service/sample/folder/JSON%EXAMPLE`
@@ -176,6 +179,6 @@ You can get the plain data from the webscript through the **success** event para
```ts
logDataExample(data) {
console.log('You webscript data are here' + data);
console.log('Your webscript data is here' + data);
}
```