alfresco-ng2-components/docs/process-services-cloud/services/user-preference-cloud.service.md
Eugenio Romano c3452a4f62
Documentation build (#6762)
* move doc dependency in doctools

* add ignore link

* rebuild doc

* version index

* put it back some deps
2021-03-03 14:08:15 +00:00

2.6 KiB

Title, Added, Status, Last reviewed
Title Added Status Last reviewed
User Preference Cloud Service v3.4.0 Experimental 2019-08-06

User Preference Cloud Service

Manages user preferences.

Class members

Methods

  • createPreference(appName: string, key: string, newPreference: any): Observable<any>
    Creates user preference.

    • appName: string - Name of the target app
    • key: string - Key of the target preference
    • newPreference: any -
    • Returns Observable<any> - Observable of created user preferences
  • deletePreference(appName: string, key: string): Observable<any>
    Deletes user preference by given preference key.

    • appName: string - Name of the target app
    • key: string - Key of the target preference
    • Returns Observable<any> - Observable of delete operation status
  • getBasePath(appName: string): string

    • appName: string -
    • Returns string -
  • getPreferenceByKey(appName: string, key: string): Observable<any>
    Gets user preference.

    • appName: string - Name of the target app
    • key: string - Key of the target preference
    • Returns Observable<any> - Observable of user preference
  • getPreferences(appName: string): Observable<any>
    Gets user preferences

    • appName: string - Name of the target app
    • Returns Observable<any> - List of user preferences
  • updatePreference(appName: string, key: string, updatedPreference: any): Observable<any>
    Updates user preference.

    • appName: string - Name of the target app
    • key: string - Key of the target preference
    • updatedPreference: any - Details of updated preference
    • Returns Observable<any> - Observable of updated user preferences

See also