Typically WSC uses this class to parse messages received through WSF HandleMessageL() and HandleErrorL() callbacks. Class has convenience methods for checking if a SOAP envelope body contains a fault and functionality to detach SOAP Fault object out from it. Also possibility to set SOAPAction HTTP header is supported.
|
Public Member Functions |
| virtual IMPORT_C | ~CSenSoapEnvelope2 () |
| | Destructor.
|
| virtual IMPORT_C TPtrC8 | SetBodyL (const TDesC8 &aBody) |
| | Sets body of the envelope.
|
| virtual IMPORT_C TXmlEngElement | SetBodyL (TXmlEngElement aBodyElement) |
| | Sets body of the envelope.
|
| virtual IMPORT_C TXmlEngElement | BodyL () |
| | Getter for envelopes body.
|
| virtual IMPORT_C TXmlEngElement | HeaderL () |
| | Getter for envelopes header.
|
| virtual IMPORT_C TXmlEngElement | AddHeaderL (TXmlEngElement aHeaderElement) |
| | Adds an element to the header.
|
| virtual IMPORT_C HBufC8 * | BodyAsStringL () |
| | Getter for the envelope body as a UTF-8 form XML string.
|
| virtual IMPORT_C TBool | IsFault () |
| | Checks if this SOAP envelope body contains SOAP fault or not.
|
| virtual IMPORT_C CSenSoapFault2 * | DetachFaultL () |
| | Detaches the <Fault> element from the envelope, removing the element from the envelope.
|
| virtual IMPORT_C CSenSoapFault2 * | FaultL () |
| | Gets the <Fault> element.
|
| virtual IMPORT_C TPtrC8 | SetSoapActionL (const TDesC8 &aSoapAction) |
| | Sets the SOAP action HTTP header.
|
| virtual IMPORT_C TPtrC8 | SoapAction () |
| | Gets the soap action header.
|
| IMPORT_C TBool | HasHeader () |
| IMPORT_C TBool | HasBody () |
| virtual IMPORT_C TSOAPVersion | SoapVersion () |
| | Getter for currently effecitve SOAP version.
|
| virtual IMPORT_C TClass | Type () |
| | Gets the Message Type.
|
| virtual IMPORT_C TDirection | Direction () |
| | Gets the Message Direction.
|
| virtual IMPORT_C TInt | SetContext (MSenMessageContext *apOwnedContext) |
| | Sets message context for this message.
|
| virtual IMPORT_C MSenMessageContext * | Context () |
| | Getter for message's context.
|
| virtual IMPORT_C TInt | SetProperties (MSenProperties *apOwnedProperties) |
| | Sets properties for this message.
|
| virtual IMPORT_C MSenProperties * | Properties () |
| | Getter for message specific (transport) properties.
|
| virtual IMPORT_C TBool | IsSafeToCast (TClass aType) |
| virtual IMPORT_C TInt | TxnId () |
| | Getter for transaction ID of this message.
|
| virtual IMPORT_C MSenMessage * | CloneL () |
| | Clone method that duplicates this message -- including all member data in the message.
|
Static Public Member Functions |
| static IMPORT_C CSenSoapEnvelope2 * | NewL () |
| | Two-phased constructor.
|
| static IMPORT_C CSenSoapEnvelope2 * | NewLC () |
| | Two-phased constructor.
|
| static IMPORT_C CSenSoapEnvelope2 * | NewL (MSenMessageContext &aContext) |
| | Two-phased constructor.
|
| static IMPORT_C CSenSoapEnvelope2 * | NewLC (MSenMessageContext &aContext) |
| | Two-phased constructor.
|
| static IMPORT_C CSenSoapEnvelope2 * | NewL (CSenSoapEnvelope2 &aEnvelope) |
| | Two-phased copy constructor.
|
| static IMPORT_C CSenSoapEnvelope2 * | NewLC (CSenSoapEnvelope2 &aEnvelope) |
| | Two-phased copy constructor.
|
Protected Member Functions |
| | CSenSoapEnvelope2 () |
| | Constructor.
|
| IMPORT_C void | BaseConstructL (TSOAPVersion aVersion) |
| | This method should be called from the deriving classes ConstructL() methods.
|
| IMPORT_C void | BaseConstructL () |
| | This method should be called from the deriving classes ConstructL() methods.
|
| IMPORT_C void | BaseConstructL (MSenMessageContext &aMessage) |
| | This method should be called from the deriving classes ConstructL() methods.
|
| IMPORT_C void | BaseConstructL (MSenMessageContext &aMessage, TSOAPVersion aVersion) |
| | This method should be called from the deriving classes ConstructL() methods.
|
| IMPORT_C void | BaseConstructL (CSenSoapEnvelope2 &aEnvelope) |
| | This method should be called from the deriving classes ConstructL() methods.
|
| virtual IMPORT_C void | ParseHeaderL (const RTagInfo &aElement, const RAttributeArray &aAttributes) |
| | This method should be overridden by subclasses.
|
| virtual IMPORT_C void | OnStartElementL (const RTagInfo &aElement, const RAttributeArray &aAttributes, TInt aErrorCode) |
| | Callback function implementing the XML content handler interface.
|
| virtual IMPORT_C void | OnEndElementL (const RTagInfo &aElement, TInt aErrorCode) |
| | Callback function implementing the XML content handler interface.
|
| virtual IMPORT_C CSenFragmentBase * | CreateBodyFragmentL (const TDesC8 &aNsUri, const TDesC8 &aLocalName, const TDesC8 &aPrefix, const RAttributeArray &aAttributes, TXmlEngElement &aParent, RSenDocument &aOwnerDocument) |
Protected Attributes |
| CSenFragmentBase * | ipBodyFragment |
| CSenFragmentBase * | ipHeaderFragment |
| HBufC8 * | ipSoapAction |
| TInt | iTransactionId |
| MSenProperties * | ipProperties |
| MSenMessageContext * | ipNotOwnedContext |
| TAny * | ipReserved |
| TBool | iFault |
| TDirection | iDirection |
