PublicKeyValid Property
Indicates the validity status of the key.
Syntax
pgpkeyring.getPublicKeyValid(index, [callback])
Possible Values
0 (pkvStrictlyValid), 1 (pkvValid), 2 (pkvInvalid), 3 (pkvFailure), 4 (pkvUnknown)
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 getPublicKeyValid([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 setPublicKeyValid([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 the validity status of the key.
pkvStrictlyValid | 0 | Strictly valid |
pkvValid | 1 | Valid |
pkvInvalid | 2 | Invalid |
pkvFailure | 3 | Generic validation failure |
pkvUnknown | 4 | Validity unknown |
The index parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer