KeyboardInteractivePromptEcho Property

Specifies if the client should echo the value entered by the user or not.

Syntax

 sshdaemon.getKeyboardInteractivePromptEcho(index, [callback])
 sshdaemon.setKeyboardInteractivePromptEcho(index,  keyboardInteractivePromptEcho, [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 getKeyboardInteractivePromptEcho([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 setKeyboardInteractivePromptEcho([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

Specifies if the client should echo the value entered by the user or not.

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

This property is not available at design time.

Data Type

Boolean