Class EbicsAdmin

Namespace
Subsembly.EBICS.Admin
Assembly
Subsembly.EBICS.Win32.dll

Collection of static EBICS contact administration functions.

public static class EbicsAdmin
Inheritance
EbicsAdmin
Inherited Members

Remarks

These functions are actually called by the EbicsAdminForm. Use these functions in order to integrate the EBICS adminstration functions into your own GUI.

Properties

DefaultFolder

Returns a reference to the system default folder for EBICS contacts.

[Obsolete]
public static EbicsContactFolder DefaultFolder { get; }

Property Value

EbicsContactFolder

Remarks

By default the EbicsAdmin contact manager stores the contact data in a user private application data folder.

Methods

AcceptBankKeys(EbicsContact, EbicsPubKeyInfo, EbicsPubKeyInfo)

Prompts the user to accept the given bank keys.

public static bool AcceptBankKeys(EbicsContact aContact, EbicsPubKeyInfo aAuthKey, EbicsPubKeyInfo aEncKey)

Parameters

aContact EbicsContact

The EbicsContact that shall receive the accepted bank keys. Must not be null.

aAuthKey EbicsPubKeyInfo

The authentication key of the bank, probably downloaded through DownloadBankKeys(IEbicsSecurityMedium, IEbicsTransport). Must not be null.

aEncKey EbicsPubKeyInfo

The encryption key of the bank, probably downloaded through DownloadBankKeys(IEbicsSecurityMedium, IEbicsTransport). Must not be null.

Returns

bool

If the bank keys have been accepted by the user and are now stored in the given EbicsContact, then true is returned. If the user rejected the back keys, then false is returned.

BlockKeys(IWin32Window, EbicsContact) 

public static EbicsOrderSPR BlockKeys(IWin32Window aParentForm, EbicsContact aContact)

Parameters

aParentForm IWin32Window
aContact EbicsContact

Returns

EbicsOrderSPR

BrowseForKeyFile(string, string, bool) 

public static string BrowseForKeyFile(string sCaption, string sFileName, bool fCreate)

Parameters

sCaption string
sFileName string
fCreate bool

Returns

string

ChangeKeys(IWin32Window, EbicsContact)

Changes the keys.

public static EbicsOrder ChangeKeys(IWin32Window aParentForm, EbicsContact aContact)

Parameters

aParentForm IWin32Window
aContact EbicsContact

Returns

EbicsOrder

GenerateUserKeysIniLetter(EbicsContact)

Creates and shows the Ini-letter for the given contact.

public static void GenerateUserKeysIniLetter(EbicsContact aContact)

Parameters

aContact EbicsContact

Required EbicsContact object that already contains the complete user key data.

GetContactState(EbicsContact) 

public static EbicsAdminContactState GetContactState(EbicsContact aContact)

Parameters

aContact EbicsContact

Returns

EbicsAdminContactState

SendSystemKeys(IWin32Window, EbicsContact)

Sends the system keys to the bank (HIA).

public static EbicsOrderHIA SendSystemKeys(IWin32Window aParentForm, EbicsContact aContact)

Parameters

aParentForm IWin32Window
aContact EbicsContact

EbicsContact object that provides the contact information of the user who's system keys shall be sent. Must not be null.

Returns

EbicsOrderHIA

If the transaction was sent, then the completed EbicsOrderHIA instance is returned. If the transaction was aborted or could not be built, then null is returned.

SendUserKey(IWin32Window, EbicsContact)

Sends the users signature key to the bank (INI).

public static EbicsOrderINI SendUserKey(IWin32Window aParentForm, EbicsContact aContact)

Parameters

aParentForm IWin32Window
aContact EbicsContact

EbicsContact object that provides the contact information of the user who's signature key shall be sent. Must not be null.

Returns

EbicsOrderINI

If the transaction was sent, then the completed EbicsOrderINI instance is returned. If the transaction was aborted or could not be built, then null is returned.

ShowAdmin(IEbicsContactFolder, IWin32Window, Icon, string) 

public static void ShowAdmin(IEbicsContactFolder aContactFolder, IWin32Window aOwner, Icon aCaptionIcon, string sCaptionText)

Parameters

aContactFolder IEbicsContactFolder
aOwner IWin32Window
aCaptionIcon Icon
sCaptionText string

SyncBankKeys(IWin32Window, EbicsContact)

Downloads the bank keys and asks user to accepts them.

public static void SyncBankKeys(IWin32Window aParentForm, EbicsContact aContact)

Parameters

aParentForm IWin32Window
aContact EbicsContact

EbicsContact object that provides the contact information of the user for whom the bank keys shall be downloaded. Must not be null.

UpgradeKeys(IWin32Window, EbicsContact)

Changes the keys.

public static EbicsOrder UpgradeKeys(IWin32Window aParentForm, EbicsContact aContact)

Parameters

aParentForm IWin32Window
aContact EbicsContact

Returns

EbicsOrder