CustomAuthStart Event

Reports the beginning of a custom authentication method.

Syntax

class AuthenticatorCustomAuthStartEventParams {
public:
  const QString &UserID();
  const QString &AuthMethod();
  const QString &AuthMethodPars();
  void SetAuthMethodPars(const QString &qsAuthMethodPars);
  const QString &AuthMethodData();
  void SetAuthMethodData(const QString &qsAuthMethodData);
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void CustomAuthStart(AuthenticatorCustomAuthStartEventParams *e);

// Or, subclass Authenticator and override this emitter function.
virtual int FireCustomAuthStart(AuthenticatorCustomAuthStartEventParams *e) {...}

Remarks

This event marks the start of an authentication method not supported by class internally and requests authentication parameters from the application.

Class currently supports the following authentication methods:

• password
• otp-h
• otp-t
• dcauth

The application may also use any number of custom authentication method it wants. Each such method is identified by a unique string name (such as 'pin', 'fingerprint', or 'fingerprint-v2'). It may specify them in DefaultAuthMethods property, or provide on the fly via AuthStart event.

The event handler may return authentication parameters and application-specific data to be associated with the authentication attempt via AuthMethodPars and AuthMethodData parameters.