mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-26 17:24:56 +00:00
ba905acf13
* [ADF-2463] Moved doc files to subfolders * [ADF-2463] Fixed broken image links * [ADF-2463] Moved doc files to subfolders * [ADF-2463] Fixed broken image links
109 lines
3.6 KiB
Markdown
109 lines
3.6 KiB
Markdown
---
|
|
Added: v2.0.0
|
|
Status: Active
|
|
---
|
|
# User Preferences Service
|
|
|
|
Stores preferences for components.
|
|
|
|
## Methods
|
|
|
|
- `get(property: string, defaultValue?: string): string`
|
|
Gets a preference property.
|
|
- `property` - Name of the property
|
|
- `defaultValue` - (Optional) Default to return if the property is not found
|
|
- `set(property: string, value: any)`
|
|
Sets a preference property.
|
|
- `property` - Name of the property
|
|
- `value` - New value for the property
|
|
- `getStoragePrefix(): string`
|
|
Gets the active storage prefix for preferences.
|
|
|
|
- `setStoragePrefix(value: string)`
|
|
Sets the active storage prefix for preferences.
|
|
- `value` - Name of the prefix
|
|
- `getPropertyKey(property: string): string`
|
|
Gets the full property key with prefix.
|
|
- `property` - The property name
|
|
- `getDefaultPageSizes(): number[]`
|
|
Gets an array containing the available page sizes.
|
|
|
|
- `getDefaultLocale(): string`
|
|
Gets the default locale.
|
|
|
|
- `select : Observable`
|
|
Return the value for the user status property changed
|
|
|
|
|
|
## Details
|
|
|
|
The preferences are bound to a particular `prefix` so the application can switch between different profiles on demand.
|
|
|
|
For example upon login you can set the `prefix` as current username:
|
|
|
|
```ts
|
|
import { UserPreferencesService, AuthenticationService } from '@alfresco/adf-core';
|
|
|
|
@Component({...})
|
|
class AppComponent {
|
|
constructor(private userPreferences: UserPreferencesService,
|
|
private authService: AuthenticationService) {
|
|
}
|
|
|
|
onLoggedIn() {
|
|
this.userPreferences.setStoragePrefix(
|
|
this.authService.getEcmUsername()
|
|
);
|
|
}
|
|
}
|
|
```
|
|
|
|
As soon as you assign the storage prefix all settings that you get or set via the `UserPreferencesService` will be saved to dedicated profile.
|
|
|
|
You can import the service in your controller and use its APIs like below:
|
|
|
|
```ts
|
|
@Component({...})
|
|
class AppComponent {
|
|
constructor(userPreferences: UserPreferencesService) {
|
|
|
|
userPreferences.set('myProperty1', 'value1');
|
|
userPreferences.set('myProperty2', 'value2');
|
|
|
|
console.log(
|
|
userPreferences.get('myProperty1')
|
|
);
|
|
}
|
|
}
|
|
```
|
|
|
|
The service also provides quick access to a set of the "known" properties used across ADF components:
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| authType | `string` | Authorization type (can be "ECM", "BPM" or "ALL"). |
|
|
| disableCSRF | `boolean` | Prevents the CSRF Token from being submitted if true. Only valid for Process Services. |
|
|
| paginationSize | `number` | Pagination size. |
|
|
| locale | `string` | Current locale setting. |
|
|
|
|
## User Preference onChange Stream
|
|
Whenever a property is set to the user preference service an onChange event is sent with the whole set of user properties. This comes in handy when a component wants to react to some property change.
|
|
|
|
```ts
|
|
userPreferences.paginationSize = 10;
|
|
userPreferences.onChange().subscribe((userStatusValues) => {
|
|
console.log(userStatusValues.PAGINATION_SIZE); //this will be 10
|
|
});
|
|
```
|
|
|
|
We have added also the `select` method where the user can give the property name which wants to be notified the changes and get the updated value.
|
|
A set of basic properties is added into the enumeration `UserPreferenceValues` which gives you the key value to access the standard user preference service properties : **PaginationSize**, **DisableCSRF**, **Locale** and **SupportedPageSizes**.
|
|
|
|
```ts
|
|
userPreferences.disableCSRF = true;
|
|
userPreferences.select(UserPreferenceValues.DisableCSRF).subscribe((CSRFflag) => {
|
|
console.log(CSRFflag); //this will be true;
|
|
});
|
|
```
|
|
|