HID APPROVE SDK  5.7.1
HID APPROVE SDK for iOS
 All Classes Files Functions Variables Enumerations Enumerator Properties Pages
<HIDServerActionInfo> Protocol Reference

Action details. More...

#import <HIDServerActionInfo.h>

Instance Methods

(id< HIDServerAction >) - getAction:withParams:error:
 Extracts the action data associated with this action info. More...
 
(id< HIDContainer >) - getContainer:
 Retrieves the container associated with that action. More...
 
(id< HIDKey >) - getProtectionKey:
 Retrieves the protection key associated with that action. More...
 
(NSString *) - getUniqueIdentifier
 Retrieves the action unique identifier. More...
 

Detailed Description

Action details.

Method Documentation

- (id<HIDServerAction>) getAction: (NSString *)  sessionPassword
withParams: (NSArray *)  parameters
error: (NSError **)  error 

Extracts the action data associated with this action info.

Parameters
sessionPasswordprotection key password (can be nil if not required by the policy)
parametersReserved for future use.
errorerror details. It may be nil.

Possible error codes are:

Returns
a HIDServerAction instance containing action details, nil if an error occurs.
- (id<HIDContainer>) getContainer: (NSError **)  error

Retrieves the container associated with that action.

Parameters
errorerror details. It may be nil.

Possible error codes are:

Returns
the container, nil if an error occurs.
- (id<HIDKey>) getProtectionKey: (NSError **)  error

Retrieves the protection key associated with that action.

Parameters
errorerror details. It may be nil.

Possible error codes are:

Returns
The action protection session key, nil if an error occurs.
- (NSString*) getUniqueIdentifier

Retrieves the action unique identifier.

Returns
action unique identifier.

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