MessageSetName Property

Name of a message set supported by the given FI.

Syntax

 fiprofile.getMessageSetName(index, [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 getMessageSetName([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 setMessageSetName([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

Name of a message set supported by the given FI.

Each MessageSetAggregate corresponds to a different OFX command. For example, SIGNONMSGSET corresponds to SignOn Request Message. The MessageSetName is used to retrieve the name of the command associated with this Message Set.

The following table lists each message set, along with its aggregate name and the OFX Versions that support it.


Message Set	Message Set Aggregate	OFX Version support
Signon	SIGNONMSGSETV1	1.0.2, 1.0.3, 1.5.1, 1.6, 2.0, 2.0.1, 2.0.2, 2.0.3, 2.1, 2.1.1
Signup	SIGNUPMSGSETV1	1.0.2, 1.0.3, 1.5.1, 1.6, 2.0, 2.0.1, 2.0.2, 2.0.3, 2.1, 2.1.1
Banking	BANKMSGSETV1	1.0.2, 1.0.3, 1.5.1, 1.6, 2.0, 2.0.1, 2.0.2, 2.0.3, 2.1, 2.1.1
Credit Card Statements	CREDITCARDMSGSETV1	1.0.2, 1.0.3, 1.5.1, 1.6, 2.0, 2.0.1, 2.0.2, 2.0.3, 2.1, 2.1.1
Loan Statements	LOANMSGSETV1	2.1, 2.1.1
Investment Statements	INVSTMTMSGSETV1	1.0.2, 1.0.3, 1.5.1, 1.6, 2.0, 2.0.1, 2.0.2, 2.0.3, 2.1, 2.1.1
Interbank Funds Transfers	INTERXFERMSGSETV1	1.0.2, 1.0.3, 1.5.1, 1.6, 2.0, 2.0.1, 2.0.2, 2.0.3, 2.1, 2.1.1
Payments	BILLPAYMSGSETV1	1.0.2, 1.0.3, 1.5.1, 1.6, 2.0, 2.0.1, 2.0.2, 2.0.3, 2.1, 2.1.1
Investment security list	SECLISTMSGSETV1	1.0.2, 1.0.3, 1.5.1, 1.6, 2.0, 2.0.1, 2.0.2, 2.0.3, 2.1, 2.1.1
FI Profile	PROFMSGSETV1	1.0.2, 1.0.3, 1.5.1, 1.6, 2.0, 2.0.1, 2.0.2, 2.0.3, 2.1, 2.1.1
Image download	IMAGEMSGSETV1	2.1, 2.1.1

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

This property is read-only and not available at design time.

Data Type