HID APPROVE SDK  5.4
HID APPROVE SDK for iOS
 All Classes Files Functions Variables Enumerations Enumerator Properties Pages
HIDDevice.h
Go to the documentation of this file.
1 /* ---------------------------------------------------------------------------
2  © 2017-2020 HID Global Corporation/ASSA ABLOY AB. All rights reserved.
3 
4  Redistribution and use in source and binary forms, with or without modification,
5  are permitted provided that the following conditions are met:
6  - Redistributions of source code must retain the above copyright notice,
7  this list of conditions and the following disclaimer.
8  - Redistributions in binary form must reproduce the above copyright notice,
9  this list of conditions and the following disclaimer in the documentation
10  and/or other materials provided with the distribution.
11  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
12  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
13  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
14  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
15  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
16  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
17  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
18  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
19  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
20  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
21  --------------------------------------------------------------------------- */
22 
23 #import <Foundation/Foundation.h>
24 #import "HIDTransactionInfo.h"
25 #import "HIDTransaction.h"
27 #import "HIDProgressListener.h"
28 
38 @protocol HIDDevice
39 
71 - (id<HIDTransaction>)retrieveTransaction:(NSString*)transactionId withPassword:(NSString*)sessionPassword withParams:(NSArray*)parameters error:(NSError**)error;
72 
86 - (id<HIDTransactionInfo>)retrieveTransactionInfo:(NSString*)transactionId error:(NSError**)error;
87 
124 - (BOOL)updateDeviceInfo:(NSString*)propertyId withValue:(NSString*)propertyValue withPassword:(NSString*)sessionPassword withParams:(NSArray*)parameters error:(NSError**)error;
153 - (NSString*)getDeviceInfo:(NSString*)propertyId error:(NSError**)error;
158 - (NSString*)getVersion:(NSError**)error;
179 - (NSArray*)findContainers:(NSArray*)filter error:(NSError**)error;
203 - (id<HIDContainer>)createContainer:(HIDContainerInitialization*)config withListener:(NSObject<HIDProgressListener>*)listener error:(NSError**)error;
204 
228 - (id<HIDContainer>)createContainer:(HIDContainerInitialization*)config withSessionPassword:(NSString*)sessionPassword withListener:(NSObject<HIDProgressListener>*)listener error:(NSError**)error;
229 
246 - (BOOL)deleteContainer:(NSInteger)containerId withSessionPassword:(NSString*)sessionPassword withParams:(NSArray*)parameters error:(NSError**)error;
260 - (BOOL)reset:(NSArray*)parameters error:(NSError**)error;
261 
262 
279 - (NSArray*)searchTransactionHistory:(NSString*)sessionPassword withFilter:(NSArray*)filter error:(NSError**)error;
292 - (id<HIDProtectionPolicy>)getDefaultInitializationPolicy:(NSError**)error;
306 - (BOOL)setConnectionConfiguration:(HIDConnectionConfiguration*)config error:(NSError**)error;
307 @end
308 
312 @interface HIDDeviceFactory : NSObject
313 
317 + (id)factory;
318 
333 - (id<HIDDevice>)newInstance:(HIDConnectionConfiguration*)config error:(NSError**)error;
334 
349 - (id<HIDDevice>)newInstance:(HIDConnectionConfiguration*)config withSessionPassword:(NSString*)sessionPassword error:(NSError**)error;
350 
362 +(BOOL)reset:(NSError**)error;
363 @end
Transaction details.
Definition: HIDTransactionInfo.h:36
The protection policy defines the security parameters associated with a key or data item...
Definition: HIDProtectionPolicy.h:129
Factory for creating a new device instance.
Definition: HIDDevice.h:312
Transaction details.
Main device instance.
Definition: HIDDevice.h:38
Listener delegate to report status information or receive password request events.
This interface provides an integration point for receiving status information sent from the server du...
Definition: HIDProgressListener.h:124
Service container instance.
Definition: HIDContainer.h:40
container creation configuration
Definition: HIDContainerInitialization.h:53
id factory()
Instantiate the device factory.
Transaction object.
Encapsulates a transaction and exposes an API to apply an action status.
Definition: HIDTransaction.h:35
Connection configuration.
Connection configuration.
Definition: HIDConnectionConfiguration.h:34