Microsoft/bcquality
1
0
Fork 0
mirror of https://github.com/microsoft/BCQuality.git synced 2026-08-06 17:36:53 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
bcquality/microsoft/knowledge/interfaces/extend-published-interfaces-dont-edit-them.md
Jesper Schulz-Wedde 363f08f47e
Add P0 event and interface compatibility knowledge (#98) 
* Add P0 extensibility compatibility knowledge

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 645349fd-1892-48f3-8a84-db77d6abd1c3

* Correct event compatibility guidance

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 645349fd-1892-48f3-8a84-db77d6abd1c3

---------

Co-authored-by: Jesper Schulz-Wedde <jesper.schulzwedde@microsoft.com>
2026-07-14 12:51:59 +02:00

1.4 KiB
Raw Permalink Blame History

bc-version domain keywords technologies countries application-area
16..
interfaces
published-interface
interface-method
breaking-change
interface-extends
versioned-interface
appsourcecop
as0066
al
w1
all

Extend published interfaces; do not edit them

Description

Adding a method to a shipped interface changes the contract every implementing codeunit must satisfy. Implementers can live in dependent extensions, so the addition breaks code the interface publisher cannot update; AppSourceCop reports AS0066. Interface inheritance is available from runtime 14.0 (Business Central 2024 release wave 2, BC25), but the original interface must remain unchanged.

Best Practice

On BC25 or later, declare a new interface that extends the published interface and add the new method there. Existing implementers remain valid for the original contract, while new implementers opt in to the extended contract. For targets BC16 through BC24, where interface inheritance is unavailable, publish a new or versioned sibling interface instead.

See sample: extend-published-interfaces-dont-edit-them.good.al.

Anti Pattern

Adding a procedure directly to an interface that has already shipped. Every dependent implementation must immediately add that procedure, so an otherwise compatible app update breaks its implementers.

See sample: extend-published-interfaces-dont-edit-them.bad.al.