UserSettings
is a
datatype for user settings.
Table: UserSettings
Parameter | Type | Required | Default | Stability | Description |
---|---|---|---|---|---|
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column. | |||||
Table last updated: Apr 3, 2025 | |||||
defaultTimeZone | string | Long-Term | Default timezone preference for user. If not set, the default timezone is no longer taken from the organization. | ||
featureAnnouncementsToShow | [FeatureAnnouncement ] | yes | Preview | List of feature announcements to show. See FeatureAnnouncement . This is a preview and subject to change. | |
isAutomaticHighlightingEnabled | boolean | yes | Preview | Whether automatic highlighting on the search page is enabled. This is a preview and subject to change. | |
isAutomaticSearchEnabled | boolean | yes | Short-Term | Whether the automatic search been enabled. | |
isCommunityMessageDismissed | boolean | yes | Short-Term | Whether the community message has been dismissed. | |
isDarkModeMessageDismissed | boolean | yes | Short-Term | Whether the dark-mode message has been dismissed. | |
isEventListOrderedWithNewestAtBottom | boolean | yes | Short-Term | Whether there is an event list, ordered with newest last. | |
isFieldPanelOpenByDefault | boolean | yes | Short-Term | Whether the field panel is open by default. | |
isGettingStartedMessageDismissed | boolean | yes | Short-Term | Whether the 'Getting Started' message has been dismissed. | |
isPackageDocsMessageDismissed | boolean | yes | Short-Term | Whether the package documentation message has been dismissed. | |
isQuickStartCompleted | boolean | yes | Long-Term | Whether the quick start has been completed. | |
isWelcomeMessageDismissed | boolean | yes | Short-Term | Whether the welcome message has been dismissed. | |
starredAlerts | [string] | yes | Deprecated | List of alerts that have been marked with a star. However, starring is no longer used in the UI and will be removed at the earliest in version 1.207. | |
starredDashboards | [string] | yes | Long-Term | List of dashboards that have been marked with a star. | |
starredSearchDomains | [string] | yes | Long-Term | List of searchdomains that have been marked with a star. | |
uiTheme | UiTheme | yes | Long-Term | The user interface theme choice. See uiTheme . |