inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2026-09-09 18:03:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-1769] Added prop tables and JSDocs (#2906)

Browse Source
This commit is contained in:
Andy Stark
2018-02-02 14:56:59 +00:00
committed by Eugenio Romano
parent 819274301b
commit 5ee9b09a21
14 changed files with 132 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/start-task.component.md
+8 -8
View File
@@ -14,14 +14,14 @@ Creates/Starts new task for the specified app
### Properties
| Name | Type | Description |
| --- | --- | --- |
| appId | string | (**required**): The id of the app. |
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| appId | `number` | | (required) The id of the app. |
### Events
| Name | Description |
| --- | --- |
| success | Raised when the task is successfully created |
| cancel | Raised when the cancel button is pressed by the user |
| error | Raised if there is an error during task creation |
| Name | Type | Description |
| ---- | ---- | ----------- |
| success | `EventEmitter<any>` | Emitted when the task is successfully created. |
| cancel | `EventEmitter<void>` | Emitted when the cancel button is clicked by the user. |
| error | `EventEmitter<any>` | Emitted when an error occurs. |