Codeunit 9026 User Login Time Tracker

System Application, System.Security.User

src/System Application/App/User Login Times/src/UserLoginTimeTracker.Codeunit.al112 lines, Copyright (c) Microsoft Corporation. MIT

// ------------------------------------------------------------------------------------------------// Copyright (c) Microsoft Corporation. All rights reserved.// Licensed under the MIT License. See License.txt in the project root for license information.// ------------------------------------------------------------------------------------------------namespace System.Security.User;/// <summary>/// Exposes functionality to retrieve information about the user's first, penultimate and last login times./// </summary>codeunit 9026 "User Login Time Tracker"{    Access = Public;    InherentEntitlements = X;    InherentPermissions = X;    /// <summary>    /// Returns true if this is the first time the user logs in to the current company.    /// </summary>    /// <param name="UserSecurityID">The User Security ID.</param>    /// <returns>True if this is the first time the user logs in and false otherwise.</returns>    procedure IsFirstLogin(UserSecurityID: Guid): Boolean    var        UserLoginTimeTrackerImpl: Codeunit "User Login Time Tracker Impl.";    begin        exit(UserLoginTimeTrackerImpl.IsFirstLogin(UserSecurityID));    end;    /// <summary>    /// Returns true if any user logged in to the current company on or after the specified date.    /// </summary>    /// <param name ="FromDate">The date to start searching from.</param>    /// <returns>True if any user logged in on or after the specified date and false otherwise.</returns>    procedure AnyUserLoggedInSinceDate(FromDate: Date): Boolean    var        UserLoginTimeTrackerImpl: Codeunit "User Login Time Tracker Impl.";    begin        exit(UserLoginTimeTrackerImpl.AnyUserLoggedInSinceDate(FromDate));    end;    /// <summary>    /// Returns true if the current user logged in to the current company at or after the specified DateTime.    /// </summary>    /// <param name="FromDateTime">The DateTime to start searching from.</param>    /// <returns>True if the current user logged in at or after the specified DateTime and false otherwise.</returns>    procedure UserLoggedInSinceDateTime(FromDateTime: DateTime): Boolean    var        UserLoginTimeTrackerImpl: Codeunit "User Login Time Tracker Impl.";    begin        exit(UserLoginTimeTrackerImpl.UserLoggedInSinceDateTime(FromDateTime));    end;    /// <summary>    /// Checks whether a user has logged in to the current environment (to any of the companies) in the past.    /// </summary>    /// <param name="UserSecurityID">The User Security ID.</param>    /// <returns>True if the user has logged in to any of the companies; otherwise - false.</returns>    procedure UserLoggedInEnvironment(UserSecurityID: Guid): Boolean    var        UserLoginTimeTrackerImpl: Codeunit "User Login Time Tracker Impl.";    begin        exit(UserLoginTimeTrackerImpl.UserLoggedInEnvironment(UserSecurityID));    end;    /// <summary>    /// Returns the penultimate login DateTime of the current user for the current company.    /// </summary>    /// <returns>The penultimate login DateTime of the current user, or 0DT if the user login cannot be found.</returns>    procedure GetPenultimateLoginDateTime(): DateTime    var        UserLoginTimeTrackerImpl: Codeunit "User Login Time Tracker Impl.";    begin        exit(UserLoginTimeTrackerImpl.GetPenultimateLoginDateTime(UserSecurityId()));    end;    /// <summary>    /// Returns the penultimate login DateTime of a user for the current company.    /// </summary>    /// <param name="UserSecurityID">The security ID of the user.</param>    /// <returns>The penultimate login DateTime of a user, or 0DT if the user login cannot be found.</returns>    procedure GetPenultimateLoginDateTime(UserSecurityID: Guid): DateTime    var        UserLoginTimeTrackerImpl: Codeunit "User Login Time Tracker Impl.";    begin        exit(UserLoginTimeTrackerImpl.GetPenultimateLoginDateTime(UserSecurityID));    end;    /// <summary>    /// Updates or creates the last login information of the current user (first, last and penultimate login date) for the current company.    /// </summary>    [Scope('OnPrem')]    procedure CreateOrUpdateLoginInfo()    var        UserLoginTimeTrackerImpl: Codeunit "User Login Time Tracker Impl.";    begin        UserLoginTimeTrackerImpl.CreateOrUpdateLoginInfo();    end;    /// <summary>    /// Creates login information of the current user for the environment.    /// </summary>    [Scope('OnPrem')]    procedure CreateEnvironmentLoginInfo()    var        UserLoginTimeTrackerImpl: Codeunit "User Login Time Tracker Impl.";    begin        UserLoginTimeTrackerImpl.CreateEnvironmentLoginInfo();    end;}