Holds information about the current user settings.

Hierarchy

  • UserSettings

Properties

dateFormattingInfo: DateFormattingInfo

Returns the date formatting information for the current user.

defaultDashboardId: string

Returns the ID of the default dashboard for the current user.

isGuidedHelpEnabled: boolean

Indicates whether guided help is enabled for the current user.

isHighContrastEnabled: boolean

Indicates whether high contrast is enabled for the current user.

isRTL: boolean

Indicates whether the language for the current user is a right-to-left (RTL) language.

languageId: number

Returns the language ID for the current user.

Returns a collection of lookup objects containing the GUID and display name of each of the security role or teams that the user is associated with.

securityRolePrivileges: string[]

Returns an array of strings that represent the GUID values of each of the security role privilege that the user is associated with or any teams that the user is associated with.

securityRoles: string[]

Returns an array of strings that represent the GUID values of each of the security role that the user is associated with or any teams that the user is associated with.

Deprecated

Deprecated in v9.1; use globalContext.userSettings.roles instead to display names of security roles or teams along with the ID.

See

External Link: Deprecated Client APIs

transactionCurrency: Xrm.LookupValue

Returns a lookup object containing the ID, display name, and entity type of the transaction currency for the current user.

transactionCurrencyId: string

Returns the transaction currency ID for the current user.

Deprecated

Deprecated in v9.1; use globalContext.userSettings.transactionCurrency instead to display name along with the ID.

userId: string

Returns the GUID of the SystemUser.Id value for the current user.

userName: string

Returns the name of the current user.

Methods

  • Returns the difference in minutes between the local time and Coordinated Universal Time (UTC).

    Returns number

Generated using TypeDoc