Codeunit 4315 Agent Task Builder

System Application, System.Agents

src/System Application/App/Agent/Interaction/AgentTaskBuilder.Codeunit.al172 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.Agents;using System.Environment;/// <summary>/// This codeunit is used to create an agent task./// </summary>codeunit 4315 "Agent Task Builder"{    InherentEntitlements = X;    InherentPermissions = X;    var        AgentTaskBuilderImpl: Codeunit "Agent Task Builder Impl.";        FeatureAccessManagement: Codeunit "Feature Access Management";    /// <summary>    /// Initialize the agent task builder with the mandatory parameters.    /// </summary>    /// <param name="AgentUserSecurityID">The user security ID of the agent.</param>    /// <param name="ConversationId">The conversation ID to check.</param>    /// <returns>This instance of the Agent Task Builder.</returns>    procedure Initialize(NewAgentUserSecurityId: Guid; NewTaskTitle: Text[150]): codeunit "Agent Task Builder"    begin        FeatureAccessManagement.AgentManagementAllowed(true);        AgentTaskBuilderImpl.Initialize(NewAgentUserSecurityId, NewTaskTitle);        exit(this);    end;    /// <summary>    /// Create a new task for the agent.    /// </summary>    /// <returns>Agent task that was created.</returns>    /// <remarks>The builder keeps the state, do not reuse the same instance of the builder to create multiple tasks.</remarks>    procedure Create(): Record "Agent Task"    begin        FeatureAccessManagement.AgentManagementAllowed(true);        exit(AgentTaskBuilderImpl.Create(true, true));    end;    /// <summary>    /// Create a new task for the agent.    /// </summary>    /// <param name="SetTaskStatusToReady">Specifies if the task status should be set to ready after creation.</param>    /// <returns>Agent task that was created.</returns>    /// <remarks>The builder keeps the state, do not reuse the same instance of the builder to create multiple tasks.</remarks>    procedure Create(SetTaskStatusToReady: Boolean): Record "Agent Task"    begin        FeatureAccessManagement.AgentManagementAllowed(true);        exit(AgentTaskBuilderImpl.Create(SetTaskStatusToReady, true));    end;    /// <summary>    /// Create a new task for the agent.    /// </summary>    /// <param name="SetTaskStatusToReady">Specifies if the task status should be set to ready after creation.</param>    /// <param name="RequiresMessage">Specifies whether a message is required, default is true.</param>    /// <returns>Agent task that was created.</returns>    /// <remarks>The builder keeps the state, do not reuse the same instance of the builder to create multiple tasks.</remarks>    procedure Create(SetTaskStatusToReady: Boolean; RequiresMessage: Boolean): Record "Agent Task"    begin        FeatureAccessManagement.AgentManagementAllowed(true);        exit(AgentTaskBuilderImpl.Create(SetTaskStatusToReady, RequiresMessage));    end;    /// <summary>    /// Get the agent task message that was created.    /// </summary>    /// <returns>    /// The agent task message that was created.    /// </returns>    procedure GetAgentTaskMessageCreated(): Record "Agent Task Message"    begin        FeatureAccessManagement.AgentManagementAllowed(true);        exit(AgentTaskBuilderImpl.GetAgentTaskMessageCreated());    end;    /// <summary>    /// Set the external ID of the task.    /// </summary>    /// <param name="ExternalId">The external ID of the task. This field is used to connect to external systems, like Message ID for emails.</param>    /// <returns>This instance of the Agent Task Builder.</returns>    procedure SetExternalId(ExternalId: Text[2048]): codeunit "Agent Task Builder"    begin        FeatureAccessManagement.AgentManagementAllowed(true);        AgentTaskBuilderImpl.SetExternalId(ExternalId);        exit(this);    end;    /// <summary>    /// Set the model ID that will be used to process the task.    /// If the model ID is not set, the model from the agent will be used, if any.    /// If the agent does not have a model, the default model will be used.    /// </summary>    /// <param name="ModelId">The model ID of the task. This field is used to connect to external systems, like Message ID for emails.</param>    /// <returns>This instance of the Agent Task Builder.</returns>    procedure SetModelId(ModelId: Code[30]): codeunit "Agent Task Builder"    begin        FeatureAccessManagement.AgentManagementAllowed(true);        AgentTaskBuilderImpl.SetModelId(ModelId);        exit(this);    end;    /// <summary>    /// Set the billing context for the task.    /// </summary>    /// <param name="BillingContext">The billing context to set on the task.</param>    /// <returns>This instance of the Agent Task Builder.</returns>    [Scope('OnPrem')]    procedure SetBillingContext(BillingContext: Enum "Agent Task Billing Context"): codeunit "Agent Task Builder"    begin        FeatureAccessManagement.AgentTaskManagementPreviewEnabled(true);        AgentTaskBuilderImpl.SetBillingContext(BillingContext);        exit(this);    end;    /// <summary>    /// Add a task message to the task.    /// Only a single message can be added to the task.    /// </summary>    /// <param name="From">The sender of the message.</param>    /// <param name="MessageText">The message text.</param>    /// <returns>This instance of the Agent Task Builder.</returns>    procedure AddTaskMessage(From: Text[250]; MessageText: Text): codeunit "Agent Task Builder"    begin        FeatureAccessManagement.AgentManagementAllowed(true);        AgentTaskBuilderImpl.AddTaskMessage(From, MessageText);        exit(this);    end;    /// <summary>    /// Add a task message to the task.    /// Only a single message can be added to the task.    /// </summary>    /// <param name="AgentTaskMessageBuilder">The agent task message builder.</param>    /// <returns>This instance of the Agent Task Builder.</returns>    procedure AddTaskMessage(var AgentTaskMessageBuilder: Codeunit "Agent Task Message Builder"): codeunit "Agent Task Builder"    begin        FeatureAccessManagement.AgentManagementAllowed(true);        AgentTaskBuilderImpl.AddTaskMessage(AgentTaskMessageBuilder);        exit(this);    end;    /// <summary>    /// Get the agent task message builder.    /// </summary>    /// <returns>The agent task message builder.</returns>    procedure GetTaskMessageBuilder(): Codeunit "Agent Task Message Builder"    begin        FeatureAccessManagement.AgentManagementAllowed(true);        exit(AgentTaskBuilderImpl.GetTaskMessageBuilder());    end;    /// <summary>    /// Check if a task exists for the given agent user and conversation    /// </summary>    /// <param name="AgentUserSecurityID">The user security ID of the agent.</param>    /// <param name="ConversationId">The conversation ID to check.</param>    /// <returns>True if task exists, false if not.</returns>    procedure TaskExists(AgentUserSecurityId: Guid; ConversationId: Text): Boolean    var        AgentTaskImpl: Codeunit "Agent Task Impl.";    begin        FeatureAccessManagement.AgentManagementAllowed(true);        exit(AgentTaskImpl.TaskExists(AgentUserSecurityId, ConversationId));    end;}