KDSoapMessage Class Reference

#include <KDSoapMessage.h>

Inheritance diagram for KDSoapMessage:

List of all members.

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)
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)
void	swap (KDSoapValue &other)
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

Additional Inherited Members
Public Types inherited from KDSoapValue
enum	Use { LiteralUse, EncodedUse }

---

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.

Reimplemented from 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.

---

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

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