mozilla

nsIBlocklistService

Please add a summary to this article.
1.0
28
Introduced
Gecko 1.9
Inherits from: nsISupports Last changed in Gecko 29 (Firefox 29 / Thunderbird 29 / SeaMonkey 2.26)

 Firefox 29

Method overview

unsigned long getAddonBlocklistState(in jsval addon, [optional] in AString appVersion, [optional] in AString toolkitVersion);
unsigned long getPluginBlocklistState(in nsIPluginTag plugin, [optional] in AString appVersion, [optional] in AString toolkitVersion);
boolean isAddonBlocklisted(in jsval addon, [optional] in AString appVersion, [optional] in AString toolkitVersion);

Constants

Constant Value Description
STATE_NOT_BLOCKED 0
STATE_SOFTBLOCKED 1
STATE_BLOCKED 2
STATE_OUTDATED 3

Methods

Requires Gecko 1.9.1 (Firefox 3.5 / Thunderbird 3.0 / SeaMonkey 2.0)

getAddonBlocklistState()

Determine the blocklist state of an add-on.

unsigned long getAddonBlocklistState(
  in jsval addon,
  in AString appVersion, Optional
  in AString toolkitVersion Optional
);
Parameters
addon
The addon object whose blocklist state is to be determined.
appVersion Optional
The version of the application we are checking in the blocklist. If this parameter is null, the version of the running application is used.
toolkitVersion Optional
The version of the toolkit we are checking in the blocklist. If this parameter is null, the version of the running toolkit is used.
Return value

The blocklist state of the add-on, one of the Constants.

Requires Gecko 1.9.1 (Firefox 3.5 / Thunderbird 3.0 / SeaMonkey 2.0)

getPluginBlocklistState()

Determine the blocklist state of a plugin.

unsigned long getPluginBlocklistState(
  in nsIPluginTag plugin,
  in AString appVersion, Optional
  in AString toolkitVersion Optional
);
Parameters
plugin
The plugin to get the state for.
appVersion Optional
The version of the application we are checking in the blocklist. If this parameter is null, the version of the running application is used.
toolkitVersion Optional
The version of the toolkit we are checking in the blocklist. If this parameter is null, the version of the running toolkit is used.
Return value

The blocklist state of the plugin, one of the Constants.

isAddonBlocklisted()

Determine if an item is blocklisted.

boolean isAddonBlocklisted(
  in jsval addon,
  in AString appVersion, Optional from Gecko 1.9.1
  in AString toolkitVersion Optional from Gecko 1.9.1
);
Parameters
addon
The addon object to be checked.
appVersion Optional from Gecko 1.9.1
The version of the application we are checking in the blocklist. If this parameter is null, the version of the running application is used.
toolkitVersion Optional from Gecko 1.9.1
The version of the toolkit we are checking in the blocklist. If this parameter is null, the version of the running toolkit is used.
Return value

true if the item is blocklisted, otherwise false.

Document Tags and Contributors

Contributors to this page: Sheppy, trevorh, sachin.hosmani
Last updated by: Sheppy,