HID APPROVE SDK
5.7.1
HID APPROVE SDK for iOS
|
Main device instance. More...
#import <HIDDevice.h>
Instance Methods | |
(id< HIDContainer >) | - createContainer:withSessionPassword:withListener:error: |
Creates the container. More... | |
(BOOL) | - deleteContainer:withSessionPassword:withParams:error: |
Deletes a container identified by its ID. The method notifies the server the container is deleted, thus requires the device to be online. More... | |
(NSArray *) | - findContainers:error: |
Retrieves a container based on input parameter filter. More... | |
(NSString *) | - getDeviceInfo:error: |
Retrieves device information. More... | |
(NSString *) | - getVersion: |
Returns the version of the transaction processor client API. More... | |
(id< HIDServerActionInfo >) | - retrieveActionInfo:error: |
Retrieves and decrypts an encrypted "server action" message received from the server. More... | |
(id< HIDTransactionInfo >) | - retrieveTransactionInfo:error: |
Deprecated. Retrieves a transaction info associated to that transaction ID. More... | |
(NSArray *) | - searchTransactionHistory:withFilter:error: |
Searches for transactions in the transaction history. (RFU) More... | |
(BOOL) | - setConnectionConfiguration:error: |
Sets connection configuration. More... | |
(BOOL) | - updateDeviceInfo:withValue:withPassword:withParams:error: |
Updates device information. More... | |
Main device instance.
- (id<HIDContainer>) createContainer: | (HIDContainerInitialization *) | config | |
withSessionPassword: | (NSString *) | sessionPassword | |
withListener: | (NSObject< HIDProgressListener > *) | listener | |
error: | (NSError **) | error | |
Creates the container.
config | initialization configuration see HIDContainerInitialization for details |
sessionPassword | transaction protection key password (can be nil if not required by the policy) |
listener | A HIDProgressListener implementation to which to report status information or receive password request events. |
error | error details. It may be nil. |
Possible error codes are:
- (BOOL) deleteContainer: | (NSInteger) | containerId | |
withSessionPassword: | (NSString *) | sessionPassword | |
withParams: | (NSArray *) | parameters | |
error: | (NSError **) | error | |
Deletes a container identified by its ID. The method notifies the server the container is deleted, thus requires the device to be online.
containerId | id of the container. |
sessionPassword | transaction protection key password (can be nil if not required by the policy). |
parameters | can be empty (reserved for future use). |
error | error details. It may be nil. |
Possible error codes are:
- (NSArray*) findContainers: | (NSArray *) | filter | |
error: | (NSError **) | error | |
Retrieves a container based on input parameter filter.
filter | array of Parameter objects required to specify container |
Filter can indicate:
error | error details. It may be nil. |
Possible error codes are:
- (NSString*) getDeviceInfo: | (NSString *) | propertyId | |
error: | (NSError **) | error | |
Retrieves device information.
propertyId | deviceInfo property to retrieve. |
Supported property names:
error | error details. It may be nil. |
Possible error codes are:
- (NSString*) getVersion: | (NSError **) | error |
Returns the version of the transaction processor client API.
- (id<HIDServerActionInfo>) retrieveActionInfo: | (NSString *) | actionId | |
error: | (NSError **) | error | |
Retrieves and decrypts an encrypted "server action" message received from the server.
actionId | action ID message received in push notification or via HIDContainer.retrieveTransactionsIds() |
error | error details. It may be nil. |
Possible error codes are:
- (id<HIDTransactionInfo>) retrieveTransactionInfo: | (NSString *) | transactionId | |
error: | (NSError **) | error | |
Deprecated. Retrieves a transaction info associated to that transaction ID.
transactionId | transaction ID message received in push notification. |
error | error details. It may be nil. |
Possible error codes are:
- (NSArray*) searchTransactionHistory: | (NSString *) | sessionPassword | |
withFilter: | (NSArray *) | filter | |
error: | (NSError **) | error | |
Searches for transactions in the transaction history. (RFU)
sessionPassword | transaction protection key password (can be nil if not required by the policy). |
filter | TransactionFilter. |
error | error details. It may be nil. |
Possible error codes are:
NSInternalInconsistencyException | if not implemented |
- (BOOL) setConnectionConfiguration: | (HIDConnectionConfiguration *) | config | |
error: | (NSError **) | error | |
Sets connection configuration.
config | configuration, see HIDConnectionConfiguration for details. |
error | error details. It may be nil. |
Possible error codes are:
- (BOOL) updateDeviceInfo: | (NSString *) | propertyId | |
withValue: | (NSString *) | propertyValue | |
withPassword: | (NSString *) | sessionPassword | |
withParams: | (NSArray *) | parameters | |
error: | (NSError **) | error | |
Updates device information.
This method is used by the application to notify of a change in one of the externally generated device attributes.
propertyId | deviceInfo property to update. |
Supported name attributes:
sessionPassword | transaction protection key password (can be nil if not required by the policy) |
propertyValue | the new value to replace. |
parameters | empty (reserved for future use) |
Supported parameters:
error | error details. It may be nil. |
Possible error codes are: