KDSoapMessage Class Reference

#include <KDSoapMessage.h>

Inheritance diagram for KDSoapMessage:

List of all members.

Public Types
enum	Use { LiteralUse, EncodedUse }
Public Member Functions
	KDSoapMessage ()
	~KDSoapMessage ()
	KDSoapMessage (const KDSoapMessage &other)
KDSoapMessage &	operator= (const KDSoapMessage &other)
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
Friends
QDebug	operator<< (QDebug dbg, const KDSoapMessage &msg)

---

Detailed Description

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

---

Member Enumeration Documentation

enum KDSoapMessage::Use

Defines the way the message should be serialized. See the "use" attribute for soap:body, in the WSDL file.

Enumerator:

LiteralUse	data is serialized according to a given schema, no xsi:type attributes are written out
EncodedUse	each message part references an abstract type using the xsi:type attribute

---

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.

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] );

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] ));

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. A fault message is the message returned by a SOAP server when an error occurred.

QString KDSoapMessage::faultAsString

(

)

const

Returns:

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

---

Friends And Related Function Documentation

QDebug operator<<	(	QDebug	dbg,
		const KDSoapMessage &	msg
	)			[friend]

Support for debugging KDSoapMessage objects via qDebug() << msg;

---

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

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