<HIDTransaction> Protocol Reference

Encapsulates a transaction and exposes an API to apply an action status. More...

#import <HIDTransaction.h>

Instance Methods
(NSArray *)	- getAllowedStatuses
	Returns a list of status names(for instance approve, deny, report) that can be set for that transaction. More...
(NSDate *)	- getDate:
	Gets status change date for the transaction. More...
(id< HIDKey >)	- getSigningKey:
	Gets the Signing Key object associated with that transaction. More...
(NSString *)	- getStatus:
	Returns the status of the transaction. More...
(BOOL)	- setStatus:withParams:error:
	Deprecated. Communicates the status of this transaction using provided key identifier. More...
(BOOL)	- setStatus:withSigningPassword:withSessionPassword:withParams:error:
	Communicates the status of this transaction. More...
(NSString *)	- toString
	Returns the transaction text to be displayed to the user. More...

Detailed Description

Encapsulates a transaction and exposes an API to apply an action status.

Method Documentation

- (NSArray*) getAllowedStatuses

Returns a list of status names(for instance approve, deny, report) that can be set for that transaction.

Returns

the NSString array contains the possible status values to be used with setStatus.

See also

- setStatus:withSigningPassword:withSessionPassword:withParams:error:

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.

Parameters

error

error details. It may be nil.

Possible error codes are:

• HIDInternal if unexpected error occurs

Returns

the date, nil if not set yet or an error occurs.

- (id<HIDKey>) getSigningKey:

(NSError **)

error

Gets the Signing Key object associated with that transaction.

Parameters

error

error details. It may be nil.

Possible error codes are:

• HIDInternal if unexpected error occurs

Returns

the key, nil if an error occurs.

- (NSString*) getStatus:

(NSError **)

error

Returns the status of the transaction.

Parameters

error

error details. It may be nil.

Possible error codes are:

• HIDInternal if unexpected error occurs

Returns

the status of the transaction, nil if not set yet or an error occurs.

- (BOOL) setStatus:		(NSString *)	status
withParams:		(NSArray *)	parameters
error:		(NSError **)	error

Deprecated. Communicates the status of this transaction using provided key identifier.

Parameters

status

status to apply to transaction with signature.

The status must be one of the statuses returned by the getAllowedStatuses method.

Parameters

parameters

NSArray of HIDParameter objects used to pass in extra parameter, for instance if the signature key is protected by a second factor password.

Supported parameters:

• HID_PARAM_SYNC_PWD_SIGN
• HID_PARAM_SYNC_PWD_TXPROTECT

Parameters

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

boolean true if successful.

Exceptions

NSInvalidArgumentException

if invalid parameter is given

Deprecated:

Deprecated in SDK 5.1. Integrations should replace calls with the setStatus:withSigningPassword:withSessionPassword:withParams:error: method.

- (BOOL) setStatus:		(NSString *)	status
withSigningPassword:		(NSString *)	signPassword
withSessionPassword:		(NSString *)	sessionPassword
withParams:		(NSArray *)	parameters
error:		(NSError **)	error

Communicates the status of this transaction.

Parameters

status

status to apply to transaction with signature.

The status must be one of the statuses returned by the getAllowedStatuses method.

Parameters

parameters	NSArray of HIDParameter objects used to pass in extra parameter, for instance if the signature key is protected by a second factor password.
signPassword	signature key protection password (can be nil if not required by the policy)
sessionPassword	transaction protection key password (can be nil if not required by the policy)
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

boolean true if successful.

Exceptions

NSInvalidArgumentException

if invalid parameter is given

See also

- findKeys:error: (HIDContainer-p)

- (NSString*) toString

Returns the transaction text to be displayed to the user.

Returns

Transaction text string.

---

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

• HIDTransaction.h