Class: AllowingFilter

filterClasses.AllowingFilter()

Class for allowing (allowlisting) filters

Constructor

new AllowingFilter()

Source:

Extends

Members

contentType :number

Content types the filter applies to, combination of values from module:contentTypes.contentTypes

Type:
  • number
Inherited From:
Source:

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

Inherited From:
Source:
See:
  • ActiveFilter.domainSeparator

(nullable) domainSource :string

String that the domains property should be generated from

Type:
  • string
Inherited From:
Source:

Header-based filtering expression. Refer to the filter documentation reference for the syntax, or BlockingFilter.filterHeaders for the reference implementation.

Type:
  • HttpHeader
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:

matchCase :boolean

Defines whether the filter should distinguish between lower and upper case letters

Type:
  • boolean
Inherited From:
Source:

(nullable) pattern :string

Expression from which a regular expression should be generated - for delayed creation of the regexp property.

Undefined if the filter uses a regex literal pattern.

Type:
  • string
Inherited From:
Deprecated:
Source:

regexp :RegExp

Regular expression to be used when testing against this pattern

Type:
  • RegExp
Inherited From:
Deprecated:
Source:

requiresPrivilegedSubscription :bool

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

Type:
  • bool
Inherited From:
Source:

(nullable) rewrite :string

The name of the internal resource to which to rewrite the URL. e.g. if the value of the $rewrite option is abp-resource:blank-html, this should be blank-html.

Type:
  • string
Inherited From:
Source:

sitekeys

Inherited From:
Source:
See:
  • ActiveFilter.sitekeys

sitekeySource

Inherited From:
Source:
See:
  • ActiveFilter.sitekeySource

size :number

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

Type:
  • number
Inherited From:
Source:

(nullable) thirdParty :boolean

Defines whether the filter should apply to third-party or first-party content only. Can be null (apply to all content).

Type:
  • boolean
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:

urlPattern :Pattern

Pattern for matching request URLs

Type:
  • Pattern
Inherited From:
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

matches(request, typeMask, sitekeyopt, nullable) → {boolean}

Tests whether the URL request matches this filter

Parameters:
Name Type Attributes Description
request module:url.URLRequest

URL request to be tested

typeMask number

bitmask of content / request types to match

sitekey string <optional>
<nullable>

public key provided by the document

Inherited From:
Source:
Returns:

true in case of a match

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: