KeyPurpose Property
The key's purpose.
Syntax
googlekms.getKeyPurpose(index, [callback])
Possible Values
0 (gkpUnspecified), 1 (gkpEncryptDecrypt), 2 (gkpAsymmetricSign), 3 (gkpAsymmetricDecrypt)
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 getKeyPurpose([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 setKeyPurpose([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 key's purpose.
This property reflects the key's purpose. Possible values are:
- gkpUnspecified (0)
- gkpEncryptDecrypt (1) (indicates the key is symmetric)
- gkpAsymmetricSign (2)
- gkpAsymmetricDecrypt (3)
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
Integer