org.mozilla.geckoview

Class ContentBlockingController

Object

org.mozilla.geckoview.ContentBlockingController

@AnyThread
public class ContentBlockingController
extends Object

ContentBlockingController is used to manage and modify the content blocking exception list. This list is shared across all sessions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContentBlockingController.ContentBlockingException
static class	ContentBlockingController.Event
static class	ContentBlockingController.LogEntry An entry in the content blocking log for a site.

Constructor Summary

Constructors

Constructor and Description
ContentBlockingController()

Method Summary

Modifier and Type	Method and Description
void	addException(GeckoSession session) Add a content blocking exception for the site currently loaded by the supplied GeckoSession.
GeckoResult<Boolean>	checkException(GeckoSession session) Check whether or not there is an exception for the site currently loaded by the supplied GeckoSession.
void	clearExceptionList() Clear the content blocking exception list entirely.
GeckoResult<List<ContentBlockingController.LogEntry>>	getLog(GeckoSession session) Get a log of all content blocking information for the site currently loaded by the supplied GeckoSession.
void	removeException(ContentBlockingController.ContentBlockingException exception) Remove the exception specified by the supplied ContentBlockingController.ContentBlockingException from the content blocking exception list, if it is present.
void	removeException(GeckoSession session) Remove an exception for the site currently loaded by the supplied GeckoSession from the content blocking exception list, if there is such an exception.
void	restoreExceptionList(List<ContentBlockingController.ContentBlockingException> list) Restore the supplied List of ContentBlockingController.ContentBlockingException, overwriting the existing exception list.
GeckoResult<List<ContentBlockingController.ContentBlockingException>>	saveExceptionList() Save the current content blocking exception list as a List of ContentBlockingController.ContentBlockingException.

Methods inherited from class Object

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

Constructor Detail

ContentBlockingController

public ContentBlockingController()

Method Detail

addException

@UiThread
public void addException(@NonNull
                                   GeckoSession session)

Add a content blocking exception for the site currently loaded by the supplied GeckoSession.

Parameters:

session - A GeckoSession whose site will be added to the content blocking exceptions list.

removeException

@UiThread
public void removeException(@NonNull
                                      GeckoSession session)

Remove an exception for the site currently loaded by the supplied GeckoSession from the content blocking exception list, if there is such an exception. If there is no such exception, this is a no-op.

Parameters:

session - A GeckoSession whose site will be removed from the content blocking exceptions list.

removeException

@AnyThread
public void removeException(@NonNull
                                       ContentBlockingController.ContentBlockingException exception)

Remove the exception specified by the supplied ContentBlockingController.ContentBlockingException from the content blocking exception list, if it is present. If there is no such exception, this is a no-op.

Parameters:

exception - A ContentBlockingController.ContentBlockingException which will be removed from the content blocking exception list.

checkException

@UiThread
 @NonNull
public GeckoResult<Boolean> checkException(@NonNull
                                                               GeckoSession session)

Check whether or not there is an exception for the site currently loaded by the supplied GeckoSession.

Parameters:

session - A GeckoSession whose site will be checked against the content blocking exceptions list.

Returns:

A GeckoResult which resolves to a Boolean indicating whether or not the current site is on the exception list.

saveExceptionList

@UiThread
 @NonNull
public GeckoResult<List<ContentBlockingController.ContentBlockingException>> saveExceptionList()

Save the current content blocking exception list as a List of ContentBlockingController.ContentBlockingException.

Returns:

A List of ContentBlockingController.ContentBlockingException which can be used to restore or inspect the current exception list.

restoreExceptionList

@AnyThread
public void restoreExceptionList(@NonNull
                                            List<ContentBlockingController.ContentBlockingException> list)

Restore the supplied List of ContentBlockingController.ContentBlockingException, overwriting the existing exception list.

Parameters:

list - A List of ContentBlockingController.ContentBlockingException originally created by saveExceptionList().

clearExceptionList

@UiThread
public void clearExceptionList()

Clear the content blocking exception list entirely.

getLog

@UiThread
 @NonNull
public GeckoResult<List<ContentBlockingController.LogEntry>> getLog(@NonNull
                                                                                        GeckoSession session)

Get a log of all content blocking information for the site currently loaded by the supplied GeckoSession.

Parameters:

session - A GeckoSession for which you want the content blocking log.

Returns:

A GeckoResult that resolves to the list of content blocking log entries.