Set user preferences
This API call sets the available preferences for the user specified in the login_name parameter. These user preferences persist between LiveContent S1000D sessions and are focused on differences in the presentation of content or the application.
Example API call
/lcapi?book=1&collection=1&target=user&action=update_user_prefs&change_reason=ON&hide_help_btn=0&save_position=1&login_name=admin
Parameters
| Parameter | Description |
|---|---|
target | user |
action | update_user_prefs |
change_reason | A user preferences make change highlight active (shown) or passive (invisible). This parameter can accept the values ON or OFF. |
hide_help_btn | A setting that will either hide or show the context sensitive help buttons. Either "0" or "1". |
save_position | A setting that will cause a user's size and position of the client window to be saved. Either "0" or "1". |
book | The id of the publication, an integer, such as 1. |
login_name | The user whose preferences are being updated |
collection | The id of the collection, an integer, such as 1. |
Returns
- On success
- Nothing.
- On failure
- Nothing.