#include <KDSoapMessage.h>

Inheritance diagram for KDSoapMessage:

Public Member Functions
	KDSoapMessage ()

	~KDSoapMessage ()

	KDSoapMessage (const KDSoapMessage &other)

KDSoapMessage &	operator= (const KDSoapMessage &other)

KDSoapMessage &	operator= (const KDSoapValue &other)

bool	operator== (const KDSoapMessage &other) const

bool	operator!= (const KDSoapMessage &other) const

void	setUse (Use use)

Use	use () const

void	addArgument (const QString &argumentName, const QVariant &argumentValue, const QString &typeNameSpace=QString(), const QString &typeName=QString())

void	addArgument (const QString &argumentName, const KDSoapValueList &argumentValueList, const QString &typeNameSpace=QString(), const QString &typeName=QString())

KDSoapValueList &	arguments ()

const KDSoapValueList &	arguments () const

bool	isFault () const

QString	faultAsString () const

void	setFault (bool fault)

void	createFaultMessage (const QString &faultCode, const QString &faultText, KDSoap::SoapVersion soapVersion)

void	setMessageAddressingProperties (const KDSoapMessageAddressingProperties &map)

bool	hasMessageAddressingProperties () const

KDSoapMessageAddressingProperties	messageAddressingProperties () const

Public Member Functions inherited from KDSoapValue
	KDSoapValue ()

	~KDSoapValue ()

	KDSoapValue (const QString &name, const QVariant &valueVariant, const QString &typeNameSpace=QString(), const QString &typeName=QString())

	KDSoapValue (const QString &name, const KDSoapValueList &childValues, const QString &typeNameSpace=QString(), const QString &typeName=QString())

	KDSoapValue (const KDSoapValue &other)

KDSoapValue &	operator= (const KDSoapValue &other)

void	swap (KDSoapValue &other)

bool	isNull () const

bool	isNil () const

void	setNillable (bool nillable)

QString	name () const

QString	namespaceUri () const

void	setNamespaceUri (const QString &ns)

QVariant	value () const

void	setValue (const QVariant &value)

bool	isQualified () const

void	setQualified (bool qualified)

KDSoapValueList &	childValues () const

bool	operator== (const KDSoapValue &other) const

bool	operator!= (const KDSoapValue &other) const

void	setType (const QString &nameSpace, const QString &type)

QString	typeNs () const

QString	type () const

void	setNamespaceDeclarations (const QXmlStreamNamespaceDeclarations &namespaceDeclarations)

void	addNamespaceDeclaration (const QXmlStreamNamespaceDeclaration &namespaceDeclaration)

QXmlStreamNamespaceDeclarations	namespaceDeclarations () const

void	setEnvironmentNamespaceDeclarations (const QXmlStreamNamespaceDeclarations &environmentNamespaceDeclarations)

QXmlStreamNamespaceDeclarations	environmentNamespaceDeclarations () const

KDSoapValueList	split () const

Additional Inherited Members
Public Types inherited from KDSoapValue

Detailed Description

The KDSoapMessage class represents one message sent or received via SOAP.

Constructor & Destructor Documentation

KDSoapMessage::KDSoapMessage ( )

Constructs an empty KDSoapMessage object.

KDSoapMessage::~KDSoapMessage ( )

Destructs the KDSoapMessage object.

KDSoapMessage::KDSoapMessage ( const KDSoapMessage & other )

Constructs a copy of the object given by other.

Member Function Documentation

KDSoapMessage & KDSoapMessage::operator= ( const KDSoapMessage & other )

Copies the contents of the object given by other.

KDSoapMessage & KDSoapMessage::operator= ( const KDSoapValue & other )

Fills in KDSoapMessage from a KDSoapValue.

bool KDSoapMessage::operator== ( const KDSoapMessage & other ) const

Compares two KDSoapMessages

bool KDSoapMessage::operator!= ( const KDSoapMessage & other ) const

Compares two KDSoapMessages

void KDSoapMessage::setUse ( Use use )

Define the way the message should be serialized. The default value is LiteralUse.

KDSoapMessage::Use KDSoapMessage::use ( ) const

Returns the value passed to setUse().

void KDSoapMessage::addArgument	(	const QString &	argumentName,
		const QVariant &	argumentValue,
		const QString &	typeNameSpace = `QString()`,
		const QString &	typeName = `QString()`
	)

Adds an argument to the message.

Parameters

argumentName	the argument name (which corresponds to the element or attribute name in the XML)
argumentValue	this QVariant can hold either a simple value, or a KDSoapValueList of child values. (the KDSoapValueList support is mostly for the convenience of the `kdwsdl2cpp` generated code)
typeNameSpace	namespace of the type of this value; this is only useful if using KDSoapMessage::EncodedUse
typeName	localname of the type of this value; this is only useful if using KDSoapMessage::EncodedUse

Equivalent to

arguments().addArgument(argumentName, argumentValue [, typeNameSpace, typeName] );

If the message isQualified(), the value will be set to qualified as well, for convenience.

void KDSoapMessage::addArgument	(	const QString &	argumentName,
		const KDSoapValueList &	argumentValueList,
		const QString &	typeNameSpace = `QString()`,
		const QString &	typeName = `QString()`
	)

Adds a complex-type argument to the message.

Parameters

argumentName	the argument name (which corresponds to the element or attribute name in the XML)
argumentValueList	KDSoapValueList of child values.
typeNameSpace	namespace of the type of this value; this is only useful if using KDSoapMessage::EncodedUse
typeName	localname of the type of this value; this is only useful if using KDSoapMessage::EncodedUse

Equivalent to

arguments().append(KDSoapValue(argumentName, argumentValueList [, typeNameSpace, typeName] ));

If the message isQualified(), the value will be set to qualified as well, for convenience.

KDSoapValueList & KDSoapMessage::arguments ( )

Returns the arguments for the message. The list can be modified, in order to modify the message.

const KDSoapValueList & KDSoapMessage::arguments ( ) const

Returns the arguments for the message. The list is readonly; useful for inspecting a response.

bool KDSoapMessage::isFault ( ) const

Returns: true if this message is a "fault" message, or if an error occurred while parsing the XML.

A fault message is the message returned by a SOAP server when an error occurred in the processing of the request.

QString KDSoapMessage::faultAsString ( ) const

Returns: the fault message as a string that can be shown to the user.

void KDSoapMessage::setFault ( bool fault )

Turns this message into a "fault" message. Normally this is only used in server implementations that handle dynamic calls.

void KDSoapMessage::createFaultMessage	(	const QString &	faultCode,
		const QString &	faultText,
		KDSoap::SoapVersion	soapVersion
	)

Turns this message into a "fault" message, using the given code and description. This encapsulates the differences between SOAP 1.1 and 1.2. Used internally, and by server implementations that handle dynamic calls

Since: 1.8

void KDSoapMessage::setMessageAddressingProperties ( const KDSoapMessageAddressingProperties & map )

Attach to a KDSoapMessage the message addressing properties that will be written in its header. Calling this will make hasMessageAddressingProperties() return true.

Since: 1.5

bool KDSoapMessage::hasMessageAddressingProperties ( ) const

Return whether a KDSoapMessageAddressingProperties has been set for this KDSoapMessage

Since: 1.5

KDSoapMessageAddressingProperties KDSoapMessage::messageAddressingProperties ( ) const

Return the messageAddressingProperties related to the KDSoapMessage

See also: KDSoapMessageAddressingProperties

Since: 1.5

The documentation for this class was generated from the following files:

src/KDSoapClient/KDSoapMessage.h
src/KDSoapClient/KDSoapMessage.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation