Codeunit 9176 User Settings, source in 28

// ------------------------------------------------------------------------------------------------
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
// ------------------------------------------------------------------------------------------------

namespace System.Environment.Configuration;

using System.Environment;
using System.Reflection;

/// <summary>
/// Provides basic functionality for user settings.
/// </summary>
codeunit 9176 "User Settings"
{
    /// <summary>
    /// Gets the page id for the User Settings page.
    /// </summary>
    /// <returns>The page ID for the User Settings page.</returns>
    procedure GetPageId(): Integer
    var
        UserSettingsImpl: Codeunit "User Settings Impl.";
    begin
        exit(UserSettingsImpl.GetPageId());
    end;

    /// <summary>
    /// Gets the settings for the given user.
    /// </summary>
    /// <param name="UserSecurityID">The user security id of the user.</param>
    /// <param name="UserSettings">The return Record with the settings of the User.</param>
    procedure GetUserSettings(UserSecurityID: Guid; var UserSettings: Record "User Settings")
    var
        UserSettingsImpl: Codeunit "User Settings Impl.";
    begin
        UserSettingsImpl.GetUserSettings(UserSecurityID, UserSettings);
    end;

    /// <summary>
    /// Disables the teaching tips for a given user.
    /// </summary>
    /// <param name="UserSecurityID">The user security id of the user.</param>
    procedure DisableTeachingTips(UserSecurityId: Guid)
    var
        UserSettingsImpl: Codeunit "User Settings Impl.";
    begin
        UserSettingsImpl.DisableTeachingTips(UserSecurityId);
    end;

    /// <summary>
    /// Enables the teaching tips for a given user.
    /// </summary>
    /// <param name="UserSecurityID">The user security id of the user.</param>
    procedure EnableTeachingTips(UserSecurityId: Guid)
    var
        UserSettingsImpl: Codeunit "User Settings Impl.";
    begin
        UserSettingsImpl.EnableTeachingTips(UserSecurityId);
    end;

    /// <summary>
    /// Disables the legacy action bar for a given user.
    /// </summary>
    /// <param name="UserSecurityID">The user security id of the user.</param>
    procedure DisableLegacyActionBar(UserSecurityId: Guid)
    var
        UserSettingsImpl: Codeunit "User Settings Impl.";
    begin
        UserSettingsImpl.DisableLegacyActionBar(UserSecurityId);
    end;

    /// <summary>
    /// Enables the legacy action bar for a given user.
    /// </summary>
    /// <param name="UserSecurityID">The user security id of the user.</param>
    procedure EnableLegacyActionBar(UserSecurityId: Guid)
    var
        UserSettingsImpl: Codeunit "User Settings Impl.";
    begin
        UserSettingsImpl.EnableLegacyActionBar(UserSecurityId);
    end;

    /// <summary>
    /// Get the companies the current user has access to.
    /// </summary>
    /// <param name="TempCompany">Companies the current user has access to.</param>
    procedure GetAllowedCompaniesForCurrentUser(var TempCompany: Record Company temporary)
    var
        UserSettingsImpl: Codeunit "User Settings Impl.";
    begin
        UserSettingsImpl.GetAllowedCompaniesForCurrentUser(TempCompany);
    end;

    /// <summary>
    /// Get the companies the specified user has access to.
    /// </summary>
    /// <param name="UserSecurityId">The user security ID.</param>
    /// <param name="TempCompany">Companies the current user has access to.</param>
    procedure GetAllowedCompaniesForUser(UserSecurityId: Guid; var TempCompany: Record Company temporary)
    var
        UserSettingsImpl: Codeunit "User Settings Impl.";
    begin
        UserSettingsImpl.GetAllowedCompaniesForUser(UserSecurityId, TempCompany);
    end;

    /// <summary>
    /// Allows the user to select the new profile for given User Settings
    /// </summary>
    /// <param name="UserSettingsRec">User settings to update with the new profile</param>
    procedure LookupProfile(var UserSettingsRec: Record "User Settings")
    var
        UserSettingsImpl: Codeunit "User Settings Impl.";
    begin
        UserSettingsImpl.ProfileLookup(UserSettingsRec);
    end;

    /// <summary>
    /// Gets a profile name for the given user settings.
    /// </summary>
    /// <param name="UserSettingsRec">User settings to get the profile name.</param>
    /// <returns></returns>
    procedure GetProfileName(UserSettingsRec: Record "User Settings"): Text
    var
        UserSettingsImpl: Codeunit "User Settings Impl.";
    begin
        exit(UserSettingsImpl.GetProfileName(UserSettingsRec.Scope, UserSettingsRec."App ID", UserSettingsRec."Profile ID"));
    end;

    /// <summary>
    /// Updates the user settings for given user
    /// </summary>
    /// <param name="NewUserSettings">New User settings that should be set to the user.</param>
#if not CLEAN27
#pragma warning disable AS0078
    // Parameter name changed from UserSettings to NewUserSettings. var was removed because UpdateUserSettings did not have the var in the signature. NewUserSettings record is not changed in the method.
#endif
    procedure UpdateUserSettings(NewUserSettings: Record "User Settings")
#if not CLEAN27    
#pragma warning restore AS0078
#endif    
    var
        UserSettingsImpl: Codeunit "User Settings Impl.";
    begin
        UserSettingsImpl.UpdateUserSettings(NewUserSettings);
    end;

    /// <summary>
    /// Integration event to get the default profile.
    /// </summary>
    /// <param name="AllProfile">The return record that holds the default profile.</param>
    [IntegrationEvent(false, false)]
    procedure OnGetDefaultProfile(var AllProfile: Record "All Profile")
    begin
    end;

    /// <summary>
    /// Integration event that allows changing the settings page ID.
    /// </summary>
    /// <param name="SettingsPageID">The new page ID for the user settings page.</param>
    [IntegrationEvent(false, false)]
    procedure OnGetSettingsPageID(var SettingsPageID: Integer)
    begin
    end;

    /// <summary>
    /// Integration event that allows changing the behavior of opening the settings page.
    /// </summary>
    /// <param name="Handled">Set to true to skip the default behavior.</param>
    [IntegrationEvent(false, false)]
    procedure OnBeforeOpenSettings(var Handled: Boolean)
    begin
    end;

    /// <summary>
    /// Integration event that allows updating the User Settings record with extra values.
    /// </summary>
    /// <param name="UserSettings">The User settings record to update.</param>
    [IntegrationEvent(false, false)]
    procedure OnAfterGetUserSettings(var UserSettings: Record "User Settings")
    begin
    end;

    /// <summary>
    /// Integration event that allows updating the settings on related records.
    /// </summary>
    /// <param name="OldSettings">The value of the settings before any user interaction.</param>
    /// <param name="NewSettings">The value of the settings after user interaction.</param>
    [IntegrationEvent(false, false)]
    procedure OnUpdateUserSettings(OldSettings: Record "User Settings"; NewSettings: Record "User Settings")
    begin
    end;

    /// <summary>
    /// Integration event that fires every time the company is changed.
    /// </summary>
    /// <param name="NewCompanyName">The name of the new company.</param>
    /// <param name="IsSetupInProgress">Set to true if the given company is still setting up.</param>
    [IntegrationEvent(false, false)]
    procedure OnCompanyChange(NewCompanyName: Text; var IsSetupInProgress: Boolean)
    begin
    end;
}