Key instance.
More...
#import <HIDKey.h>
- (NSString*) getAlgorithm: |
|
(NSError **) |
error |
|
Gets the standard algorithm name for the key.
- Parameters
-
error | error details. It may be nil. |
- Returns
- The algorithm name.
Returns the default OTP generator associated with the key.
- Parameters
-
error | error details. It may be nil. |
- Returns
- The HIDOTPGenerator instance, nil if key is not supporting any OTP generators or an error occurs.
- (NSData*) getEncoded: |
|
(NSError **) |
error |
|
Gets the key in its primary encoding format.
- Parameters
-
error | error details. It may be nil. |
Possible error codes are:
- Returns
- the key in its primary encoding format, or nil if an error occurred
- (NSData*) getEncoded: |
|
(NSString *) |
password |
error: |
|
(NSError **) |
error |
|
|
| |
Gets the key in its primary encoding format.
- Parameters
-
password | the key password. |
error | error details. It may be nil. |
Possible error codes are:
- Returns
- The key in its primary encoding format, or nil if an error occurred.
- (NSString*) getFormat: |
|
(NSError **) |
error |
|
Gets the name of the primary encoding format of this key.
- Parameters
-
error | error details. It may be nil. |
- Returns
- The encoding format name.
Gets the keyId associated with key.
- Returns
- the keyId, nil if not set.
- (id<HIDOTPGenerator>) getOTPGenerator: |
|
(NSString *) |
name |
error: |
|
(NSError **) |
error |
|
|
| |
Returns the OTP generator with specified name associated with a key.
- Parameters
-
Possible error codes are:
- Returns
- The HIDOTPGenerator instance, nil if key is not supporting any OTP generators or an error occurs.
- (NSString*) getProperty: |
|
(NSString *) |
propertyId |
error: |
|
(NSError **) |
error |
|
|
| |
Returns property for that key.
- Parameters
-
propertyId | key property name. |
The property name may be any of the following:
- Parameters
-
error | error details. It may be nil. |
Possible error codes are:
- Returns
- The key property value, nil if an error occurs.
Gets the protection policy associated with key.
- Parameters
-
error | error details. It may be nil. |
Possible error codes are:
- Returns
- The HIDProtectionPolicy used to protect the key, nil if an error occurs.
- (NSArray*) getSupportedOTPGenerators: |
|
(NSError **) |
error |
|
Returns the list of supported OTP generators associated with the key.
- Parameters
-
error | error details. It may be nil. |
Possible error codes are:
- Returns
- The list of HIDOTPGenerator instances, nil if key is not supporting any OTP generators or an error occurs.
- (BOOL) isExtractable: |
|
(NSError **) |
error |
|
Returns true when the key is extractable.
- Parameters
-
error | error details. It may be nil. |
- Returns
- true or false depending on whether the key is extractable or not.
The documentation for this protocol was generated from the following file: