TimeStep Property

The time step (in seconds) used for Time-Based One Time Password creation or validation.

Syntax

 totp.getTimeStep([callback])
 totp.setTimeStep( timeStep, [callback])

Default Value

30

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 getTimeStep([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 setTimeStep([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

This property specifies the time step (in seconds) used for Time-Based One Time Password creation or validation. This value must be specified before calling CreatePassword or ValidatePassword.

The default value is 30.

Data Type

Integer