Interface IFinCredentialForm

Namespace

Subsembly.FinTS.Online

Assembly

Subsembly.FinTS.Core.dll

Abstract interface for prompting the user for some security credentials.

public interface IFinCredentialForm

Remarks

The methods in this interface may be called from a background worker thread. Therefore all implementations must delegate all methods to the main UI thread.

Methods

GetCredential(FinContact, FinCredential)

Method to be invoked in order to prompt the user to provide some security credentials such as a PIN or TAN.

bool GetCredential(FinContact aContact, FinCredential aCredential)

Parameters

aContact FinContact

Identifies the contact for which to obtain the security information. This is used to provide as much information to the user as possible.

aCredential FinCredential

Provides all the information needed in order to create a suitable dialog box. When the user acknowledges this box, then this also returns the actual PIN or TAN.

Returns

bool

If the user entered the requested credentials and clicks OK, then true must be returned. If the user clicks CANCEL, then false must be returned.

Remarks

There is no explicit parent Window passed to this method. The implementation must determine the actual parent Window for the modal dialog by other means. Usually, the parent Windows is passed to the constructor of the actual implementation.

If a save option was provided and the user acknowledged the dialog, then the method must convey the final state of the save option checkbox through the SaveOptionChecked flag of the Options.

HidePromptAuthenticateSecure(FinContact, FinAuthenticateResult)

Remove the prompt previously shown by ShowPromptAuthenticateSecure(FinContact, string).

void HidePromptAuthenticateSecure(FinContact aContact, FinAuthenticateResult nResult)

Parameters

aContact FinContact

nResult FinAuthenticateResult

The result parameter indicates whether the secure authentication was successful, errorneous, or cancelled.

ShowPromptAuthenticateSecure(FinContact, string)

Invoked in order to show a modeless prompt to instruct the user to enter the PIN on the card reader. The method must show the prompt and return.

void ShowPromptAuthenticateSecure(FinContact aContact, string sPrompt)

Parameters

aContact FinContact

sPrompt string

The text to be shown to the user.

Remarks

The method HidePromptAuthenticateSecure(FinContact, FinAuthenticateResult) will be invoked in order to remove the prompt.