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

Inheritance diagram for HIDIA.Transaction.ITransaction:

Public Member Functions
Task< IKey >	GetSigningKey ()
	Returns the signing key object associated to that transaction. More...

Task< bool >	SetStatus (string status, char[] signingPassword, char[] sessionPassword, IList< Parameter > parameters)
	Communicates the status of the current transaction. More...

Public Member Functions inherited from HIDIA.Transaction.IServerAction
string	ToString ()
	Retrieves the message information for action More...

Properties
IList< string >	AllowedStatuses `[get]`
	Returns a list of status (for instance "accept", "deny", "report") that can be set for that transaction. More...

Properties inherited from HIDIA.Transaction.IServerAction
string	Action `[get]`
	Retrieves the action keyword More...

DateTime	Date `[get]`
	Retrieves the date associated with requested action. More...

DateTime	ExpiryDate `[get]`
	Retrieves the expiration date associated with requested action. More...

string	Payload `[get]`
	Returns an optional payload related to the requested action. More...

Detailed Description

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

Member Function Documentation

◆ GetSigningKey()

Task<IKey> HIDIA.Transaction.ITransaction.GetSigningKey ( )

Returns the signing key object associated to that transaction.

Returns: The signing key object associated to that transaction

Exceptions

InternalException Thrown when unexpected error occurred.

◆ SetStatus()

Task<bool> HIDIA.Transaction.ITransaction.SetStatus	(	string	status,
		char []	signingPassword,
		char []	sessionPassword,
		IList< Parameter >	parameters
	)

Communicates the status of the current transaction.

Parameters

status	The status of the Transaction. It must be one of the statuses previously returned by ITransaction.AllowedStatuses method.
signingPassword	The password protecting the signature key (ITransaction.GetSigningKey). Pass null if the key is not password protected.
sessionPassword	Transaction protection key password (can be null if not required by the policy).
parameters	Reserved for future use.

Returns: True if the status has been set

Exceptions

InvalidParameterException
TransactionExpiredException

Property Documentation

◆ AllowedStatuses

IList<string> HIDIA.Transaction.ITransaction.AllowedStatuses

get

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 during TransactionProcessor.retrieveTransaction call. The returned names can be used by the calling application to look up the corresponding value in a name, value pair resource files for customization/localization of displayed text to user.