Cloud Keys 2020 Node.js Edition

Questions / Feedback?

KeyPurgeDate Property

The purge date of the key.

Syntax

 azurekeys.getKeyPurgeDate(index, [callback])

Default Value

-1

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 getKeyPurgeDate([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 setKeyPurgeDate([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

The purge date of the key.

This property reflects the purge (i.e., permanent deletion) date of the key, in seconds since the Unix epoch, or -1 if the key has not been deleted.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Long64

Copyright (c) 2022 /n software inc. - All rights reserved.
Cloud Keys 2020 Node.js Edition - Version 20.0 [Build 8157]