HID APPROVE SDK
5.13
HID Approve SDK for iOS/macOS
|
Encapsulates a transaction and exposes an API to apply an action status and context. More...
#import <HIDTransaction.h>
Instance Methods | |
(NSString *) | - getAction: |
Returns the nature of the action. More... | |
(NSArray *) | - getAllowedStatuses |
Returns a list of status (for instance "accept", "deny", "report") that can be set for that transaction. More... | |
(NSDate *) | - getDate: |
Gets status change date for the transaction. More... | |
(NSDate *) | - getExpiryDate: |
Returns Retrieves the expiration date associated with requested action. More... | |
(id< HIDKey >) | - getSigningKey: |
Gets the Signing Key object associated with that transaction. More... | |
(BOOL) | - setStatus:withSigningPassword:withSessionPassword:withParams:error: |
Communicates the status and context information of this transaction along with cryptographic signature. More... | |
(NSString *) | - toString |
Returns the transaction text to be displayed to the user. More... | |
Instance Methods inherited from <HIDServerAction> | |
(NSString *) | - getPayload: |
Returns an optional payload related to the request action. More... | |
Encapsulates a transaction and exposes an API to apply an action status and context.
- (NSString*) getAction: | (NSError **) | error |
Returns the nature of the action.
error | error details. It may be nil. |
Possible error codes are:
Reimplemented from <HIDServerAction>.
- (NSArray*) getAllowedStatuses |
Returns a list of status (for instance "accept", "deny", "report") that can be set for that transaction.
The values are retrieved from the transaction response message sent back by the server. The returned names can be used by the calling application to look up the corresponding value in a name/value pair resource file for customization/localization of displayed text to user.
- (NSDate*) getDate: | (NSError **) | error |
Gets status change date for the transaction.
error | error details. It may be nil. |
Possible error codes are:
Reimplemented from <HIDServerAction>.
- (NSDate*) getExpiryDate: | (NSError **) | error |
Returns Retrieves the expiration date associated with requested action.
error | error details. It may be nil. |
Possible error codes are:
Reimplemented from <HIDServerAction>.
- (id<HIDKey>) getSigningKey: | (NSError **) | error |
Gets the Signing Key object associated with that transaction.
error | error details. It may be nil. |
Possible error codes are:
- (BOOL) setStatus: | (NSString *) | status | |
withSigningPassword: | (NSString *) | signPassword | |
withSessionPassword: | (NSString *) | sessionPassword | |
withParams: | (NSArray *) | parameters | |
error: | (NSError **) | error | |
Communicates the status and context information of this transaction along with cryptographic signature.
status | status to apply to transaction with signature. |
The status must be one of the statuses returned by the getAllowedStatuses method.
signPassword | the password protecting the signature key. (can be nil if not required by the policy) |
sessionPassword | transaction protection key password (can be nil if not required by the policy) |
parameters | array of NSParameter objects |
Parameter can be defined with following id:
error | error details. It may be nil. |
Possible error codes are:
- (NSString*) toString |
Returns the transaction text to be displayed to the user.
Reimplemented from <HIDServerAction>.