public class | source

Moderator

Moderator component

Constructor Summary

Private Constructor
private	constructor Initialize the instance.

Member Summary

Public Members
public	isDisabled: boolean Moderator is in disabled state
public	loggedIn: boolean Logged in state

Private Members
private	whitelist: * The Whitelist instance

Method Summary

Public Methods
public	addToWhitelist(title: , url: ): boolean Add to Whitelist
public	disable() Disable moderator
public	enable() Enable moderator
public	getWhitelistJSON(): whitelist Get the serialized JSON form of the Whitelist.
public	isLocked(): boolean Check if Chrome is locked.
public	isUnlocked(): boolean Check if Chrome is unlocked.
public	lock(email: , password: ): boolean Lock
public	login(email: , password: ): boolean Login
public	logout(): boolean logout
public	removeFromWhitelist(url: *): boolean Remove from Whitelist
public	unlock(email: , password: ): boolean Unlock

Private Methods
private	getEmail(): string Get administator's email.
private	getPassword(): string Get administator's password.
private	getWhitelist(): Object Get the current Whitelist instance.
private	setEmail(email: string): void Set administrator's email.
private	setPassword(password: string): void Set administrator's password.
private	setupListeners() Setup all event listeners.

Private Constructors

private constructor source

Initialize the instance.

Public Members

public isDisabled: boolean source

Moderator is in disabled state

public loggedIn: boolean source

Logged in state

Private Members

private whitelist: * source

The Whitelist instance

Public Methods

public addToWhitelist(title: , url: ): boolean source

Add to Whitelist

Params:

Name	Type	Attribute	Description
title	*
url	*

Return:

boolean

Whether successfully added to whitelist.

public disable() source

Disable moderator

public enable() source

Enable moderator

public getWhitelistJSON(): whitelist source

Get the serialized JSON form of the Whitelist.

Return:

whitelist

The whitelist JSON.

public isLocked(): boolean source

Check if Chrome is locked. Locked means that an admin has signed in with their email.

Return:

boolean

Whether Chrome is locked.

public isUnlocked(): boolean source

Check if Chrome is unlocked. Locked means that an admin has signed in with their email.

Return:

boolean

Whether Chrome is unlocked.

public lock(email: , password: ): boolean source

Lock

Params:

Name	Type	Attribute	Description
email	*
password	*

Return:

boolean

Whether successfully locked

Params:

Name	Type	Attribute	Description
email	*
password	*

Return:

boolean

Whether successfully logged in

public logout(): boolean source

logout

Return:

boolean

Whether successfully logged out

public removeFromWhitelist(url: *): boolean source

Remove from Whitelist

Params:

Name	Type	Attribute	Description
url	*

Return:

boolean

Whether successfully removed from whitelist.

public unlock(email: , password: ): boolean source

Unlock

Params:

Name	Type	Attribute	Description
email	*
password	*

Return:

boolean

Whether successfully unlocked

Private Methods

private getEmail(): string source

Get administator's email.

Return:

string

Admin email.

private getPassword(): string source

Get administator's password.

Return:

string

Admin password.

private getWhitelist(): Object source

Get the current Whitelist instance.

Return:

Object

The whitelist instance.

private setEmail(email: string): void source

Set administrator's email.

Params:

Name	Type	Attribute	Description
email	string		The new email.

Return:

void

Void.

private setPassword(password: string): void source

Set administrator's password.

Params:

Name	Type	Attribute	Description
password	string		The new password.

Return:

void

Void.

private setupListeners() source

Setup all event listeners.

Listen:

onBeforeRequest

Listens for before requests

See:

https://developer.chrome.com/extensions/webRequest

Moderator

Constructor Summary

Member Summary

Method Summary

Private Constructors

private constructor source

Public Members

public isDisabled: boolean source

public loggedIn: boolean source

Private Members

private whitelist: * source

Public Methods

public addToWhitelist(title: *, url: *): boolean source

Params:

Return:

public disable() source

public enable() source

public getWhitelistJSON(): whitelist source

Return:

public isLocked(): boolean source

Return:

public isUnlocked(): boolean source

Return:

public lock(email: *, password: *): boolean source

Params:

Return:

public login(email: *, password: *): boolean source

Params:

Return:

public logout(): boolean source

Return:

public removeFromWhitelist(url: *): boolean source

Params:

Return:

public unlock(email: *, password: *): boolean source

Params:

Return:

Private Methods

private getEmail(): string source

Return:

private getPassword(): string source

Return:

private getWhitelist(): Object source

Return:

private setEmail(email: string): void source

Params:

Return:

private setPassword(password: string): void source

Params:

Return:

private setupListeners() source

Listen:

See:

public addToWhitelist(title: , url: ): boolean source

public lock(email: , password: ): boolean source

public login(email: , password: ): boolean source

public unlock(email: , password: ): boolean source