IPWorks Auth 2020 Node.js Edition

Questions / Feedback?

ChallengeFormat Property

The format in which the challenge will be created.

Syntax

 ocra.getChallengeFormat([callback])
 ocra.setChallengeFormat( challengeFormat, [callback])

Possible Values

  0 (cfAlphanumeric), 
  1 (cfNumeric), 
  2 (cfHex)

Default Value

0

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 getChallengeFormat([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 setChallengeFormat([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 setting specifies the format of the created challenge. This is applicable when calling CreateChallenge. Possible values are:

0 (cfAlphanumeric - default) Alphanumeric characters
1 (cfNumeric) Digits
2 (cfHex) Hex characters

Data Type

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Auth 2020 Node.js Edition - Version 20.0 [Build 8155]