HID APPROVE SDK  5.7.1
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"
26 #import "HIDServerActionInfo.h"
27 #import "HIDServerAction.h"
29 #import "HIDProgressListener.h"
30 
40 @protocol HIDDevice
41 
56 - (id<HIDTransactionInfo>)retrieveTransactionInfo:(NSString*)transactionId error:(NSError**)error;
57 
72 - (id<HIDServerActionInfo>)retrieveActionInfo:(NSString*)actionId error:(NSError**)error;
73 
111 - (BOOL)updateDeviceInfo:(NSString*)propertyId withValue:(NSString*)propertyValue withPassword:(NSString*)sessionPassword withParams:(NSArray*)parameters error:(NSError**)error;
112 
141 - (NSString*)getDeviceInfo:(NSString*)propertyId error:(NSError**)error;
142 
147 - (NSString*)getVersion:(NSError**)error;
148 
169 - (NSArray*)findContainers:(NSArray*)filter error:(NSError**)error;
170 
194 - (id<HIDContainer>)createContainer:(HIDContainerInitialization*)config withSessionPassword:(NSString*)sessionPassword withListener:(NSObject<HIDProgressListener>*)listener error:(NSError**)error;
195 
214 - (BOOL)deleteContainer:(NSInteger)containerId withSessionPassword:(NSString*)sessionPassword withParams:(NSArray*)parameters error:(NSError**)error;
215 
230 - (NSArray*)searchTransactionHistory:(NSString*)sessionPassword withFilter:(NSArray*)filter error:(NSError**)error;
231 
245 - (BOOL)setConnectionConfiguration:(HIDConnectionConfiguration*)config error:(NSError**)error;
246 @end
247 
251 @interface HIDDeviceFactory : NSObject
252 
256 + (id)factory;
257 
272 - (id<HIDDevice>)newInstance:(HIDConnectionConfiguration*)config error:(NSError**)error;
273 
290 - (id<HIDDevice>)newInstance:(HIDConnectionConfiguration*)config withSessionPassword:(NSString*)sessionPassword error:(NSError**)error;
291 
303 +(BOOL)reset:(NSError**)error;
304 @end
Transaction details.
Definition: HIDTransactionInfo.h:37
Factory for creating a new device instance.
Definition: HIDDevice.h:251
Transaction details.
Main device instance.
Definition: HIDDevice.h:40
Listener delegate to report status information or receive password request events.
Action details.
Definition: HIDServerActionInfo.h:36
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
Configuration for creation of a Container.
Definition: HIDContainerInitialization.h:60
id factory()
Instantiate the device factory.
Transaction object.
ServerAction object.
Connection configuration.
Configuration of server connections.
Definition: HIDConnectionConfiguration.h:42
Action details.