801423 - nsIWebBrowserPersist.saveURI and nsIDownloadManager.addDownload has new undocumented parameters

Status: RESOLVED FIXED

(Core :: General, defect)

Description

[Lars Viklund]

User Agent: Mozilla/5.0 (Windows NT 6.2; Win64; x64; rv:19.0) Gecko/19.0 Firefox/19.0
Build ID: 20121014030627

Steps to reproduce:

Existing calls to nsIWebBrowserPersist.saveURI and nsIDownloadManager.addDownload in an Firefox extension fail with NS_ERROR_XPC_NOT_ENOUGH_ARGS in Nightly.


Actual results:

It seems like both those methods have grown an additional argument undocumented on MDN.

addDownload has gained a boolean 'private', to indicate sensitivity of content.
saveURI has gained a nsILoadContext 'privacyContext' for some private browsing purposes.


Expected results:

MDN documentation should be kept reasonably up to date, I had to MXR to find out the actual signatures. Is it possible to have default parameters for perfectly functioning legacy code, or is silent breakage acceptable practice?

Comment 1

[Josh Matthews [:jdm]]

Agreed. I apologize for not doing it myself; bug 794602 and bug 795065 both have the dev-doc-needed flag, but those tend not to be heeded when those changes have only just been moved to Aurora builds.

Comment 2

[Boris Zbarsky [:bzbarsky]]

The other option is indeed to make the new argument optional....

Comment 3

[Josh Matthews [:jdm]]

The documentation for both interfaces has been updated. Please let me know if any information is unclear.