Class FinScriptSendOrder
This Online Banking script sends one or more orders within a new FinTS dialog.
public class FinScriptSendOrder : FinScript
- Inheritance
-
FinScriptSendOrder
- Inherited Members
Constructors
FinScriptSendOrder(FinOrder, string, IFinVerificationOfPayeeForm, bool)
public FinScriptSendOrder(FinOrder aOrder, string sCustID, IFinVerificationOfPayeeForm aVopForm, bool fVopOptOutPreferred)
Parameters
aOrderFinOrderThe single order to be sent. This must not be
null.sCustIDstringOptional customer ID that shall be used for FinTS dialog initialization. If this is
null, then the DefaultCustID will be used.aVopFormIFinVerificationOfPayeeFormOptional 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.fVopOptOutPreferredboolIf
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
aOrderwasnull.
FinScriptSendOrder(FinOrder[], string, IFinVerificationOfPayeeForm, bool)
public FinScriptSendOrder(FinOrder[] vOrders, string sCustID, IFinVerificationOfPayeeForm aVopForm, bool fVopOptOutPreferred)
Parameters
vOrdersFinOrder[]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.sCustIDstringOptional customer ID that shall be used for FinTS dialog initialization. If this is
null, then the DefaultCustID will be used.aVopFormIFinVerificationOfPayeeFormOptional 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.fVopOptOutPreferredboolIf
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
vOrderswasnull.
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
aParentWindowIWin32WindowOptional parent form. If given, then the parent form will be disabled for the duration of the script execution.
aContactFinContactThe FinContact that shall be used to send the order. This must not be
null.aOrderFinOrderThe single order to be sent. This must not be
null.sCustIDstringOptional 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)
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
aParentWindowIWin32WindowOptional parent form. If given, then the parent form will be disabled for the duration of the script execution.
aContactFinContactThe FinContact that shall be used to send the order. This must not be
null.aOrderFinOrderThe single order to be sent. This must not be
null.sCustIDstringOptional customer ID that shall be used for FinTS dialog initialization. If this is
null, then the DefaultCustID will be used.aVopFormIFinVerificationOfPayeeFormOptional implementation of Verification of Payee user interface. If this is
null, then the default FinVerificationOfPayeeForm will be used.fVopOptOutPreferredboolIf
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
aParentWindowIWin32WindowOptional parent form. If given, then the parent form will be disabled for the duration of the script execution.
aContactFinContactThe FinContact that shall be used to send all the given orders. This must not be
null.vOrdersFinOrder[]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.sCustIDstringOptional 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)
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
aParentWindowIWin32WindowOptional parent form. If given, then the parent form will be disabled for the duration of the script execution.
aContactFinContactThe FinContact that shall be used to send all the given orders. This must not be
null.vOrdersFinOrder[]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.sCustIDstringOptional customer ID that shall be used for FinTS dialog initialization. If this is
null, then the DefaultCustID will be used.aVopFormIFinVerificationOfPayeeFormOptional implementation of Verification of Payee user interface. If this is
null, then the default FinVerificationOfPayeeForm will be used.fVopOptOutPreferredboolIf
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
aBankingFinBankingA 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.