IPWorks Auth 2020 Node.js Edition

Questions / Feedback?

UserDetailsEmailVerified Property

This property indicates whether the user's email address has been verified.

Syntax

 openid.getUserDetailsEmailVerified([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 getUserDetailsEmailVerified([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 setUserDetailsEmailVerified([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 indicates whether the user's email address has been verified. To be considered verified the end-user must prove the email address was under the user's control at the time of verification.

This property is read-only and not available at design time.

Data Type

Boolean

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