mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
Review documentation plus some tools fix (#5100)
* review 3.5.0 doc * fix documentation * fix documentation * fix documentation
This commit is contained in:
Eugenio Romano
GitHub
@@ -78,12 +78,12 @@ class MyComponent {
|
||||
- _appName:_ `string` - Name of the app
|
||||
- _taskId:_ `string` - ID of the target task
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]>` - Task variables
|
||||
- **parseForm**(json: `any`, data?: [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]`, readOnly: `boolean` = `false`): [`FormCloud`](../../../lib/process-services-cloud/src/lib/form/models/form-cloud.model.ts)<br/>
|
||||
- **parseForm**(json: `any`, data?: [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]`, readOnly: `boolean` = `false`): [`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)<br/>
|
||||
Parses JSON data to create a corresponding form.
|
||||
- _json:_ `any` - JSON data to create the form
|
||||
- _data:_ [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]` - (Optional) Values for the form's fields
|
||||
- _readOnly:_ `boolean` - Toggles whether or not the form should be read-only
|
||||
- **Returns** [`FormCloud`](../../../lib/process-services-cloud/src/lib/form/models/form-cloud.model.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) created from the JSON specification
|
||||
- **Returns** [`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) created from the JSON specification
|
||||
- **saveTaskForm**(appName: `string`, taskId: `string`, processInstanceId: `string`, formId: `string`, formValues: [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`<br/>
|
||||
Saves a task form.
|
||||
- _appName:_ `string` - Name of the app
|
||||
|
||||
@@ -13,35 +13,26 @@ Manages Local Storage preferences.
|
||||
|
||||
### Methods
|
||||
|
||||
- **createPreference**(appName: `string`, key: `string`, newPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
- **createPreference**(key: `string`, newPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
Creates local preference.
|
||||
- _appName:_ `string` - Name of the target app
|
||||
- _key:_ `string` - Key of the target preference
|
||||
- _newPreference:_ `any` -
|
||||
- _newPreference:_ `any` - Details of new local preference
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of created local preferences
|
||||
- **deletePreference**(key: `string`, preferences: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
Deletes local preference by given preference key.
|
||||
- _key:_ `string` - Key of the target preference
|
||||
- _preferences:_ `any` - Details of updated preferences
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of preferences without deleted preference
|
||||
- **getPreferenceByKey**(appName: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
- **getPreferenceByKey**(key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
Gets local preference.
|
||||
- _appName:_ `string` - Name of the target app
|
||||
- _key:_ `string` - Key of the target preference
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of local preference
|
||||
- **getPreferences**(appName: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
- **getPreferences**(key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
Gets local preferences
|
||||
- _appName:_ `string` - Name of the target app
|
||||
- _key:_ `string` - (Optional) (Optional) (Optional) (Optional)
|
||||
- _key:_ `string` - (Optional)
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - List of local preferences
|
||||
- **prepareLocalPreferenceResponse**(key: `string`): `any`<br/>
|
||||
|
||||
- _key:_ `string` -
|
||||
- **Returns** `any` -
|
||||
|
||||
- **updatePreference**(appName: `string`, key: `string`, updatedPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
- **updatePreference**(key: `string`, updatedPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
Updates local preference.
|
||||
- _appName:_ `string` - Name of the target app
|
||||
- _key:_ `string` - Key of the target preference
|
||||
- _updatedPreference:_ `any` - Details of updated preference
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of updated local preferences
|
||||
|
||||
@@ -56,7 +56,6 @@ import { LocalPreferenceCloudService, PROCESS_FILTERS_SERVICE_TOKEN } from '@alf
|
||||
]
|
||||
})
|
||||
export class ExampleModule {}
|
||||
|
||||
```
|
||||
|
||||
If you would like to inject the [User Preference Cloud Service](../../process-services-cloud/services/user-preference-cloud.service.md), you can inject the service like below shown
|
||||
@@ -74,7 +73,6 @@ import { UserPreferenceCloudService, PROCESS_FILTERS_SERVICE_TOKEN } from '@alfr
|
||||
]
|
||||
})
|
||||
export class ExampleModule {}
|
||||
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
@@ -21,11 +21,11 @@ Manages task filters.
|
||||
Deletes a task filter
|
||||
- _deletedFilter:_ [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) -
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>` - Observable of task instance filters without deleted filter
|
||||
- **getTaskFilterById**(appName: `string`, id: `string`): `any`<br/>
|
||||
- **getTaskFilterById**(appName: `string`, id: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>`<br/>
|
||||
Gets a task filter.
|
||||
- _appName:_ `string` - Name of the target app
|
||||
- _id:_ `string` - ID of the task
|
||||
- **Returns** `any` - Details of the task filter
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` - Details of the task filter
|
||||
- **getTaskListFilters**(appName?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>`<br/>
|
||||
Gets all task filters for a task app.
|
||||
- _appName:_ `string` - (Optional) Name of the target app
|
||||
@@ -74,10 +74,9 @@ import { LocalPreferenceCloudService, TASK_FILTERS_SERVICE_TOKEN } from '@alfres
|
||||
]
|
||||
})
|
||||
export class ExampleModule {}
|
||||
|
||||
```
|
||||
|
||||
If you would like to inject the [UserPreferenceCloudService](../../process-services-cloud/services/user-preference-cloud.service.md), you can inject the service like below shown
|
||||
If you would like to inject the [`UserPreferenceCloudService`](../../process-services-cloud/services/user-preference-cloud.service.md), you can inject the service like below shown
|
||||
|
||||
```ts
|
||||
import { NgModule } from '@angular/core';
|
||||
@@ -92,7 +91,6 @@ import { UserPreferenceCloudService, TASK_FILTERS_SERVICE_TOKEN } from '@alfresc
|
||||
]
|
||||
})
|
||||
export class ExampleModule {}
|
||||
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
@@ -47,4 +47,4 @@ Manages user preferences.
|
||||
|
||||
## See also
|
||||
|
||||
- [Local preference Cloud Service](local-preference-cloud.service.md)
|
||||
- [Local preference Cloud Service](local-preference-cloud.service.md)
|
||||
|
||||
Reference in New Issue
Block a user