gecko/toolkit/components/parentalcontrols/public/nsIParentalControlsService.idl

103 lines
4.1 KiB
Plaintext

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Mozilla Foundation.
* Portions created by the Initial Developer are Copyright (C) 2008
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Jim Mathies <jmathies@mozilla.com>.
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsISupports.idl"
interface nsIURI;
interface nsIFile;
interface nsIInterfaceRequestor;
interface nsIArray;
[scriptable, uuid(871cf229-2b21-4f04-b24d-e08061f14815)]
interface nsIParentalControlsService : nsISupports
{
/**
* @returns true if the current user account has parental controls
* restrictions enabled.
*/
readonly attribute boolean parentalControlsEnabled;
/**
* @returns true if the current user account parental controls
* restrictions include the blocking of all file downloads.
*/
readonly attribute boolean blockFileDownloadsEnabled;
/**
* Request that blocked URI(s) be allowed through parental
* control filters. Returns true if the URI was successfully
* overriden. Note, may block while native UI is shown.
*
* @param aTarget(s) URI to be overridden. In the case of
* multiple URI, the first URI in the array
* should be the root URI of the site.
* @param window Window that generates the event.
*/
boolean requestURIOverride(in nsIURI aTarget, [optional] in nsIInterfaceRequestor aWindowContext);
boolean requestURIOverrides(in nsIArray aTargets, [optional] in nsIInterfaceRequestor aWindowContext);
/**
* @returns true if the current user account has parental controls
* logging enabled. If true, applications should log relevent events
* using 'log'.
*/
readonly attribute boolean loggingEnabled;
/**
* Log entry types. Additional types can be defined and implemented
* as needed. Other possible event types might include email events,
* media related events, and IM events.
*/
const short ePCLog_URIVisit = 1; /* Web content */
const short ePCLog_FileDownload = 2; /* File downloads */
/**
* Log an application specific parental controls
* event.
*
* @param aEntryType Constant defining the type of event.
* @param aFlag A flag indicating if the subject content
* was blocked.
* @param aSource The URI source of the subject content.
* @param aTarget The location the content was saved to if
* no blocking occured.
*/
void log(in short aEntryType, in boolean aFlag, in nsIURI aSource, [optional] in nsIFile aTarget);
};