Class SudoAdTrackerBlockerClient

This is the main class used for Ad/Tracker blocking. Each instance of SudoAdTrackerBlockerClient will contain a filtering engine that can be configured to use a set of blocking rulesets. To query the filtering engine, you can call (checkUrl).

Hierarchy

SudoAdTrackerBlockerClient

Index

Constructors

Accessors

Methods

addExceptions checkUrl getActiveRulesets getExceptions listRulesets removeAllExceptions removeExceptions reset setActiveRulesets update

Constructors

constructor

new SudoAdTrackerBlockerClient(props: SudoAdTrackerBlockerClientProps): SudoAdTrackerBlockerClient
Parameters
- props: SudoAdTrackerBlockerClientProps
Returns SudoAdTrackerBlockerClient
- Defined in src/sudo-ad-tracker-blocker-client.ts:152

Accessors

status

get status(): Status
Filter engine status.

Returns Status
- Defined in src/sudo-ad-tracker-blocker-client.ts:234

Methods

addExceptions

addExceptions(exceptions: FilterException[]): Promise<void>
Adds items to the exceptions list.
Parameters
- exceptions: FilterException[]
Returns Promise<void>
- Defined in src/sudo-ad-tracker-blocker-client.ts:384

checkUrl

checkUrl(url: string, sourceUrl?: string, resourceType?: string): CheckUrlResult
Returns true if url and currentUrl match; false if not.
Parameters
- url: string
  
  resource urls for ads. e.g. google-ad
- sourceUrl: string = ''
  
  The URL of the site the resource urls are coming from.
- resourceType: string = ''
Returns CheckUrlResult
- Defined in src/sudo-ad-tracker-blocker-client.ts:315

getActiveRulesets

getActiveRulesets(): Promise<RulesetType[]>
Gets all rulesets that are currently influencing the results of checkUrl.

Returns Promise<RulesetType[]>
- Defined in src/sudo-ad-tracker-blocker-client.ts:287

getExceptions

getExceptions(): Promise<FilterException[]>
Retrieves current filtering exceptions that are influencing the behavior of checkUrl.

Returns Promise<FilterException[]>
- Defined in src/sudo-ad-tracker-blocker-client.ts:369

listRulesets

listRulesets(): Promise<Ruleset[]>
Gets all available rulesets with associated metadata.

Returns Promise<Ruleset[]>
- Defined in src/sudo-ad-tracker-blocker-client.ts:241

removeAllExceptions

removeAllExceptions(): Promise<void>
Removes all exceptions from the exceptions list.

Returns Promise<void>
- Defined in src/sudo-ad-tracker-blocker-client.ts:429

removeExceptions

removeExceptions(exceptions: FilterException[]): Promise<void>
Removes specific exceptions from the exceptions list.
Parameters
- exceptions: FilterException[]
Returns Promise<void>
- Defined in src/sudo-ad-tracker-blocker-client.ts:406

reset

reset(): Promise<void>
Resets the client by clearing cached data and user preferences.

Returns Promise<void>
- Defined in src/sudo-ad-tracker-blocker-client.ts:222

setActiveRulesets

setActiveRulesets(rulesetTypes: RulesetType[]): Promise<void>
Sets which ruleset types are active in the filtering engine and then performs the update operation.
Parameters
- rulesetTypes: RulesetType[]
Returns Promise<void>
- Defined in src/sudo-ad-tracker-blocker-client.ts:300

update

update(): Promise<void>
Update rulesets based on any server-side changes.

Returns Promise<void>
- Defined in src/sudo-ad-tracker-blocker-client.ts:182

Generated using TypeDoc