Back to index

lightning-sunbird  0.9+nobinonly
Public Attributes
nsIEncodedChannel Interface Reference

A channel interface which allows special handling of encoded content. More...

import "nsIEncodedChannel.idl";

Inheritance diagram for nsIEncodedChannel:
Inheritance graph
[legend]
Collaboration diagram for nsIEncodedChannel:
Collaboration graph
[legend]

List of all members.

Public Attributes

readonly attribute
nsIUTF8StringEnumerator 
contentEncodings
 This attribute holds the MIME types corresponding to the content encodings on the channel.
attribute boolean applyConversion
 This attribute controls whether or not content conversion should be done per the Content-Encoding response header.

Detailed Description

A channel interface which allows special handling of encoded content.

Definition at line 46 of file nsIEncodedChannel.idl.


Member Data Documentation

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.

Definition at line 75 of file nsIEncodedChannel.idl.

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.

Definition at line 65 of file nsIEncodedChannel.idl.


The documentation for this interface was generated from the following file: