<HIDServerAction> Protocol Reference

Encapsulates an action extracted from an encrypted server message. More...

#include <HIDServerAction.h>

Inheritance diagram for <HIDServerAction>:

Instance Methods
(NSString *)	- getAction:
	Returns the nature of the action.
(NSDate *)	- getDate:
	Retrieves the date associated with requested action.
(NSDate *)	- getExpiryDate:
	Retrieves the expiration date associated with requested action.
(NSString *)	- getPayload:
	Returns an optional payload related to the request action.
(NSString *)	- toString
	Returns the message information for action.

Detailed Description

Encapsulates an action extracted from an encrypted server message.

Method Documentation

getAction:

- (NSString *) getAction:

(NSError **)

error

Returns the nature of the action.

Parameters

error

error details. It may be nil.

Possible error codes are:

• HIDInternal if unexpected error occurred.
• HIDNotImplemented if not implemented

Returns

Retrieves the action keyword, nil if not set yet or an error occurs.

Reimplemented in <HIDTransaction>.

getDate:

- (NSDate *) getDate:

(NSError **)

error

Retrieves the date associated with requested action.

Parameters

error

error details. It may be nil.

Possible error codes are:

• HIDInternal if unexpected error occurred.
• HIDNotImplemented if not implemented

Returns

the date, nil if not provided or an error occurs.

Reimplemented in <HIDTransaction>.

getExpiryDate:

- (NSDate *) getExpiryDate:

(NSError **)

error

Retrieves the expiration date associated with requested action.

Parameters

error

error details. It may be nil.

Possible error codes are:

• HIDInternal if unexpected error occurred.
• HIDNotImplemented if not implemented

Returns

the date, nil if not provided or an error occurs.

Reimplemented in <HIDTransaction>.

getPayload:

- (NSString *) getPayload:

(NSError **)

error

Returns an optional payload related to the request action.

Parameters

error

error details. It may be nil.

Possible error codes are:

• HIDInternal if unexpected error occurred.

Returns

payload related to the request action., nil if not set yet or an error occurs.

toString

- (NSString *) toString

Returns the message information for action.

Returns

Message contents

Reimplemented in <HIDTransaction>.