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

update readme

Browse Source
This commit is contained in:
Eugenio Romano
2016-08-03 21:40:52 +01:00
parent 60dde117d7
commit b5bab2c753
1 changed files with 16 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
ng2-components/ng2-alfresco-webscript/README.md
View File

@@ -87,6 +87,7 @@ Also make sure you include these dependencies in your .html page:
[scriptArgs]="Object"
[contextRoot]="string"
[servicePath]="string"
[showData]="boolean"
[contentType]="JSON | HTML | DATATABLE | TEXT"
(onSuccess)= "logData($event)">
</alfresco-webscript-get>
@@ -143,11 +144,20 @@ bootstrap(AppComponent, [
#### Options
**scriptPath** {string} path to Web Script (as defined by Web Script)
**scriptArgs** {Object} arguments to pass to Web Script
**contextRoot** {string} path where application is deployed default value 'alfresco'
**servicePath** {string} path where Web Script service is mapped default value 'service'
**contentType** {string} how to handle the data received from te web script JSON | HTML | DATATABLE | TEXT
Attribute | Options | Default | Description | Mandatory
--- | --- | --- | --- | ---
`scriptPath` | *string* | | path to Web Script (as defined by Web Script) | mandatory
`scriptArgs` | *Object* | | arguments to pass to Web Script |
`contextRoot` | *string* | | path where application is deployed |
`scriptPath` | *string* | | path to Web Script (as defined by Web Script) | alfresco
`contentType` | *string* | | path where Web Script service is mapped default value | service
`contentType` | *string* | | how to handle the data received from te web script JSON , HTML , DATATABLE or TEXT | TEXT
`onSuccess` | *event* | | You can get the plain data from the webscript through the **onSuccess** event parameter and use it as you need in your application |
`showData` | *booleann* | | render the webscript data |true
**contentType** {string}
***data*** {string} data contain the plain value get from the webscipt is an output parameter
## Webscript View HTML example
@@ -236,6 +246,7 @@ http://localhost:8080/alfresco/service/sample/folder/JSON%EXAMPLE
[servicePath]= "'service'";
[scriptPath]= "'Sample/folder/JSON_EXAMPLE'"
[contentType]= "'HTML'"
[showData] = "false"
(onSuccess)= "logDataExample($event)">
</alfresco-webscript-get>
```