OFXBatchItemRequest Property

OFX request aggregate.

Syntax

 ofxbatch.getOFXBatchItemRequest(index, [callback])
 ofxbatch.setOFXBatchItemRequest(index,  OFXBatchItemRequest, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getOFXBatchItemRequest([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setOFXBatchItemRequest([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

OFX request aggregate. The OFXBatchItemRequest is obtained by setting it to a OFXRequest aggregate of a class that corresponds to that request type. For example:

OFXBatch.OFXBatchItemCount = 3;
OFXBatch.OFXBathcItems[0].Request = BankStatement.OFXRequest;
OFXBatch.OFXBathcItems[1].Request = CCStatement.OFXRequest;
OFXBatch.OFXBathcItems[2].Request = FIProfile.OFXRequest;

Message sets will/must appear in the following order in the batch request sent to the server: Signon, Signup, Bank statement, Intrabank funds transfers, Credit card statements, Loan statements, Investment statements, Interbank funds transfers, and FI Profile, regardless of their order while populating the OFXBatchItems. In the server response, the message sets will be returned in the server response in the same order.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the OFXBatchItemCount property.

This property is not available at design time.

Data Type

String