kopete/protocols/messenger/libpapillon

Papillon::TweenerHandler

Papillon::TweenerHandler Class Reference

#include <Papillon/Http/TweenerHandler>

Inheritance diagram for Papillon::TweenerHandler:

[legend]

List of all members.

Detailed Description

Negotiation of the Tweener ticket with Passport login server.

Using TweenerHandler: Use setLoginInformation() to set required login information and start() to begin negotiation of the tweener.

 TweenerHandler *twn = new TweenerHandler();
 twn->setLoginInformation(tweener, QLatin1String("test@passport.com"), QLatinString("password"));
 connect(twn, SIGNAL(result(TweenerHandler *)), this, SLOT(tweenerResult(TweenerHandler*)));
 twn->start();

If success() return false, assume that the password was bad.

Author:: Michaël Larouche <larouche@kde.org>

Definition at line 43 of file tweenerhandler.h.


Public Types
enum	TweenerState { TwnGetServer, TwnAuth }
Public Slots
void	start ()
Signals
void	result (TweenerHandler *tweenerHandler)
Public Member Functions
void	setLoginInformation (const QString &tweener, const QString &passportId, const QString &password)
bool	success () const
QString	ticket () const
	TweenerHandler (QObject *parent=0)
	~TweenerHandler ()

Member Enumeration Documentation

enum Papillon::TweenerHandler::TweenerState

TweenerState is using to switch the current state of the process.

Enumerator:

TwnGetServer	We are getting the name of the Passport login server.
TwnAuth	Sending authentication to the Passport login server.

Definition at line 50 of file tweenerhandler.h.

Constructor & Destructor Documentation

Papillon::TweenerHandler::TweenerHandler ( QObject * parent = 0 )

Build a new TweenerHandler.

Parameters:

parent

QObject parent.

Definition at line 59 of file tweenerhandler.cpp.

Papillon::TweenerHandler::~TweenerHandler ( )

d-tor.

Definition at line 67 of file tweenerhandler.cpp.

Member Function Documentation

void Papillon::TweenerHandler::result ( TweenerHandler * tweenerHandler ) [signal]

Emitted when the negotiation is done.

Look with success() if the task was a succes or not and ticket() to get the retrieved ticket.

Parameters:

tweenerHandler

this

void Papillon::TweenerHandler::setLoginInformation	(	const QString &	tweener,
		const QString &	passportId,
		const QString &	password
	)

Setup the login information for the negotiation You must call this method before calling start().

Parameters:

	tweener	tweener string challenge received from Messenger Notification server.
	passportId	the passport id.
	password	password.

Definition at line 72 of file tweenerhandler.cpp.

void Papillon::TweenerHandler::start ( ) [slot]

Start negotiation process.

You must set login information before or this class will fail.

Definition at line 79 of file tweenerhandler.cpp.

bool Papillon::TweenerHandler::success ( ) const

Return the succes of the negotiation.

Returns:: false if the passport was bad.

Definition at line 245 of file tweenerhandler.cpp.

QString Papillon::TweenerHandler::ticket ( ) const

Get the ticket retrieve by this class.

Call this in the slot of result() signal.

Returns:: the Passport ticket.

Definition at line 250 of file tweenerhandler.cpp.

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

kopete/protocols/messenger/libpapillon

Papillon::TweenerHandler Class Reference

Detailed Description

Public Types

Public Slots

Signals

Public Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

kopete/protocols/messenger/libpapillon

kdenetwork