---

HBCI::Auth Class Reference

Interface class to provide a method to retrieve a PIN. More...

#include <auth.h>

List of all members.

Public Methods
	Auth (Hbci *hbci)
virtual	~Auth ()
virtual Error	getSecret (Pointer< User > user, const string &token, string &secret, bool createSecret=false)

---

Detailed Description

Interface class to provide a method to retrieve a PIN.

This class provides a method to retrieve a secret (e.g. a pin). The default implementation calls Interactor::msgInputPin(). You may inherit this class to introduce new retrieving mechanisms.

Author:

Martin Preuss<openhbci@aquamaniac.de>

---

Constructor & Destructor Documentation

HBCI::Auth::Auth (  Hbci *    hbci )

Constructor. Author: Martin Preuss<openhbci@aquamaniac.de> Parameters: hbci  pointer to central HBCI object

virtual HBCI::Auth::~Auth (    )  [virtual]

---

Member Function Documentation

virtual Error HBCI::Auth::getSecret (  Pointer< User >    user, const string &    token, string &    secret, bool    createSecret = false )  [virtual]

This method retrieves a PIN and writes it into the string reference argument 'secret'. The default implementation calls Interactor::msgInputPin(). If you want to retrieve the PIN by any other means, you can provide your own derivation of Auth and override this method. You may use the given token to identify the secret. Author: Martin Preuss<openhbci@aquamaniac.de> Returns : returns a Error object to show the result. Call "isOk()" on it, to see if any error occurred. Parameters: user  pointer to the user for whom the secret is to be retrieved From this user object you can get all information you might need to show an explanatory dialog. token  A string providing additional information to identify the PIN OpenHBCI is asking for. When a MediumDDV (chip card) asks for a pin, it shows here the "cardnumber", whereas a MediumRDH presents the "path/filename" of the medium to be accessed. secret  reference to a string to receive the secret (e.g. the pin). createSecret  if true then a new secret is to be created. In this case the user should be asked to enter the pin twice.

---

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

• auth.h

---