Class FinScriptSendOrder

Namespace: Subsembly.FinTS.Forms

Assembly: Subsembly.FinTS.Win32.dll

This Online Banking script sends one or more orders within a new FinTS dialog.

public class FinScriptSendOrder : FinScript

Inheritance: object

FinScript

FinScriptSendOrder

Inherited Members: FinScript.AutoCloseDocket

FinScript.StartScript(IWin32Window, string, FinContact)

FinScript.Trace

FinScript.ClearTrace()

FinScript.Result

FinScript.Docket

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

FinScriptSendOrder(FinOrder, string, IFinVerificationOfPayeeForm, bool)

public FinScriptSendOrder(FinOrder aOrder, string sCustID, IFinVerificationOfPayeeForm aVopForm, bool fVopOptOutPreferred)

Parameters

aOrder FinOrder: The single order to be sent. This must not be null.
sCustID string: Optional customer ID that shall be used for FinTS dialog initialization. If this is null, then the DefaultCustID will be used.
aVopForm IFinVerificationOfPayeeForm: Optional implementation of Verification of Payee user interface. If this is null, then the default FinVerificationOfPayeeForm will be used. A delegating implementation may be provided, in order to intercept the callback and get the VopResults of the orders.
fVopOptOutPreferred bool: If true, then the user prefers to Opt-Out from Verification of Payee, if this is possible. There is never a guarantee that the order is really sent without Verification of Payee. Also note, that even when opting out from Verification of Payee the IFinVerificationOfPayeeForm will be invoked in order to obtain the Opt-Out confirmation from the user.

Exceptions

ArgumentNullException: The parameter aOrder was null.

FinScriptSendOrder(FinOrder[], string, IFinVerificationOfPayeeForm, bool)

public FinScriptSendOrder(FinOrder[] vOrders, string sCustID, IFinVerificationOfPayeeForm aVopForm, bool fVopOptOutPreferred)

Parameters

vOrders FinOrder[]: An array of orders to be sent. This array may be empty, but it must not be null. If this array is empty, then this script does nothing but initialize the HBCI dialog and then immediately terminate it again.
sCustID string: Optional customer ID that shall be used for FinTS dialog initialization. If this is null, then the DefaultCustID will be used.
aVopForm IFinVerificationOfPayeeForm: Optional implementation of Verification of Payee user interface. If this is null, then the default FinVerificationOfPayeeForm will be used. A delegating implementation may be provided, in order to intercept the callback and get the VopResults of the orders.
fVopOptOutPreferred bool: If true, then the user prefers to Opt-Out from Verification of Payee, if this is possible. There is never a guarantee that the order is really sent without Verification of Payee. Also note, that even when opting out from Verification of Payee the IFinVerificationOfPayeeForm will be invoked in order to obtain the Opt-Out confirmation from the user.

Exceptions

ArgumentNullException: The parameter vOrders was null.

Methods

Execute(IWin32Window, FinContact, FinOrder, string)

Creates an instance of this Online Banking script and runs it.

public static FinScriptSendOrder Execute(IWin32Window aParentWindow, FinContact aContact, FinOrder aOrder, string sCustID)

Parameters

aParentWindow IWin32Window: Optional parent form. If given, then the parent form will be disabled for the duration of the script execution.
aContact FinContact: The FinContact that shall be used to send the order. This must not be null.
aOrder FinOrder: The single order to be sent. This must not be null.
sCustID string: Optional customer ID that shall be used for FinTS dialog initialization. If this is null, then the DefaultCustID will be used.

Returns

FinScriptSendOrder: Returns the executed script object. This can be used to access script properties such as Trace.

Remarks

Sends the given order, trying to Opt-Out from Verification of Payee and using the default FinVerificationOfPayeeForm.

See Also: Execute(IWin32Window, FinContact, FinOrder, string, IFinVerificationOfPayeeForm, bool)

Execute(IWin32Window, FinContact, FinOrder, string, IFinVerificationOfPayeeForm, bool)

Creates an instance of this Online Banking script and runs it.

public static FinScriptSendOrder Execute(IWin32Window aParentWindow, FinContact aContact, FinOrder aOrder, string sCustID, IFinVerificationOfPayeeForm aVopForm, bool fVopOptOutPreferred)

Parameters

aParentWindow IWin32Window: Optional parent form. If given, then the parent form will be disabled for the duration of the script execution.
aContact FinContact: The FinContact that shall be used to send the order. This must not be null.
aOrder FinOrder: The single order to be sent. This must not be null.
sCustID string: Optional customer ID that shall be used for FinTS dialog initialization. If this is null, then the DefaultCustID will be used.
aVopForm IFinVerificationOfPayeeForm: Optional implementation of Verification of Payee user interface. If this is null, then the default FinVerificationOfPayeeForm will be used.
fVopOptOutPreferred bool: If true, then the user prefers to Opt-Out from Verification of Payee, if this is possible.

Returns

FinScriptSendOrder: Returns the executed script object. This can be used to access script properties such as Trace.

Execute(IWin32Window, FinContact, FinOrder[], string)

Creates an instance of this Online Banking script and runs it.

public static FinScriptSendOrder Execute(IWin32Window aParentWindow, FinContact aContact, FinOrder[] vOrders, string sCustID)

Parameters

aParentWindow IWin32Window: Optional parent form. If given, then the parent form will be disabled for the duration of the script execution.
aContact FinContact: The FinContact that shall be used to send all the given orders. This must not be null.
vOrders FinOrder[]: An array of orders to be sent. This array may be empty, but it must not be null. If this array is empty, then this script does nothing but initialize the HBCI dialog and then immediately terminating it again.
sCustID string: Optional customer ID that shall be used for FinTS dialog initialization. If this is null, then the DefaultCustID will be used.

Returns

FinScriptSendOrder: Returns the executed script object. This can be used to access script properties such as Trace.

Remarks

Sends the given orders, trying to Opt-Out from Verification of Payee and using the default FinVerificationOfPayeeForm.

See Also: Execute(IWin32Window, FinContact, FinOrder[], string, IFinVerificationOfPayeeForm, bool)

Execute(IWin32Window, FinContact, FinOrder[], string, IFinVerificationOfPayeeForm, bool)

Creates an instance of this Online Banking script and runs it.

public static FinScriptSendOrder Execute(IWin32Window aParentWindow, FinContact aContact, FinOrder[] vOrders, string sCustID, IFinVerificationOfPayeeForm aVopForm, bool fVopOptOutPreferred)

Parameters

aParentWindow IWin32Window: Optional parent form. If given, then the parent form will be disabled for the duration of the script execution.
aContact FinContact: The FinContact that shall be used to send all the given orders. This must not be null.
vOrders FinOrder[]: An array of orders to be sent. This array may be empty, but it must not be null. If this array is empty, then this script does nothing but initialize the HBCI dialog and then immediately terminating it again.
sCustID string: Optional customer ID that shall be used for FinTS dialog initialization. If this is null, then the DefaultCustID will be used.
aVopForm IFinVerificationOfPayeeForm: Optional implementation of Verification of Payee user interface. If this is null, then the default FinVerificationOfPayeeForm will be used.
fVopOptOutPreferred bool: If true, then the user prefers to Opt-Out from Verification of Payee, if this is possible.

Returns

FinScriptSendOrder: Returns the executed script object. This can be used to access script properties such as Trace.

OnRunScript(FinBanking)

protected override FinDialogResult OnRunScript(FinBanking aBanking)

Parameters

aBanking FinBanking: A completely initialized new FinBanking instance. This was set up with the default FinCredentialManager configured to use the default FinDocketForm, FinCredentialForm, FinTanProcForm, and FinBankingPinStore. Hence there will be a default progress Form and all PIN/TAN handling will be done through the default Forms.

Returns

FinDialogResult: A final FinDialogResult. Must not be null.