Public Member Functions | Public Attributes

nsIBlocklistService Interface Reference

import "nsIBlocklistService.idl";

List of all members.

Public Member Functions

boolean isAddonBlocklisted (in AString id, in AString version,[optional] in AString appVersion,[optional] in AString toolkitVersion)
 Determine if an item is blocklisted.
unsigned long getAddonBlocklistState (in AString id, in AString version,[optional] in AString appVersion,[optional] in AString toolkitVersion)
 Determine the blocklist state of an add-on.
unsigned long getPluginBlocklistState (in nsIPluginTag plugin,[optional] in AString appVersion,[optional] in AString toolkitVersion)
 Determine the blocklist state of a plugin.

Public Attributes

const unsigned long STATE_NOT_BLOCKED = 0
const unsigned long STATE_SOFTBLOCKED = 1
const unsigned long STATE_BLOCKED = 2
const unsigned long STATE_OUTDATED = 3

Member Function Documentation

unsigned long nsIBlocklistService::getAddonBlocklistState ( in AString  id,
in AString  version,
[optional] in AString  appVersion,
[optional] in AString  toolkitVersion 
)

Determine the blocklist state of an add-on.

Parameters:
id The ID of the item.
version The item's version.
appVersion 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 The version of the toolkit we are checking in the blocklist. If this parameter is null, the version of the running toolkit is used.
Returns:
The STATE constant.
unsigned long nsIBlocklistService::getPluginBlocklistState ( in nsIPluginTag  plugin,
[optional] in AString  appVersion,
[optional] in AString  toolkitVersion 
)

Determine the blocklist state of a plugin.

Parameters:
plugin The plugin to get the state for
appVersion 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 The version of the toolkit we are checking in the blocklist. If this parameter is null, the version of the running toolkit is used.
Returns:
The STATE constant.
boolean nsIBlocklistService::isAddonBlocklisted ( in AString  id,
in AString  version,
[optional] in AString  appVersion,
[optional] in AString  toolkitVersion 
)

Determine if an item is blocklisted.

Parameters:
id The ID of the item.
version The item's version.
appVersion 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 The version of the toolkit we are checking in the blocklist. If this parameter is null, the version of the running toolkit is used.
Returns:
true if the item is compatible with this version of the application or this version of the toolkit, false, otherwise.

Member Data Documentation

const unsigned long nsIBlocklistService::STATE_BLOCKED = 2
const unsigned long nsIBlocklistService::STATE_NOT_BLOCKED = 0
const unsigned long nsIBlocklistService::STATE_OUTDATED = 3
const unsigned long nsIBlocklistService::STATE_SOFTBLOCKED = 1

The documentation for this interface was generated from the following file: