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-2152] Added See Also sections and updated doc tools (#2835)

Browse Source 
* [ADF-2152] Added See Also sections to docs

* [ADF-2152] Added doc script to package.json
This commit is contained in:
Andy Stark
2018-01-16 17:43:10 +00:00
committed by Eugenio Romano
parent f4684f68be
commit 7a523961e2
16 changed files with 275 additions and 302 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/form.service.md
+25 -25
View File
@@ -32,40 +32,40 @@ class MyComponent {
### Events
| Name | Args Type | Description |
| --- | --- | --- |
| ---- | --------- | ----------- |
| formLoaded | FormEvent | Raised when form has been loaded or reloaded |
| formFieldValueChanged | FormFieldEvent | Raised when input values change |
| taskCompleted | FormEvent | Raised when a task is completed successfully |
| taskCompletedError | FormErrorEvent | Raised when a task is completed unsuccessfully |
| taskCompletedError | FormErrorEvent | Raised when a task is completed unsuccessfully |
| taskSaved | FormEvent | Raised when a task is saved successfully |
| taskSavedError | FormErrorEvent | Raised when a task is saved unsuccessfully |
| executeOutcome | FormOutcomeEvent | Raised when a form outcome is executed |
| formEvents | Event | You can subscribe to this event to listen : ( click, blur, change, focus, focusin, focusout, input, invalid, select) of any elements in the form , see doc below |
| validateForm | ValidateFormEvent | Raised each time a form is validated. You can use it to provide custom validation or prevent default behaviour. |
| validateFormField | ValidateFormFieldEvent | Raised each time a form field is validated. You can use it to provide custom validation or prevent default behaviour.|
| validateFormField | ValidateFormFieldEvent | Raised each time a form field is validated. You can use it to provide custom validation or prevent default behaviour. |
### Methods
| Name | Params | Returns | Description |
| --- | --- | --- | --- |
| createFormFromANode | (formName: string) | Observable\<any\> | Create a Form with a fields for each metadata properties |
| createForm | (formName: string) | Observable\<any\> | Create a Form |
| addFieldsToAForm | (formId: string, formModel: FormDefinitionModel) | Observable\<any\> | Add Fileds to A form |
| searchFrom | (name: string) | Observable\<any\> | Search For A Form by name |
| getForms | n/a | Observable\<any\> | Get All the forms |
| getProcessDefinitions | n/a | Observable\<any\> | Get Process Definitions |
| getTasks | n/a | Observable\<any\> | Get All the Tasks |
| getTask | (taskId: string) | Observable\<any\> | Get Task |
| saveTaskForm | (taskId: string, formValues: FormValues) | Observable\<any\> | Save Task Form |
| completeTaskForm | (taskId: string, formValues: FormValues, outcome?: string) | Observable\<any\> | Complete Task Form |
| getTaskForm | (taskId: string) | Observable\<any\> | Get Form related to a taskId |
| getFormDefinitionById | (formId: string) | Observable\<any\> | Get Form Definition |
| getFormDefinitionByName | (name: string) | Observable\<any\> | Returns form definition by a given name. |
| getStartFormInstance | (processId: string) | Observable\<any\> | Get start form instance for a given processId |
| getStartFormDefinition | (processId: string) | Observable\<any\> | Get start form definition for a given process |
| getRestFieldValues | (taskId: string, field: string) | Observable\<any\> | |
| getRestFieldValuesByProcessId | (processDefinitionId: string, field: string) | Observable\<any\> | |
| getRestFieldValuesColumnByProcessId | (processDefinitionId: string, field: string, column?: string) | Observable\<any\> | |
| getRestFieldValuesColumn | (taskId: string, field: string, column?: string) | Observable\<any\> | |
| getWorkflowGroups\ | (filter: string, groupId?: string) | Observable\<GroupModel[]\> | |
| getWorkflowUsers\ | (filter: string, groupId?: string) | Observable\<GroupUserModel[]\> | |
| ---- | ------ | ------- | ----------- |
| createFormFromANode | (formName: string) | Observable\\&lt;any> | Create a Form with a fields for each metadata properties |
| createForm | (formName: string) | Observable\\&lt;any> | Create a Form |
| addFieldsToAForm | (formId: string, formModel: FormDefinitionModel) | Observable\\&lt;any> | Add Fileds to A form |
| searchFrom | (name: string) | Observable\\&lt;any> | Search For A Form by name |
| getForms | n/a | Observable\\&lt;any> | Get All the forms |
| getProcessDefinitions | n/a | Observable\\&lt;any> | Get Process Definitions |
| getTasks | n/a | Observable\\&lt;any> | Get All the Tasks |
| getTask | (taskId: string) | Observable\\&lt;any> | Get Task |
| saveTaskForm | (taskId: string, formValues: FormValues) | Observable\\&lt;any> | Save Task Form |
| completeTaskForm | (taskId: string, formValues: FormValues, outcome?: string) | Observable\\&lt;any> | Complete Task Form |
| getTaskForm | (taskId: string) | Observable\\&lt;any> | Get Form related to a taskId |
| getFormDefinitionById | (formId: string) | Observable\\&lt;any> | Get Form Definition |
| getFormDefinitionByName | (name: string) | Observable\\&lt;any> | Returns form definition by a given name. |
| getStartFormInstance | (processId: string) | Observable\\&lt;any> | Get start form instance for a given processId |
| getStartFormDefinition | (processId: string) | Observable\\&lt;any> | Get start form definition for a given process |
| getRestFieldValues | (taskId: string, field: string) | Observable\\&lt;any> | |
| getRestFieldValuesByProcessId | (processDefinitionId: string, field: string) | Observable\\&lt;any> | |
| getRestFieldValuesColumnByProcessId | (processDefinitionId: string, field: string, column?: string) | Observable\\&lt;any> | |
| getRestFieldValuesColumn | (taskId: string, field: string, column?: string) | Observable\\&lt;any> | |
| getWorkflowGroups\\ | (filter: string, groupId?: string) | Observable\\&lt;GroupModel\[]> | |
| getWorkflowUsers\\ | (filter: string, groupId?: string) | Observable\\&lt;GroupUserModel\[]> | |