Package org.mozilla.geckoview

Class ContentBlocking.Settings

Object

org.mozilla.geckoview.RuntimeSettings

org.mozilla.geckoview.ContentBlocking.Settings

All Implemented Interfaces:

Parcelable

Enclosing class:

ContentBlocking

@AnyThread
public static class ContentBlocking.Settings
extends RuntimeSettings

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ContentBlocking.Settings.Builder

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T extends Object>, Parcelable.Creator<T extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final Parcelable.Creator<ContentBlocking.Settings>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method	Description
int	getAntiTrackingCategories()	Get the set anti-tracking categories.
boolean	getCookieBannerDetectOnlyMode()	Indicates if cookie banner handling detect only mode is enabled.
int	getCookieBannerMode()	Gets the current cookie banner handling mode.
int	getCookieBannerModePrivateBrowsing()	Gets the current cookie banner handling mode for private browsing.
int	getCookieBehavior()	Get the assigned cookie storage behavior.
int	getCookieBehaviorPrivateMode()	Get the assigned private mode cookie storage behavior.
boolean	getCookiePurging()	Get whether or not cookie purging is enabled.
int	getEnhancedTrackingProtectionLevel()	Get the set ETP behavior level.
int	getSafeBrowsingCategories()	Get the set safe browsing categories.
String[]	getSafeBrowsingMalwareTable()	Get the table for SafeBrowsing Malware.
String[]	getSafeBrowsingPhishingTable()	Get the table for SafeBrowsing Phishing.
Collection<ContentBlocking.SafeBrowsingProvider>	getSafeBrowsingProviders()	Get the collection of ContentBlocking.SafeBrowsingProvider for this runtime.
boolean	getStrictSocialTrackingProtection()	Get whether or not strict social tracking protection is enabled.
ContentBlocking.Settings	setAntiTracking(int cat)	Set anti-tracking categories.
ContentBlocking.Settings	setCookieBannerDetectOnlyMode(boolean enabled)	When set to true, cookie banners are detected and detection events are dispatched, but they will not be handled.
ContentBlocking.Settings	setCookieBannerMode(int mode)	Set the Cookie Banner Handling Mode to the new provided ContentBlocking.CBCookieBannerMode value.
ContentBlocking.Settings	setCookieBannerModePrivateBrowsing(int mode)	Set the Cookie Banner Handling Mode for private browsing to the new provided ContentBlocking.CBCookieBannerMode value.
ContentBlocking.Settings	setCookieBehavior(int behavior)	Set cookie storage behavior.
ContentBlocking.Settings	setCookieBehaviorPrivateMode(int behavior)	Set cookie storage behavior for private browsing mode.
ContentBlocking.Settings	setCookiePurging(boolean enabled)	Enable or disable cookie purging.
ContentBlocking.Settings	setEnhancedTrackingProtectionLevel(int level)	Set the ETP behavior level.
ContentBlocking.Settings	setSafeBrowsing(int cat)	Set safe browsing categories.
ContentBlocking.Settings	setSafeBrowsingMalwareTable(String... table)	Sets the table for SafeBrowsing Malware.
ContentBlocking.Settings	setSafeBrowsingPhishingTable(String... table)	Sets the table for SafeBrowsing Phishing.
ContentBlocking.Settings	setSafeBrowsingProviders(ContentBlocking.SafeBrowsingProvider... providers)	Sets the collection of ContentBlocking.SafeBrowsingProvider for this runtime.
ContentBlocking.Settings	setStrictSocialTrackingProtection(boolean enabled)	Set whether or not strict social tracking protection is enabled (ie, whether to block content or just cookies).
protected void	updatePrefs(RuntimeSettings settings)	Update the prefs based on the provided settings.

Methods inherited from class org.mozilla.geckoview.RuntimeSettings

describeContents, readFromParcel, writeToParcel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CREATOR

public static final Parcelable.Creator<ContentBlocking.Settings> CREATOR

Method Details

updatePrefs

protected void updatePrefs(@NonNull
 RuntimeSettings settings)

Description copied from class: RuntimeSettings

Update the prefs based on the provided settings.

Overrides:

updatePrefs in class RuntimeSettings

Parameters:

settings - Copy from this settings.

getSafeBrowsingProviders

@NonNull
public Collection<ContentBlocking.SafeBrowsingProvider> getSafeBrowsingProviders()

Get the collection of ContentBlocking.SafeBrowsingProvider for this runtime.

Returns:

an unmodifiable collection of ContentBlocking.SafeBrowsingProvider

See Also:

• ContentBlocking.SafeBrowsingProvider

setSafeBrowsingProviders

@NonNull
public ContentBlocking.Settings setSafeBrowsingProviders(@NonNull
 ContentBlocking.SafeBrowsingProvider... providers)

Sets the collection of ContentBlocking.SafeBrowsingProvider for this runtime.

By default the collection is composed of ContentBlocking.GOOGLE_LEGACY_SAFE_BROWSING_PROVIDER and ContentBlocking.GOOGLE_SAFE_BROWSING_PROVIDER.

Parameters:

providers - ContentBlocking.SafeBrowsingProvider instances for this runtime.

Returns:

the ContentBlocking.Settings instance.

See Also:

• ContentBlocking.SafeBrowsingProvider

getSafeBrowsingPhishingTable

@NonNull
public String[] getSafeBrowsingPhishingTable()

Get the table for SafeBrowsing Phishing. The identifiers present in this table must match one of the identifiers present in ContentBlocking.SafeBrowsingProvider.getLists().

Returns:

an array of identifiers for SafeBrowsing's Phishing feature

See Also:

• ContentBlocking.SafeBrowsingProvider.Builder.lists(java.lang.String...)

setSafeBrowsingPhishingTable

@NonNull
public ContentBlocking.Settings setSafeBrowsingPhishingTable(@NonNull
 String... table)

Sets the table for SafeBrowsing Phishing.

Parameters:

table - an array of identifiers for SafeBrowsing's Phishing feature.

Returns:

this ContentBlocking.Settings instance.

See Also:

• ContentBlocking.SafeBrowsingProvider.Builder.lists(java.lang.String...)

getSafeBrowsingMalwareTable

@NonNull
public String[] getSafeBrowsingMalwareTable()

Get the table for SafeBrowsing Malware. The identifiers present in this table must match one of the identifiers present in ContentBlocking.SafeBrowsingProvider.getLists().

Returns:

an array of identifiers for SafeBrowsing's Malware feature

See Also:

• ContentBlocking.SafeBrowsingProvider.Builder.lists(java.lang.String...)

setSafeBrowsingMalwareTable

@NonNull
public ContentBlocking.Settings setSafeBrowsingMalwareTable(@NonNull
 String... table)

Sets the table for SafeBrowsing Malware.

Parameters:

table - an array of identifiers for SafeBrowsing's Malware feature.

Returns:

this ContentBlocking.Settings instance.

See Also:

• ContentBlocking.SafeBrowsingProvider.Builder.lists(java.lang.String...)

setAntiTracking

@NonNull
public ContentBlocking.Settings setAntiTracking(int cat)

Set anti-tracking categories.

Parameters:

cat - The categories of resources that should be blocked. Use one or more of the ContentBlocking.AntiTracking flags.

Returns:

This Settings instance.

setEnhancedTrackingProtectionLevel

@NonNull
public ContentBlocking.Settings setEnhancedTrackingProtectionLevel(int level)

Set the ETP behavior level.

Parameters:

level - The level of ETP blocking to use; must be one of ContentBlocking.EtpLevel flags. Only takes effect if the cookie behavior is ContentBlocking.CookieBehavior.ACCEPT_NON_TRACKERS or ContentBlocking.CookieBehavior.ACCEPT_FIRST_PARTY_AND_ISOLATE_OTHERS.

Returns:

This Settings instance.

setStrictSocialTrackingProtection

@NonNull
public ContentBlocking.Settings setStrictSocialTrackingProtection(boolean enabled)

Set whether or not strict social tracking protection is enabled (ie, whether to block content or just cookies). Will only block if social tracking protection lists are supplied to setAntiTracking(int).

Parameters:

enabled - A boolean indicating whether or not to enable strict social tracking protection.

Returns:

This Settings instance.

setSafeBrowsing

@NonNull
public ContentBlocking.Settings setSafeBrowsing(int cat)

Set safe browsing categories.

Parameters:

cat - The categories of resources that should be blocked. Use one or more of the ContentBlocking.SafeBrowsing flags.

Returns:

This Settings instance.

getAntiTrackingCategories

public int getAntiTrackingCategories()

Get the set anti-tracking categories.

Returns:

The categories of resources to be blocked.

getEnhancedTrackingProtectionLevel

public int getEnhancedTrackingProtectionLevel()

Get the set ETP behavior level.

Returns:

The current ETP level; one of ContentBlocking.EtpLevel.

getStrictSocialTrackingProtection

public boolean getStrictSocialTrackingProtection()

Get whether or not strict social tracking protection is enabled.

Returns:

A boolean indicating whether or not strict social tracking protection is enabled.

getSafeBrowsingCategories

public int getSafeBrowsingCategories()

Get the set safe browsing categories.

Returns:

The categories of resources to be blocked.

getCookieBehavior

public int getCookieBehavior()

Get the assigned cookie storage behavior.

Returns:

The assigned behavior, as one of ContentBlocking.CookieBehavior flags.

setCookieBehavior

@NonNull
public ContentBlocking.Settings setCookieBehavior(int behavior)

Set cookie storage behavior.

Parameters:

behavior - The storage behavior that should be applied. Use one of the ContentBlocking.CookieBehavior flags.

Returns:

This Settings instance.

getCookieBehaviorPrivateMode

public int getCookieBehaviorPrivateMode()

Get the assigned private mode cookie storage behavior.

Returns:

The assigned behavior, as one of ContentBlocking.CookieBehavior flags.

setCookieBehaviorPrivateMode

@NonNull
public ContentBlocking.Settings setCookieBehaviorPrivateMode(int behavior)

Set cookie storage behavior for private browsing mode.

Parameters:

behavior - The storage behavior that should be applied. Use one of the ContentBlocking.CookieBehavior flags.

Returns:

This Settings instance.

getCookiePurging

public boolean getCookiePurging()

Get whether or not cookie purging is enabled.

Returns:

A boolean indicating whether or not cookie purging is enabled.

setCookiePurging

@NonNull
public ContentBlocking.Settings setCookiePurging(boolean enabled)

Enable or disable cookie purging. This will automatically purge cookies from tracking sites that have no recent user interaction, provided the cookie behavior is set to ContentBlocking.CookieBehavior.ACCEPT_NON_TRACKERS or ContentBlocking.CookieBehavior.ACCEPT_FIRST_PARTY_AND_ISOLATE_OTHERS.

Parameters:

enabled - A boolean indicating whether to enable cookie purging.

Returns:

This Settings instance.

setCookieBannerMode

@NonNull
public ContentBlocking.Settings setCookieBannerMode(int mode)

Set the Cookie Banner Handling Mode to the new provided ContentBlocking.CBCookieBannerMode value.

Parameters:

mode - Integer indicating the new mode.

Returns:

This Settings instance.

setCookieBannerDetectOnlyMode

@NonNull
public ContentBlocking.Settings setCookieBannerDetectOnlyMode(boolean enabled)

When set to true, cookie banners are detected and detection events are dispatched, but they will not be handled. Requires the service to be enabled for the desired mode via setCookieBannerMode.

Parameters:

enabled - A boolean indicating whether to enable cookie banners.

Returns:

This Settings instance.

getCookieBannerDetectOnlyMode

public boolean getCookieBannerDetectOnlyMode()

Indicates if cookie banner handling detect only mode is enabled.

Returns:

boolean indicating if the cookie banner handling detect only mode setting is enabled.

getCookieBannerMode

public int getCookieBannerMode()

Gets the current cookie banner handling mode.

Returns:

int the current cookie banner handling mode, one of the ContentBlocking.CBCookieBannerMode.

setCookieBannerModePrivateBrowsing

@NonNull
public ContentBlocking.Settings setCookieBannerModePrivateBrowsing(int mode)

Set the Cookie Banner Handling Mode for private browsing to the new provided ContentBlocking.CBCookieBannerMode value.

Parameters:

mode - Integer indicating the new mode.

Returns:

This Settings instance.

getCookieBannerModePrivateBrowsing

public int getCookieBannerModePrivateBrowsing()

Gets the current cookie banner handling mode for private browsing.

Returns:

int the current cookie banner handling mode, one of the ContentBlocking.CBCookieBannerMode.