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

Release Note for 4.2 - Initial draft. (#6390)

Browse Source 
* Release Note for 4.2 - Initial draft.

* update dep

* documentation

* fix

* remove script

* lint

Co-authored-by: Eugenio Romano <eugenio.romano@alfresco.com>
Co-authored-by: Eugenio Romano <eromano@users.noreply.github.com>
This commit is contained in:
Francesco Corti
2020-12-07 22:03:41 +01:00
committed by GitHub
parent 27167b3420
commit 5a4cc4edda
214 changed files with 5178 additions and 4950 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
docs/core/services/user-preferences.service.md
View File

@@ -13,40 +13,40 @@ Stores preferences for the app and for individual components.
### Methods
- **get**(property: `string`, defaultValue?: `string`): `string`<br/>
* **get**(property: `string`, defaultValue?: `string`): `string`<br/>
Gets a preference property.
- _property:_ `string` - Name of the property
- _defaultValue:_ `string` - (Optional) Default to return if the property is not found
- **Returns** `string` - Preference property
- **getDefaultLocale**(): `string`<br/>
* *property:* `string` - Name of the property
* *defaultValue:* `string` - (Optional) Default to return if the property is not found
* **Returns** `string` - Preference property
* **getDefaultLocale**(): `string`<br/>
Gets the default locale.
- **Returns** `string` - Default locale language code
- **getPropertyKey**(property: `string`): `string`<br/>
* **Returns** `string` - Default locale language code
* **getPropertyKey**(property: `string`): `string`<br/>
Gets the full property key with prefix.
- _property:_ `string` - The property name
- **Returns** `string` - [Property](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) key
- **getStoragePrefix**(): `string`<br/>
* *property:* `string` - The property name
* **Returns** `string` - [Property](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) key
* **getStoragePrefix**(): `string`<br/>
Gets the active storage prefix for preferences.
- **Returns** `string` - Storage prefix
- **hasItem**(property: `string`): `boolean`<br/>
* **Returns** `string` - Storage prefix
* **hasItem**(property: `string`): `boolean`<br/>
Check if an item is present in the storage
- _property:_ `string` - Name of the property
- **Returns** `boolean` - True if the item is present, false otherwise
- **select**(property: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
* *property:* `string` - Name of the property
* **Returns** `boolean` - True if the item is present, false otherwise
* **select**(property: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Sets up a callback to notify when a property has changed.
- _property:_ `string` - The property to watch
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Notification callback
- **set**(property: `string`, value: `any`)<br/>
* *property:* `string` - The property to watch
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Notification callback
* **set**(property: `string`, value: `any`)<br/>
Sets a preference property.
- _property:_ `string` - Name of the property
- _value:_ `any` - New value for the property
- **setStoragePrefix**(value: `string`)<br/>
* *property:* `string` - Name of the property
* *value:* `any` - New value for the property
* **setStoragePrefix**(value: `string`)<br/>
Sets the active storage prefix for preferences.
- _value:_ `string` - Name of the prefix
- **setWithoutStore**(property: `string`, value: `any`)<br/>
* *value:* `string` - Name of the prefix
* **setWithoutStore**(property: `string`, value: `any`)<br/>
Sets a preference property.
- _property:_ `string` - Name of the property
- _value:_ `any` - New value for the property
* *property:* `string` - Name of the property
* *value:* `any` - New value for the property
## Details