pjs/netwerk/base/public/nsIApplicationCacheChannel.idl

86 строки
3.3 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* ***** 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 nsIApplicationCache.idl.
*
* The Initial Developer of the Original Code is
* Mozilla Corporation.
* Portions created by the Initial Developer are Copyright (C) 2008
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Dave Camp <dcamp@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"
#include "nsIApplicationCacheContainer.idl"
/**
* Interface implemented by channels that support application caches.
*/
[scriptable, uuid(8d9024e6-ab01-442d-8119-2f55d55d91b0)]
interface nsIApplicationCacheChannel : nsIApplicationCacheContainer
{
/**
* TRUE when the resource came from the application cache. This
* might be false even there is assigned an application cache
* e.g. in case of fallback of load of an entry matching bypass
* namespace.
*/
readonly attribute boolean loadedFromApplicationCache;
/**
* When true, the channel will ask its notification callbacks for
* an application cache if one is not explicitly provided. Default
* value is true.
*
* NS_ERROR_ALREADY_OPENED will be thrown if set after AsyncOpen()
* is called.
*/
attribute boolean inheritApplicationCache;
/**
* When true, the channel will choose an application cache if one
* was not explicitly provided and none is available from the
* notification callbacks. Default value is false.
*
* This attribute will not be transferred through a redirect.
*
* NS_ERROR_ALREADY_OPENED will be thrown if set after AsyncOpen()
* is called.
*/
attribute boolean chooseApplicationCache;
/**
* A shortcut method to mark the cache item of this channel as 'foreign'.
* See the 'cache selection algorithm' and CACHE_SELECTION_RELOAD
* action handling in nsContentSink.
*/
void markOfflineCacheEntryAsForeign();
};