pjs/netwerk/base/public/nsIEncodedChannel.idl

77 строки
3.2 KiB
Plaintext

/* -*- Mode: C++; 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 Mozilla.
*
* The Initial Developer of the Original Code is
* Netscape Communications.
* Portions created by the Initial Developer are Copyright (C) 2001
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* 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 nsIUTF8StringEnumerator;
/**
* A channel interface which allows special handling of encoded content
*/
[scriptable, uuid(30d7ec3a-f376-4652-9276-3092ec57abb6)]
interface nsIEncodedChannel : nsISupports
{
/**
* This attribute holds the MIME types corresponding to the content
* encodings on the channel. The enumerator returns nsISupportsCString
* objects. The first one corresponds to the outermost encoding on the
* channel and then we work our way inward. "identity" is skipped and not
* represented on the list. Unknown encodings make the enumeration stop.
* If you want the actual Content-Encoding value, use
* getResponseHeader("Content-Encoding").
*
* When there is no Content-Encoding header, this property is null.
*
* Modifying the Content-Encoding header on the channel will cause
* this enumerator to have undefined behavior. Don't do it.
*
* Also note that contentEncodings only exist during or after OnStartRequest.
* Calling contentEncodings before OnStartRequest is an error.
*/
readonly attribute nsIUTF8StringEnumerator contentEncodings;
/**
* This attribute controls whether or not content conversion should be
* done per the Content-Encoding response header. applyConversion can only
* be set before or during OnStartRequest. Calling this during
* OnDataAvailable is an error.
*
* TRUE by default.
*/
attribute boolean applyConversion;
};