SessionSettings Data Type
Version: Available or changed with runtime version 1.0.
Is a complex data type for passing user personalization settings for a client session as an object. The object contains properties that correspond to the fields in the system table 2000000073 User Personalization, including: App ID, Company, Language ID, Locale ID, Profile ID, Scope, and Time Zone. You can use the AL methods of the SessionSettings data type to get, set, and send the user personalization settings for the current client session.
Instance methods
The following methods are available on instances of the SessionSettings data type.
| Method name | Description |
|---|---|
| Company([Text]) | Gets or sets the company property in a SessionSettings object. |
| Init() | Populates the instance of a SessionsSettings with the current client user's personalization properties (such as Profile ID and Company) that are stored in the database. |
| LanguageId([Integer]) | Gets or sets the language ID property in a SessionSettings object. |
| LocaleId([Integer]) | Gets or sets the locale ID property in a SessionSettings object. |
| ProfileAppId([Guid]) | Gets or sets the ID of an extension, which provides a profile, in a SessionSettings object. |
| ProfileId([Text]) | Gets or sets the profile ID property in a SessionSettings object. |
| ProfileSystemScope([Boolean]) | Gets or sets the profile scope property in a SessionSettings object. |
| RequestSessionUpdate(Boolean) | Passes a SessionSettings object to the client to request a new session that uses the user personalization properties that are set in the object. The current client session is abandoned and a new session is started. |
| TimeZone([Text]) | Gets or sets the time zone property in a SessionSettings object. |
See Also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for