2023.1 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 2023.1 release:
PR #14233 "Fix config option conflicts"
Commit: 3200385e7a20622e2eaa21531a960ba375523935

Breaking changes:
- The configuration specification has been altered, keys have been removed or modified (#14233).
  - In [documentFormatting] section:
    - reportLineIndentation stores an int value (0 to 3) instead of a boolean
    - reportLineIndentationWithTones has been removed.
    - reportBorderStyle and reportBorderColor have been removed and are replaced by reportCellBorders.
  - In [braille] section:
    - noMessageTimeout has been removed, replaced by a value for showMessages.
    - messageTimeout cannot take the value 0 anymore, replaced by a value for showMessages.
    - autoTether has been removed; tetherTo can now take the value "auto" instead.

Deprecations:
- braille.BrailleHandler.TETHER_* are deprecated. Please use configFlags.TetherTo.*.value instead. (#14233)

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]

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 2023.1 release:

PR #14047 "Prototype for Windows Terminal: Use notifications instead of monitoring for new text"
Commit: 29ad48080593a00d8f9be76c0be27fbfe6adb163

Breaking changes:
- None

Deprecations:
- NVDAObjects.UIA.winConsoleUIA.WinTerminalUIA is deprecated, and usage is discouraged. (#14047)

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]

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 2023.1 release:

PR #14350 "Streamline importing of addon directories for python packages #14350"
Commit: 4ed2cd58c7f327a9942c70ad3cd2108bcf9d2cf1

Breaking changes:
None

Deprecations:
- config.addConfigDirsToPythonPackagePath has been moved. Use addonHandler.packaging.addDirsToPythonPackagePath instead. (#14350)

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]

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 2023.1 release:

PR #14449 " Support browse mode and other in-process scenarios for AMD64 apps when running on ARM64 Windows"
Commit: 2afab112b8e72c5a6b009f6e6ddee6252ab003ef

Breaking changes:
- NVDAHelper.RemoteLoader64 has been removed with no replacement. (#14449)

Deprecations:
None

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.1 release:

"Rename postSessionLockStateChanged to post_sessionLockStateChanged #14486"

Deprecations:
- utils.security.postSessionLockStateChanged is deprecated. Please use utils.security.post_sessionLockStateChanged instead.

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.1 release:

Remove deprecated functions from sessionTracking #14490

Breaking changes:

• The following functions in winAPI.sessionTracking have been removed with no replacement
  • isWindowsLocked
  • handleSessionChange
  • unregister
  • register
  • isLockStateSuccessfullyTracked

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.1 release:

"Report the presence of multiple annotations #14507"

Deprecations:
-- NVDAObject.hasDetails, NVDAObject.detailsSummary, NVDAObject.detailsRole has been deprecated, instead use NVDAObject.annotations.

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.1 release:

"Add Braille and Tones extension points to avoid monkey patching by API consumers (#14503)"

Breaking Changes:

- It is no longer possible to enable/disable the braille handler by setting braille.handler.enabled.

To disable the braille handler programmatically, register a handler to braille.handler.decide_enabled.

- It is no longer possible to update the display size of the handler by setting braille.handler.displaySize.

To update the displaySize programmatically, register a handler to braille.handler.filter_displaySize.

Refer to brailleViewer for an example on how to do this.

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.1 release:

"Swap pkgutil.ImpImporter for importlib when loading custom modules from add-ons #14481"

Breaking Changes:

• There have been changes to the usage of addonHandler.Addon.loadModule. (#14481)
  •  loadModule now expects dot as a separator, rather than backslash. For example "lib.example" instead of "lib\example".
•   loadModule now raises an exception when a module can't be loaded or has errors, instead of silently returning None without giving information about the cause.

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.1 release:

Removed inappropriate pending install item when accessing NVDA menu through systray (#14523)

Deprecations:

• gui.MainFrame.evaluateUpdatePendingUpdateMenuItemCommand has been deprecated.
  Use gui.MainFrame.SysTrayIcon.evaluateUpdatePendingUpdateMenuItemCommand instead.
  

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.1 release:

Avoid a situation where no NVDA modifier key is defined #14528

API Breaking Changes

• The configuration specification has been altered, keys have been removed or modified in the [keyboard] section:
  • useCapsLockAsNVDAModifierKey, useNumpadInsertAsNVDAModifierKey, useExtendedInsertAsNVDAModifierKey has been removed. They are replaced by NVDAModifierKeys.

Deprecations:

• keyboardHandler.SUPPORTED_NVDA_MODIFIER_KEYS is deprecated with no direct replacement. Consider using the class config.configFlags.NVDAKey instead.

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.1 release:

Lazily register for custom UIA properties and annotations #14248

API Breaking Changes

•  The following are no longer singletons - their get method has been removed. Usage of Example.get() is now Example().
  • UIAHandler.customAnnotations.CustomAnnotationTypesCommon
  • UIAHandler.customProps.CustomPropertiesCommon
  • NVDAObjects.UIA.excel.ExcelCustomProperties
  • NVDAObjects.UIA.excel.ExcelCustomAnnotationTypes

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.1 release:

Fix reporting time in foobar2000 over 24 hours (#14570).

API Breaking Changes

• The following symbols have been removed from appModules.foobar2000 with no direct replacement.
  • statusBarTimes
  • parseIntervalToTimestamp
  • getOutputFormat
  • getParsingFormat

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.