Share via

Codeunit "Copilot Capability"

ID 7773
Namespace: System.AI

The Copilot Capability codeunit is used to register, modify, and delete Copilot capabilities.

Properties

Name Value
Access Public
InherentEntitlements X
InherentPermissions X

Methods

RegisterCapability

Register a capability.

procedure RegisterCapability(CopilotCapability: Enum "Copilot Capability", LearnMoreUrl: Text[2048])

Parameters

Name Type Description
CopilotCapability Enum System.AI."Copilot Capability"

The capability.
LearnMoreUrl Text[2048]

The learn more url.

RegisterCapability

Obsolete

This element will become obsolete from version 27.0. Using RegisterCapability now requires additional input parameter, BillingType. Use the other overload for RegisterCapability instead.

Register a capability.

[Obsolete(Using RegisterCapability now requires additional input parameter, BillingType. Use the other overload for RegisterCapability instead.,27.0)]
procedure RegisterCapability(CopilotCapability: Enum "Copilot Capability", CopilotAvailability: Enum "Copilot Availability", LearnMoreUrl: Text[2048])

Parameters

Name Type Description
CopilotCapability Enum System.AI."Copilot Capability"

The capability.
CopilotAvailability Enum System.AI."Copilot Availability"

The availability.
LearnMoreUrl Text[2048]

The learn more url.

RegisterCapability

Register a capability.

procedure RegisterCapability(CopilotCapability: Enum "Copilot Capability", CopilotAvailability: Enum "Copilot Availability", CopilotBillingType: Enum "Copilot Billing Type", LearnMoreUrl: Text[2048])

Parameters

Name Type Description
CopilotCapability Enum System.AI."Copilot Capability"

The capability.
CopilotAvailability Enum System.AI."Copilot Availability"

The availability.
CopilotBillingType Enum System.AI."Copilot Billing Type"

BillingType.
LearnMoreUrl Text[2048]

The learn more url.

ModifyCapability

Obsolete

This element will become obsolete from version 27.0. Using ModifyCapability now requires additional input parameter, BillingType. Use the other overload for ModifyCapability instead.

Modify an existing capability.

[Obsolete(Using ModifyCapability now requires additional input parameter, BillingType. Use the other overload for ModifyCapability instead.,27.0)]
procedure ModifyCapability(CopilotCapability: Enum "Copilot Capability", CopilotAvailability: Enum "Copilot Availability", LearnMoreUrl: Text[2048])

Parameters

Name Type Description
CopilotCapability Enum System.AI."Copilot Capability"

The capability.
CopilotAvailability Enum System.AI."Copilot Availability"

The availability.
LearnMoreUrl Text[2048]

The learn more url.

ModifyCapability

Modify an existing capability.

procedure ModifyCapability(CopilotCapability: Enum "Copilot Capability", CopilotAvailability: Enum "Copilot Availability", CopilotBillingType: Enum "Copilot Billing Type", LearnMoreUrl: Text[2048])

Parameters

Name Type Description
CopilotCapability Enum System.AI."Copilot Capability"

The capability.
CopilotAvailability Enum System.AI."Copilot Availability"

The availability.
CopilotBillingType Enum System.AI."Copilot Billing Type"

BillingType.
LearnMoreUrl Text[2048]

The learn more url.

UnregisterCapability

Unregister a capability.

procedure UnregisterCapability(CopilotCapability: Enum "Copilot Capability")

Parameters

Name Type Description
CopilotCapability Enum System.AI."Copilot Capability"

The capability.

IsCapabilityRegistered

Check if your capability has been registered.

procedure IsCapabilityRegistered(CopilotCapability: Enum "Copilot Capability"): Boolean

Parameters

Name Type Description
CopilotCapability Enum System.AI."Copilot Capability"

The capability.

Returns

Type Description
Boolean

True if the capability has been registered.

Remarks

Capabilities are tied to the module registering it. Checking for a capability will check if the enum and app id of your module exists.

IsCapabilityRegistered

Check if a specific capability has been registered.

procedure IsCapabilityRegistered(CopilotCapability: Enum "Copilot Capability", AppId: Guid): Boolean

Parameters

Name Type Description
CopilotCapability Enum System.AI."Copilot Capability"

The capability.
AppId Guid

The app id associated with the capability.

Returns

Type Description
Boolean

True if the capability has been registered.

Remarks

Capabilities are tied to the module registering it. Checking for a capability will check if the enum and app id of the module exists.

IsCapabilityActive

Check if your capability is active.

procedure IsCapabilityActive(CopilotCapability: Enum "Copilot Capability"): Boolean

Parameters

Name Type Description
CopilotCapability Enum System.AI."Copilot Capability"

The capability.

Returns

Type Description
Boolean

True if the capability is active.

IsCapabilityActive

Check if the capability is active.

procedure IsCapabilityActive(CopilotCapability: Enum "Copilot Capability", AppId: Guid): Boolean

Parameters

Name Type Description
CopilotCapability Enum System.AI."Copilot Capability"

The capability.
AppId Guid

The app id associated with the capability.

Returns

Type Description
Boolean

True if the capability is active.

Events

OnGetRequiredPrivacyNotices

Event that is raised to specify if a Copilot capability depends on any additional privacy notices.

[IntegrationEvent(False,False)]
procedure OnGetRequiredPrivacyNotices(CopilotCapability: Enum "Copilot Capability", AppId: Guid, var RequiredPrivacyNotices: List of [Code[50]])

Parameters

Name Type Description
CopilotCapability Enum System.AI."Copilot Capability"

The capability.
AppId Guid

The app id associated with the capability.
RequiredPrivacyNotices List of [Code[50]]

The list of required privacy notices for the capability to be enabled.

See also