<HIDTransactionInfo> Protocol Reference

Transaction details. More...

#import <HIDTransactionInfo.h>

Instance Methods
(id< HIDContainer >)	- getContainer:
	Retrieves the container associated with that transaction. More...
(id< HIDTransaction >)	- getTransaction:withParams:error:
	Retrieves a transaction associated with this transaction info. More...
(id< HIDKey >)	- getTransactionProtectionKey:
	Retrieves the transaction protection key associated with that transaction. More...
(uint64_t)	- getUniqueIdentifier
	Retrieves the transaction unique identifier. More...

Detailed Description

Transaction details.

Method Documentation

- (id<HIDContainer>) getContainer:

(NSError **)

error

Retrieves the container associated with that transaction.

Parameters

error

error details. It may be nil.

Possible error codes are:

• HIDInternal if unexpected error occurs

Returns

the container, nil if an error occurs.

- (id<HIDTransaction>) getTransaction:		(NSString *)	sessionPassword
withParams:		(NSArray *)	parameters
error:		(NSError **)	error

Retrieves a transaction associated with this transaction info.

Parameters

sessionPassword	transaction protection key password (can be nil if not required by the policy)
parameters	NSArray of HIDParameter objects required to retrieve the transaction (such as password if needed).
error	error details. It may be nil.

Possible error codes are:

• HIDAuthentication if invalid password is given
• HIDTransactionExpired if transaction is no longer valid
• HIDCredentialsExpired if key is no longer valid
• HIDInternal if unexpected error occurs
• HIDPasswordExpired if password is expired and requires password change according to protection policy.
• HIDServerAuthentication if server rejects authentication

Returns

a HIDTransaction instance containing transaction details, nil if an error occurs.

Exceptions

NSInvalidArgumentException

if invalid parameter is given

- (id<HIDKey>) getTransactionProtectionKey:

(NSError **)

error

Retrieves the transaction protection key associated with that transaction.

Parameters

error

error details. It may be nil.

Possible error codes are:

• HIDInternal if unexpected error occurs

Returns

The transaction protection session key, nil if an error occurs.

- (uint64_t) getUniqueIdentifier

Retrieves the transaction unique identifier.

Returns

transaction challenge id

---

The documentation for this protocol was generated from the following file:

• HIDTransactionInfo.h