GetKeyInfo Method

Gets information about a key.

Syntax

googlekms.getKeyInfo(keyName, [callback])

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 this 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 method gets information about the key specified by KeyName.

When the information is returned, the class clears the Key* properties and repopulates them with a single item that contains the key's information, and also repopulates the Label* properties. The KeyList and LabelList events are also fired.