Class EbicsAdmin

Collection of static EBICS contact administration functions.

Inheritance

object

EbicsAdmin

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Subsembly.EBICS.Admin

Assembly: Subsembly.EBICS.Win32.dll

Syntax

public static class EbicsAdmin

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.

Declaration

[Obsolete]
public static EbicsContactFolder DefaultFolder { get; }

Property Value

Type	Description
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.

Declaration

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

Parameters

Type	Name	Description
EbicsContact	aContact	The EbicsContact that shall receive the accepted bank keys. Must not be null.
EbicsPubKeyInfo	aAuthKey	The authentication key of the bank, probably downloaded through DownloadBankKeys(IEbicsSecurityMedium, IEbicsTransport). Must not be null.
EbicsPubKeyInfo	aEncKey	The encryption key of the bank, probably downloaded through DownloadBankKeys(IEbicsSecurityMedium, IEbicsTransport). Must not be null.

Returns

Type	Description
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)

Declaration

public static EbicsOrderSPR BlockKeys(IWin32Window aParentForm, EbicsContact aContact)

Parameters

Type	Name	Description
IWin32Window	aParentForm
EbicsContact	aContact

Returns

Type	Description
EbicsOrderSPR

BrowseForKeyFile(string, string, bool)

Declaration

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

Parameters

Type	Name	Description
string	sCaption
string	sFileName
bool	fCreate

Returns

Type	Description
string

ChangeKeys(IWin32Window, EbicsContact)

Changes the keys.

Declaration

public static EbicsOrder ChangeKeys(IWin32Window aParentForm, EbicsContact aContact)

Parameters

Type	Name	Description
IWin32Window	aParentForm
EbicsContact	aContact

Returns

Type	Description
EbicsOrder

GenerateUserKeysIniLetter(EbicsContact)

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

Declaration

public static void GenerateUserKeysIniLetter(EbicsContact aContact)

Parameters

Type	Name	Description
EbicsContact	aContact	Required EbicsContact object that already contains the complete user key data.

GetContactState(EbicsContact)

Declaration

public static EbicsAdminContactState GetContactState(EbicsContact aContact)

Parameters

Type	Name	Description
EbicsContact	aContact

Returns

Type	Description
EbicsAdminContactState

SendSystemKeys(IWin32Window, EbicsContact)

Sends the system keys to the bank (HIA).

Declaration

public static EbicsOrderHIA SendSystemKeys(IWin32Window aParentForm, EbicsContact aContact)

Parameters

Type	Name	Description
IWin32Window	aParentForm
EbicsContact	aContact	EbicsContact object that provides the contact information of the user who's system keys shall be sent. Must not be null.

Returns

Type	Description
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).

Declaration

public static EbicsOrderINI SendUserKey(IWin32Window aParentForm, EbicsContact aContact)

Parameters

Type	Name	Description
IWin32Window	aParentForm
EbicsContact	aContact	EbicsContact object that provides the contact information of the user who's signature key shall be sent. Must not be null.

Returns

Type	Description
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)

Declaration

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

Parameters

Type	Name	Description
IEbicsContactFolder	aContactFolder
IWin32Window	aOwner
Icon	aCaptionIcon
string	sCaptionText

SyncBankKeys(IWin32Window, EbicsContact)

Downloads the bank keys and asks user to accepts them.

Declaration

public static void SyncBankKeys(IWin32Window aParentForm, EbicsContact aContact)

Parameters

Type	Name	Description
IWin32Window	aParentForm
EbicsContact	aContact	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.

Declaration

public static EbicsOrder UpgradeKeys(IWin32Window aParentForm, EbicsContact aContact)

Parameters

Type	Name	Description
IWin32Window	aParentForm
EbicsContact	aContact

Returns

Type	Description
EbicsOrder