RecipientPrimary Property

Indicates whether the recipient is the primary receiver.

Syntax

 adaptivepay.getRecipientPrimary(index, [callback])
 adaptivepay.setRecipientPrimary(index,  recipientPrimary, [callback])

Default Value

FALSE

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 getRecipientPrimary([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 setRecipientPrimary([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

Indicates whether the recipient is the primary receiver.

If this property is set to True, this is a chained payment. If the property is False, this is a simple or parallel payment.

The size of the array is controlled by the RecipientCount property.

This property is not available at design time.

Data Type

Boolean