Codeunit 1992 Checklist, source in 24

// ------------------------------------------------------------------------------------------------
// 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.Security.AccessControl;
using System.Reflection;

/// <summary>
/// Manage the checklist presented to users by inserting and deleting checklist items and controling the visibility of the checklist.
/// </summary>
codeunit 1992 Checklist
{
    Access = Public;

    var
        ChecklistImplementation: Codeunit "Checklist Implementation";

    /// <summary>
    /// Inserts a new checklist item.
    /// </summary>
    /// <param name="GuidedExperienceType">The type of guided experience item that the checklist item references.</param>
    /// <param name="ObjectTypeToRun">The object type run by the guided experience item that the checklist item references.</param>
    /// <param name="ObjectIDToRun">The object ID run by the guided experience item that the checklist item references.</param>
    /// <param name="OrderID">The index at which this checklist item should appear in the list. Please be aware that if other extensions also insert checklist items, then this ID might not match the index in the list.</param>
    /// <param name="TempAllProfile">The roles that this checklist item should be displayed for.</param>
    /// <param name="ShouldEveryoneComplete">Boolean value that controls whether everyone should complete this checklist item. If false, the checklist item will be marked as completed for everyone, even if only one person completes it.</param>
    procedure Insert(GuidedExperienceType: Enum "Guided Experience Type"; ObjectTypeToRun: ObjectType; ObjectIDToRun: Integer; OrderID: Integer; var TempAllProfile: Record "All Profile" temporary; ShouldEveryoneComplete: Boolean)
    var
        TempUser: Record User temporary;
        SpotlightTourType: Enum "Spotlight Tour Type";
    begin
        ChecklistImplementation.Insert(GuidedExperienceType, ObjectTypeToRun, ObjectIDToRun, '', SpotlightTourType::None,
            ShouldEveryoneComplete, OrderID, TempAllProfile, TempUser);
    end;

    /// <summary>
    /// Inserts a new checklist item.
    /// </summary>
    /// <param name="GuidedExperienceType">The type of guided experience item that the checklist item references.</param>
    /// <param name="ObjectTypeToRun">The object type run by the guided experience item that the checklist item references.</param>
    /// <param name="ObjectIDToRun">The object ID run by the guided experience item that the checklist item references.</param>
    /// <param name="OrderID">The index at which this checklist item should appear in the list. Please be aware that if other extensions also insert checklist items, then this ID might not match the index in the list.</param>
    /// <param name="TempUser">The users that this checklist item should be displayed for.</param>
    procedure Insert(GuidedExperienceType: Enum "Guided Experience Type"; ObjectTypeToRun: ObjectType; ObjectIDToRun: Integer; OrderID: Integer; var TempUser: Record User temporary)
    var
        TempAllProfile: Record "All Profile" temporary;
        CompletionRequirements: Enum "Checklist Completion Requirements";
        SpotlightTourType: Enum "Spotlight Tour Type";
    begin
        ChecklistImplementation.Insert(GuidedExperienceType, ObjectTypeToRun, ObjectIDToRun, '', SpotlightTourType::None,
             CompletionRequirements::"Specific users", OrderID, TempAllProfile, TempUser);
    end;

    /// <summary>
    /// Inserts a new checklist item.
    /// </summary>
    /// <param name="GuidedExperienceType">The type of guided experience item that the checklist item references.</param>
    /// <param name="Link">The URL that is open by the guided experience item that the checklist item references.</param>
    /// <param name="OrderID">The index at which this checklist item should appear in the list. Please be aware that if other extensions also insert checklist items, then this ID might not match the index in the list.</param>
    /// <param name="TempAllProfile">The roles that this checklist item should be displayed for.</param>
    /// <param name="ShouldEveryoneComplete">Boolean value that controls whether everyone should complete this checklist item. If false, the checklist item will be marked as completed for everyone, even if only one person completes it.</param>
    procedure Insert(GuidedExperienceType: Enum "Guided Experience Type"; Link: Text[250]; OrderID: Integer; var TempAllProfile: Record "All Profile" temporary; ShouldEveryoneComplete: Boolean)
    var
        TempUser: Record User temporary;
        SpotlightTourType: Enum "Spotlight Tour Type";
    begin
        ChecklistImplementation.Insert(GuidedExperienceType, ObjectType::MenuSuite, 0, Link, SpotlightTourType::None,
            ShouldEveryoneComplete, OrderID, TempAllProfile, TempUser);
    end;

    /// <summary>
    /// Inserts a new checklist item.
    /// </summary>
    /// <param name="GuidedExperienceType">The type of guided experience item that the checklist item references.</param>
    /// <param name="Link">The URL that is open by the guided experience item that the checklist item references.</param>
    /// <param name="OrderID">The index at which this checklist item should appear in the list. Please be aware that if other extensions also insert checklist items, then this ID might not match the index in the list.</param>
    /// <param name="TempUser">The users that this checklist item should be displayed for.</param>
    procedure Insert(GuidedExperienceType: Enum "Guided Experience Type"; Link: Text[250]; OrderID: Integer; var TempUser: Record User temporary)
    var
        TempAllProfile: Record "All Profile" temporary;
        CompletionRequirements: Enum "Checklist Completion Requirements";
        SpotlightTourType: Enum "Spotlight Tour Type";
    begin
        ChecklistImplementation.Insert(GuidedExperienceType, ObjectType::MenuSuite, 0, Link, SpotlightTourType::None,
            CompletionRequirements::"Specific users", OrderID, TempAllProfile, TempUser);
    end;

    /// <summary>
    /// Inserts a new checklist item for a spotlight tour.
    /// </summary>
    /// <param name="PageID">The ID of the page that the spotlight tour will run on.</param>
    /// <param name="SpotlightTourType">The type of spotlight tour.</param>
    /// <param name="OrderID">The index at which this checklist item should appear in the list. Please be aware that if other extensions also insert checklist items, then this ID might not match the index in the list.</param>
    /// <param name="TempAllProfile">The roles that this checklist item should be displayed for.</param>
    /// <param name="ShouldEveryoneComplete">Boolean value that controls whether everyone should complete this checklist item. If false, the checklist item will be marked as completed for everyone, even if only one person completes it.</param>
    procedure Insert(PageID: Integer; SpotlightTourType: Enum "Spotlight Tour Type"; OrderID: Integer; var TempAllProfile: Record "All Profile" temporary; ShouldEveryoneComplete: Boolean)
    var
        TempUser: Record User temporary;
        GuidedExperienceType: Enum "Guided Experience Type";
    begin
        ChecklistImplementation.Insert(GuidedExperienceType::"Spotlight Tour", ObjectType::Page, PageID, '', SpotlightTourType,
            ShouldEveryoneComplete, OrderID, TempAllProfile, TempUser);
    end;

    /// <summary>
    /// Inserts a new checklist item for a spotlight tour.
    /// </summary>
    /// <param name="PageID">The ID of the page that the spotlight tour will run on.</param>
    /// <param name="SpotlightTourType">The type of spotlight tour.</param>
    /// <param name="OrderID">The index at which this checklist item should appear in the list. Please be aware that if other extensions also insert checklist items, then this ID might not match the index in the list.</param>
    /// <param name="TempAllProfile">The roles that this checklist item should be displayed for.</param>
    /// <param name="ShouldEveryoneComplete">Boolean value that controls whether everyone should complete this checklist item. If false, the checklist item will be marked as completed for everyone, even if only one person completes it.</param>
    procedure Insert(PageID: Integer; SpotlightTourType: Enum "Spotlight Tour Type"; OrderID: Integer; var TempUser: Record User temporary)
    var
        TempAllProfile: Record "All Profile" temporary;
        CompletionRequirements: Enum "Checklist Completion Requirements";
        GuidedExperienceType: Enum "Guided Experience Type";
    begin
        ChecklistImplementation.Insert(GuidedExperienceType::"Spotlight Tour", ObjectType::Page, PageID, '', SpotlightTourType,
            CompletionRequirements::"Specific users", OrderID, TempAllProfile, TempUser);
    end;

    /// <summary>
    /// Deletes a checklist item.
    /// </summary>
    /// <param name="GuidedExperienceType">The type of guided experience item that the checklist item references.</param>
    /// <param name="ObjectTypeToRun">The object type run by the guided experience item that the checklist item references.</param>
    /// <param name="ObjectIDToRun">The object ID run by the guided experience item that the checklist item references.</param>
    procedure Delete(GuidedExperienceType: Enum "Guided Experience Type"; ObjectTypeToRun: ObjectType; ObjectID: Integer)
    var
        SpotlightTourType: Enum "Spotlight Tour Type";
    begin
        ChecklistImplementation.Delete(GuidedExperienceType, ObjectTypeToRun, ObjectID, '', SpotlightTourType::None);
    end;

    /// <summary>
    /// Deletes a checklist item.
    /// </summary>
    /// <param name="GuidedExperienceType">The type of guided experience item that the checklist item references.</param>
    /// <param name="Link">The URL that is open by the guided experience item that the checklist item references.</param>
    procedure Delete(GuidedExperienceType: Enum "Guided Experience Type"; Link: Text[250])
    var
        SpotlightTourType: Enum "Spotlight Tour Type";
    begin
        ChecklistImplementation.Delete(GuidedExperienceType, ObjectType::MenuSuite, 0, Link, SpotlightTourType::None);
    end;

    /// <summary>
    /// Deletes a spotlight tour checklist item.
    /// </summary>
    /// <param name="PageID">The ID of the page that the spotlight tour runs on.</param>
    /// <param name="SpotlightTourType">The type of spotlight tour.</param>
    procedure Delete(PageID: Integer; SpotlightTourType: Enum "Spotlight Tour Type")
    var
        GuidedExperienceType: Enum "Guided Experience Type";
    begin
        ChecklistImplementation.Delete(GuidedExperienceType::"Spotlight Tour", ObjectType::Page, PageID, '', SpotlightTourType);
    end;

    /// <summary>
    /// Checks whether the checklist should be initialized for the current company.
    /// </summary>
    /// <param name="ShouldSkipForEvaluationCompany">If true, then the function will always return false for evaluation companies.</param>
    /// <returns>True if the checklist should be initialized and false otherwise.</returns>
    procedure ShouldInitializeChecklist(ShouldSkipForEvaluationCompany: Boolean): Boolean
    begin
        exit(ChecklistImplementation.ShouldInitializeChecklist(ShouldSkipForEvaluationCompany));
    end;

    /// <summary>
    /// Marks the checklist setup in progress.
    /// </summary>
    procedure MarkChecklistSetupInProgress()
    var
        CallerModuleInfo: ModuleInfo;
    begin
        NavApp.GetCallerModuleInfo(CallerModuleInfo);

        ChecklistImplementation.MarkChecklistSetupInProgress(CallerModuleInfo);
    end;

    /// <summary>
    /// Marks the checklist setup as done.
    /// </summary>
    procedure MarkChecklistSetupAsDone()
    var
        CallerModuleInfo: ModuleInfo;
    begin
        NavApp.GetCallerModuleInfo(CallerModuleInfo);

        ChecklistImplementation.MarkChecklistSetupAsDone(CallerModuleInfo);
    end;

    /// <summary>
    /// Initializes the guided experience items. Mostly called once in a company's lifecycle from BaseApp, if used in an extension, please see also ShouldInitializeChecklist.
    /// </summary>
    procedure InitializeGuidedExperienceItems()
    var
        CallerModuleInfo: ModuleInfo;
    begin
        NavApp.GetCallerModuleInfo(CallerModuleInfo);

        ChecklistImplementation.InitializeGuidedExperienceItems(CallerModuleInfo);
    end;

    /// <summary>
    /// Updates the user name for checklist records that have it as a primary key.
    /// </summary>
    /// <param name="RecordRef">The recordref that poins to the record that is to be modified.</param>
    /// <param name="Company">The company in which the table is to be modified.</param>
    /// <param name="UserName">The new user name.</param>
    /// <param name="TableID">The table for which the user name is to be modified.</param>
    procedure UpdateUserName(var RecordRef: RecordRef; Company: Text[30]; UserName: Text[50]; TableID: Integer)
    begin
        ChecklistImplementation.UpdateUserName(RecordRef, Company, UserName, TableID);
    end;

    /// <summary>
    /// Checks whether the checklist is visible for the current user on the profile that the user is currently on.
    /// </summary>
    /// <returns>True if the checklist is visible and false otherwise.</returns>
    procedure IsChecklistVisible(): Boolean
    begin
        exit(ChecklistImplementation.IsChecklistVisible());
    end;

    /// <summary>
    /// Sets the checklist visibility for the current user and the profile that the user is currently using.
    /// </summary>
    /// <param name="Visible">True if the checklist should be visible and false otherwise.</param>
    procedure SetChecklistVisibility(Visible: Boolean)
    begin
        ChecklistImplementation.SetChecklistVisibility(UserId(), Visible);
    end;

    /// <summary>
    /// Event that is triggered when the checklist is being loaded.
    /// </summary>
    [IntegrationEvent(false, false)]
    internal procedure OnChecklistLoading()
    begin
    end;
}