OFTPConnectionSignedReceipt Property

Indicates whether a signed receipt is requested.

Syntax

 oftpserver.getOFTPConnectionSignedReceipt(index, [callback])
 oftpserver.setOFTPConnectionSignedReceipt(index,  OFTPConnectionSignedReceipt, [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 getOFTPConnectionSignedReceipt([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 setOFTPConnectionSignedReceipt([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 a signed receipt is requested.

When sending files, if this is set to true a signed receipt will be requested. In that case OFTPConnectionRecipientCertStoreType, OFTPConnectionRecipientCertStore, and OFTPConnectionRecipientCertSubject must be set to specify the public certificate that will be used to verify the signature on the receipt returned by the client after SendFile is called. The class will automatically verify the signature on the returned receipt.

When receiving files, query this property to determine if the client requested a signed receipt. If true, the Certificate property must be set to a certificate with private key in order to sign the receipt that will be returned to the client. The class will sign and deliver the receipt automatically.

Note that this is only applicable when Version 2.0 of the protocol is used as indicated by OFTPConnectionVersion.

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

This property is not available at design time.

Data Type

Boolean