Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsISOAPHeaderBlock Interface Reference

This interface encapsulates an arbitrary header block to be used by the soap serialization or protocol. More...

import "nsISOAPHeaderBlock.idl";

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

List of all members.

Public Member Functions

void init (in nsISOAPAttachments aAttachments, in unsigned short aVersion)
 Initialize the block for additional decoding information.

Public Attributes

attribute AString actorURI
 The actor URI of the header block.
attribute boolean mustUnderstand
 Flags that the processor must understand this header.
attribute AString namespaceURI
 The namespace URI of the block.
attribute AString name
 The name of the block.
attribute nsISOAPEncoding encoding
 The encoding that was / will be applied to the block.
attribute nsISchemaType schemaType
 The schema type used to encode or decode the block.
attribute nsIDOMElement element
 The element which is the encoded value of this block.
attribute nsIVariant value
 The native value which is the decoded value of this block.

Detailed Description

This interface encapsulates an arbitrary header block to be used by the soap serialization or protocol.

See the description of the nsISOAPBlock interface for information on how the basics of this interface works.

Definition at line 53 of file nsISOAPHeaderBlock.idl.


Member Function Documentation

void nsISOAPBlock::init ( in nsISOAPAttachments  aAttachments,
in unsigned short  aVersion 
) [inherited]

Initialize the block for additional decoding information.

Parameters:
aAttachmentsAttachments in case this refers to them.
aVersionSOAP version for decoding special header attributes.

Member Data Documentation

The actor URI of the header block.

If element is set, then this is a computed value. If this is modified, then element is set to null and all attributes computed from element revert to previous uncomputed values.

Definition at line 60 of file nsISOAPHeaderBlock.idl.

The element which is the encoded value of this block.

If this is set, value, namespaceURI, and name becomes a computed attributes which are produced by decoding this element.

Definition at line 117 of file nsISOAPBlock.idl.

The encoding that was / will be applied to the block.

If this is blank and element is non-null, it becomes impossible to decode the block when the value is requested.

Definition at line 102 of file nsISOAPBlock.idl.

Flags that the processor must understand this header.

If element is set, then this is a computed value. If this is modified, then element is set to null and all attributes computed from element revert to previous uncomputed values.

Definition at line 69 of file nsISOAPHeaderBlock.idl.

attribute AString nsISOAPBlock::name [inherited]

The name of the block.

If the block is left unnamed, it will be encoded using the element types defined in the SOAP-ENC schema. For example, <SOAP-ENC:int>45</SOAP-ENC:int> . If this is modified, element is set to null and all attributes computed from element revert to previous uncomputed values. If element is set, this becomes computed.

Definition at line 94 of file nsISOAPBlock.idl.

The namespace URI of the block.

Ignored if name is null. If this is modified, element is set to null and all attributes computed from element revert to previous uncomputed values. If element is set, this becomes computed.

Definition at line 84 of file nsISOAPBlock.idl.

The schema type used to encode or decode the block.

If this is null, then the default encoder or decoder may

Definition at line 109 of file nsISOAPBlock.idl.

The native value which is the decoded value of this block.

If this is modified, element is set to null and all attributes computed from element revert to previous uncomputed values. If element is set, this becomes computed, relying on the value of encoding and schemaType each time it is computed.

Definition at line 128 of file nsISOAPBlock.idl.


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