612733 - rename "active" property to "isActive" and add activate(), deactivate() functions to Private Browsing API

Status: RESOLVED FIXED

(Add-on SDK Graveyard :: General, defect)

Description

[Myk Melez [:myk] [@mykmelez]]

The "active" boolean property in the Private Browsing API should be renamed to "isActive" per API naming guidelines, and activation/deactivation should be provided by activate() and deactivate() functions rather than by setting the property to make it clearer how to activate and deactivate private browsing and emphasize that those changes have side-effects.

Comment 1

[Drew Willcoxon :adw]

Attachment: patch

Comment 2

[Myk Melez [:myk] [@mykmelez]]

Comment on attachment 492559 [details] [diff] [review]
patch

> This module is available in all applications. However, only Firefox will ever
> transition into or out of private browsing mode. For all other applications,
>-`pb.active` will always return `false`, and none of the events will be emitted.
>+`pb.active` will always be `false`, and none of the events will be emitted.

This change is good but is insufficient, since the reference to pb.active should be changed to pb.isActive.


> <api name="active">
> @property {boolean}
>-This is a boolean. You can read this attribute to determine if private browsing
>-mode is active. You can also set the attribute to enter or exit private
>-browsing.

This has the same issue: <api name="active"> should be <api name="isActive">

Otherwise, this looks great, r=myk with those changes.

Comment 3

[Drew Willcoxon :adw]

Sloppy, thanks Myk.

https://github.com/mozilla/addon-sdk/commit/d932d8e14fda0e67396df9261c9485448cdb9bca

https://github.com/mozilla/addon-sdk/commit/a0d38ee0ba5ff7c0ab2132d466a310e07a3bea0a

https://github.com/mozilla/addon-sdk/commit/16155bcc3f944529d069ed30f22519f56168d53b