UserPreference

Represents a functional preference for a specific user in your organization.

Supported Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Special Access Rules

Customer Portal users can't access this object.

Fields

Field Details
Preference
Type
picklist
Properties
Create, Defaulted on Create, Filter, Group, Restricted picklist, Sort, Update
Description
The name of the user preference. Supported values are:
  • Event Reminder Default Lead Time
  • Task Reminder Default Time
  • Prevent Logs on Load
  • Autocomplete Apex After Key Press
  • Visualforce Viewstate Inspector
  • Forecasting Displayed Type
  • Editor Theme
  • Editor Font Size
  • Pinned Folders
  • Enable Query Plan
  • Enable New Open Dialog
  • Email Transport Type
  • Pinned Wave Folders
Event Reminder Default Lead Time and Task Reminder Default Time are related to these fields on the User object:
  • UserPreferencesEventRemindersCheckboxDefault
  • UserPreferencesTaskRemindersCheckboxDefault
  • UserPreferencesSuppressEventSFXReminders
  • UserPreferencesSuppressTaskSFXReminders
Enable New Open Dialog is reserved for future use.
When creating SOQL queries, tolabel is required to return accurate results. For example, select Id, tolabel(Preference), Value, UserId from UserPreference.
UserId
Type
reference
Properties
Filter, Group, Sort
Description
The ID of the user associated with this role. The corresponding field label is User ID.
Admin users can create and edit preferences for other users.
Standard users can delete their own preferences only. For a standard user, the value of the UserId field must be their own UserId.
Value
Type
textarea
Properties
Filter, Nillable, Sort
Description
The value of the user preference. For Event Reminder Default Lead Time, the values are increasing intervals of time from 0 minutes to 2 days. For Task Reminder Default Time, the values are half-hours from 12:00 AM to 11:30 PM. To view the respective sets of values, access the Reminders in your personal settings in the online application.

Usage

Use this object to query the set of currently configured user preferences in your organization. In your client application, you can query the User object to obtain valid User IDs to access the UserPreference object.

All users can invoke the supported calls with this object. Standard users can invoke these calls, but only on their own preferences.