Class: SnippetFilter

filterClasses.SnippetFilter()

Class for snippet filters

Constructor

new SnippetFilter()

Source:

Extends

Members

disabled :boolean

Defines whether the filter is disabled globally.

Type:
  • boolean
Inherited From:
Deprecated:
Source:

disabledSubscriptions :Set.<string>

Defines which subscriptions the filter is disabled for. See module:filterClasses.ActiveFilter#isDisabledForSubscription and module:filterClasses.ActiveFilter#setDisabledForSubscription for disabling and enabling filters.

Type:
  • Set.<string>
Inherited From:
Source:

(nullable) domains :Map.<string, boolean>

Map containing domains that this filter should match on/not match on or null if the filter should match on all domains

Type:
  • Map.<string, boolean>
Inherited From:
Source:

domainSeparator :string

Separator character used in domainSource property

Type:
  • string
Inherited From:
Source:

(nullable) domainSource :string

String that the domains property should be generated from

Type:
  • string
Inherited From:
Source:

hitCount :number

Number of hits on the filter since the last reset

Type:
  • number
Inherited From:
Source:

lastHit :number

Last time the filter had a hit (in milliseconds since the beginning of the epoch)

Type:
  • number
Inherited From:
Source:

requiresPrivilegedSubscription :bool

True if filter should only be loaded if it comes from a privileged subscription (circumvention subscriptions or special subscriptions).

Type:
  • bool
Overrides:
Source:

script :string

Script that should be executed

Type:
  • string
Source:

(nullable) sitekeys :Array.<string>

Array containing public keys of websites that this filter should apply to

Type:
  • Array.<string>
Inherited From:
Source:

(nullable) sitekeySource :string

String that the sitekey property should be generated from

Type:
  • string
Inherited From:
Source:

size :number

Number of filters contained, will always be 1 (required to optimize Matcher).

Type:
  • number
Inherited From:
Source:

type :string

Filter type as a string, e.g. "blocking".

Can be blocking, allowing, elemhide, elemhideexception, elemhideemulation, snippet, comment or invalid.

Type:
  • string
Overrides:
Source:

Methods

isActiveOnDomain(docDomainopt, nullable, sitekeyopt) → {boolean}

Checks whether this filter is active on a domain.

Parameters:
Name Type Attributes Description
docDomain string <optional>
<nullable>

domain name of the document that loads the URL

sitekey string <optional>

public key provided by the document

Inherited From:
Source:
Returns:

true in case of the filter being active

Type
boolean

isActiveOnlyOnDomain(docDomainopt, nullable) → {boolean}

Checks whether this filter is active only on a domain and its subdomains.

Parameters:
Name Type Attributes Description
docDomain string <optional>
<nullable>
Inherited From:
Source:
Returns:
Type
boolean

isDisabledForSubscription(subscriptionUrl) → {boolean}

Checks whether this filter is disabled.

Parameters:
Name Type Description
subscriptionUrl string

The subscription to check for enabled / disabled state.

Inherited From:
Source:
Returns:

true if the filter is disabled

Type
boolean

isGeneric() → {boolean}

Checks whether this filter is generic or specific

Inherited From:
Source:
Returns:
Type
boolean

setDisabledForSubscription(subscriptionUrlopt, valueopt)

Disables or enables the filter.

Parameters:
Name Type Attributes Description
subscriptionUrl string <optional>

The subscription on which to disable / enable the filter.

value boolean <optional>

new disabled value, true for disabled and false for enabled

Inherited From:
Source: