2024.4 Add-on API changes

[NVDA Add-on API Announcements]

Reminder, this mailing list is read only, please provide feedback by replying directly to emails, or via GitHub.
This list is intended to notify of changes to the add-on API, for confirmation of the latest state for breakages or deprecations, please refer to the 'changes file' for the NVDA release you are interested in.

Add-on API changes have been merged, planned for inclusion in the 2024.4 release:
"Revert disabling handling of caret notifications for UIA #16817"

Deprecations:

• NVDAObjects.UIA.InaccurateTextChangeEventEmittingEditableText is deprecated with no replacement.

If API breaks or planned future breaks (deprecations) will cause difficulties for the ongoing development of an add-on you maintain, please let NVDA developers know by replying directly to emails, or via GitHub.

[NVDA Add-on API Announcements]

Add-on API changes have been merged, planned for inclusion in the 2023.3 release:

"Separate font attribute reporting between speech and braille #16748"

If API breaks or planned future breaks (deprecations) will cause difficulties for the ongoing development of an add-on you maintain, please let NVDA developers know by replying directly to emails, or via GitHub.

Deprecations:

• The bool configuration key [documentFormatting][reportFontAttributes] is deprecated for removal in 2025.1, instead use [fontAttributeReporting]
  • The new key has an int value matching an OutputMode IntFlag enum with options for speech, braille, speech and braille and off.
  • API consumers can use the bool value as previously, or check the OutputMode if handling speech or braille specifically.
  • These keys will be synchronized until 2025.1.

[Sascha Cowley]

2024.4beta1 has been released, this means the add-on API for 2024.4 should be relatively stable.

When 2024.4rc1 is released, the API will be considered final (given emergency exceptions).

Add-on authors are now encouraged to test their add-on with the 2024.4 API using 2024.4beta1.

Authors should also consider making a beta or dev add-on release to the Add-on Store, for users to test their add-on with the beta.

[Sascha Cowley]

2024.4beta3 has been released.
This is the last planned beta for 2024.4.
This means the add-on API for 2024.4 should be almost final.

When 2024.4rc1 is released, the API will be considered final (given emergency exceptions).

Add-on authors are now encouraged to perform final testing for their add-on with the 2024.4 API using 2024.4beta3.

Authors should also consider making a beta or dev add-on release to the Add-on Store, for users to test their add-on with the beta.

[NVDA Add-on API Announcements]

2024.4beta4 has been released. This is the last planned beta for 2024.4. This means the add-on API for 2024.4 should be almost final. When 2024.4rc1 is released, the API will be considered final (given emergency exceptions)..

Add-on authors are now encouraged to perform final testing for their add-on with the 2024.4 API using 2024.4beta4. Authors should also consider making a beta or dev add-on release to the Add-on Store, for users to test their add-on with the beta.

[NVDA Add-on API Announcements]

2024.4beta5 has been released. This is the last planned beta for 2024.4. This means the add-on API for 2024.4 should be almost final. When 2024.4rc1 is released, the API will be considered final (given emergency exceptions).

Add-on authors are now encouraged to perform final testing for their add-on with the 2024.4 API using 2024.4beta4. Authors should also consider making a beta or dev add-on release to the Add-on Store, for users to test their add-on with the beta.

[NVDA Add-on API Announcements]

2024.4rc1 has been released.This means the add-on API for 2024.4 is final.

Add-on authors are now encouraged to perform final testing and release their add-on marked as compatible with the 2024.4 API. Add-ons marked as compatible with 2024.4 can now be submitted to the add-on store using the stable channel.