mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-31 17:38:48 +00:00
0bca6607a9
* * Use local storage for community version. * * Created a communityModule. * * Updated unit tests the recent changes * * Updated documents. * * Modified process/task filters doc.
52 lines
2.7 KiB
Markdown
52 lines
2.7 KiB
Markdown
---
|
|
Title: Local Preference Cloud Service
|
|
Added: v3.4.0
|
|
Status: Experimental
|
|
Last reviewed: 2019-08-06
|
|
---
|
|
|
|
# [Local Preference Cloud Service](../../../lib/process-services-cloud/src/lib/services/local-preference-cloud.service.ts "Defined in local-preference-cloud.service.ts")
|
|
|
|
Manages Local Storage preferences.
|
|
|
|
## Class members
|
|
|
|
### Methods
|
|
|
|
- **createPreference**(appName: `string`, 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` -
|
|
- **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/>
|
|
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/>
|
|
Gets local preferences
|
|
- _appName:_ `string` - Name of the target app
|
|
- _key:_ `string` - (Optional) (Optional) (Optional) (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/>
|
|
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
|
|
|
|
## See also
|
|
|
|
- [User preference Cloud Service](user-preference-cloud.service.md)
|