Codeunit "Agent Task"

ID 4303

Namespace: System.Agents

Properties

Name	Value
InherentEntitlements	X
InherentPermissions	X

Methods

TaskExists

Check if a task exists for the given agent user and conversation

procedure TaskExists(AgentUserSecurityId: Guid; ExternalId: Text): Boolean

Parameters

Name	Type	Description
AgentUserSecurityId	Guid	The user security ID of the agent.
ExternalId	Text	The external ID to check.

Returns

Type	Description
Boolean	True if task exists, false if not.

GetTaskByExternalId

procedure GetTaskByExternalId(AgentUserSecurityId: Guid; ExternalId: Text)

Parameters

Name	Type	Description
AgentUserSecurityId	Guid
ExternalId	Text

SetStatusToReady

procedure SetStatusToReady(AgentTask: __MissingTypeSymbol__)

Parameters

Name	Type	Description
AgentTask	__MissingTypeSymbol__

CanSetStatusToReady

procedure CanSetStatusToReady(AgentTask: __MissingTypeSymbol__): Boolean

Parameters

Name	Type	Description
AgentTask	__MissingTypeSymbol__

Returns

Type	Description
Boolean

StopTask

procedure StopTask(AgentTask: __MissingTypeSymbol__; UserConfirm: Boolean)

Parameters

Name	Type	Description
AgentTask	__MissingTypeSymbol__
UserConfirm	Boolean

RestartTask

procedure RestartTask(AgentTask: __MissingTypeSymbol__; UserConfirm: Boolean)

Parameters

Name	Type	Description
AgentTask	__MissingTypeSymbol__
UserConfirm	Boolean

IsTaskRunning

procedure IsTaskRunning(AgentTask: __MissingTypeSymbol__): Boolean

Parameters

Name	Type	Description
AgentTask	__MissingTypeSymbol__

Returns

Type	Description
Boolean

IsTaskCompleted

procedure IsTaskCompleted(AgentTask: __MissingTypeSymbol__): Boolean

Parameters

Name	Type	Description
AgentTask	__MissingTypeSymbol__

Returns

Type	Description
Boolean

IsTaskStopped

procedure IsTaskStopped(AgentTask: __MissingTypeSymbol__): Boolean

Parameters

Name	Type	Description
AgentTask	__MissingTypeSymbol__

Returns

Type	Description
Boolean

GetCopilotCreditsConsumed

Obsolete

This element will become obsolete from version 29.0. Use the methods in the "Agent Consumption Overview" codeunit instead.

Gets the total Copilot credits consumed by the agent task.

[Obsolete(Use the methods in the "Agent Consumption Overview" codeunit instead.,29.0)]
procedure GetCopilotCreditsConsumed(AgentTaskID: BigInteger): Decimal

Parameters

Name	Type	Description
AgentTaskID	BigInteger	The ID of the agent task to get consumed credits for.

Returns

Type	Description
Decimal	The total Copilot credits consumed by the agent task.

See also

• Codeunit