AuthenticateResponse Class Reference

#include <authenticateresponse.h>

Public Member Functions
	AuthenticateResponse (const AuthenticateResponse &response)
AuthenticateResponse &	operator= (const AuthenticateResponse &other)
QString	authSessionId () const
bool	hasPrompts () const
QList< Prompt >	prompts () const
bool	success () const
QString	errorMessage () const
QString	banner () const
QString	token () const
bool	isValid () const

Static Public Member Functions
static AuthenticateResponse	fromXml (const QString &xml)

Detailed Description

class used to model UIT AuthenticateResponse

Member Function Documentation

authSessionId()

QString authSessionId

(

)

const

Returns

The current UIT auth session id

hasPrompts()

bool hasPrompts

(

)

const

Returns

True is the underlying UIT message has user prompts, false otherwise

prompts()

QList< Prompt > prompts

(

)

const

Returns

The list of prompts that need to presented to the user.

success()

bool success

(

)

const

Returns

true, if the authenticateUser() call was successful, false otherwise.

errorMessage()

QString errorMessage

(

)

const

Returns

Any error message associated with this response.

banner()

QString banner

(

)

const

Returns

Banner text to be displayed to the user along with the prompts.

token()

QString token

(

)

const

Returns

The session token returned when authentication was successful.

isValid()

bool isValid

(

)

const

Returns

true is the XML message provided by the server was valid, false otherwise.

fromXml()

AuthenticateResponse fromXml ( const QString & xml )

static

Static method to create a AuthenticateResponse instance from a incoming XML message.

Parameters

The	XML message.

---

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

• authenticateresponse.h