1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /* ***** BEGIN LICENSE BLOCK *****
3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 *
5 * The contents of this file are subject to the Mozilla Public License Version
6 * 1.1 (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 * http://www.mozilla.org/MPL/
9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
13 * License.
14 *
15 * The Original Code is Mozilla.
16 *
17 * The Initial Developer of the Original Code is
18 * Netscape Communications.
19 * Portions created by the Initial Developer are Copyright (C) 2001
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 *
24 * Alternatively, the contents of this file may be used under the terms of
25 * either the GNU General Public License Version 2 or later (the "GPL"), or
26 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 * in which case the provisions of the GPL or the LGPL are applicable instead
28 * of those above. If you wish to allow use of your version of this file only
29 * under the terms of either the GPL or the LGPL, and not to allow others to
30 * use your version of this file under the terms of the MPL, indicate your
31 * decision by deleting the provisions above and replace them with the notice
32 * and other provisions required by the GPL or the LGPL. If you do not delete
33 * the provisions above, a recipient may use your version of this file under
34 * the terms of any one of the MPL, the GPL or the LGPL.
35 *
36 * ***** END LICENSE BLOCK ***** */
37
38 #include "nsISupports.idl"
39
40 interface nsIUTF8StringEnumerator;
41 /**
42 * A channel interface which allows special handling of encoded content
43 */
44
45 [scriptable, uuid(30d7ec3a-f376-4652-9276-3092ec57abb6)]
46 interface nsIEncodedChannel : nsISupports
47 {
48 /**
49 * This attribute holds the MIME types corresponding to the content
50 * encodings on the channel. The enumerator returns nsISupportsCString
51 * objects. The first one corresponds to the outermost encoding on the
52 * channel and then we work our way inward. "identity" is skipped and not
53 * represented on the list. Unknown encodings make the enumeration stop.
54 * If you want the actual Content-Encoding value, use
55 * getResponseHeader("Content-Encoding").
56 *
57 * When there is no Content-Encoding header, this property is null.
58 *
59 * Modifying the Content-Encoding header on the channel will cause
60 * this enumerator to have undefined behavior. Don't do it.
61 *
62 * Also note that contentEncodings only exist during or after OnStartRequest.
63 * Calling contentEncodings before OnStartRequest is an error.
64 */
65 readonly attribute nsIUTF8StringEnumerator contentEncodings;
66
67 /**
68 * This attribute controls whether or not content conversion should be
69 * done per the Content-Encoding response header. applyConversion can only
70 * be set before or during OnStartRequest. Calling this during
71 * OnDataAvailable is an error.
72 *
73 * TRUE by default.
74 */
75 attribute boolean applyConversion;
76 };