HIDLog.h File Reference

Define constants required to configure HID Approve SDK logging behavior. More...

#import <Foundation/Foundation.h>

Go to the source code of this file.

Variables
SDK logging preference keys
Following strings define preference keys to add to your application to configure HID Approve SDK logging behavior
NSString *const	HID_PREFKEY_LOG_LEVEL
NSString *const	HID_PREFKEY_LOG_LOGFILEPATH
SDK logging level values
Following strings define all SDK log level (from disabled to the log verbosity when enabled).
NSString *const	HID_PREFVALUE_LOG_LEVEL_OFF
NSString *const	HID_PREFVALUE_LOG_LEVEL_ERROR
NSString *const	HID_PREFVALUE_LOG_LEVEL_INFO
NSString *const	HID_PREFVALUE_LOG_LEVEL_VERBOSE
SDK log file path values
Following strings define all SDK log file path values.
NSString *const	HID_PREFVALUE_LOG_LOGFILEPATH_SUPPORTDIR

Detailed Description

Define constants required to configure HID Approve SDK logging behavior.

SDK logs are based on Apple OSLog, but can also be redirected to a log file located in the application bundle.
Add below preferences key/value pairs to your application to configure logging behavior.

Variable Documentation

NSString* const HID_PREFKEY_LOG_LEVEL

This key controls SDK logging behavior (disabled or enabled). It also controls the log level (log verbosity) of the SDK when logging is enabled.

NSString* const HID_PREFKEY_LOG_LOGFILEPATH

When SDK log are enabled, this key controls if log should also be redirected to a log file located in the application bundle.
When this key is missing, no log file will be created.
The string value may contain NSSearchPathDirectory enum by using percent sign (for example, NSCachesDirectory%/Logs.txt).

NSString* const HID_PREFVALUE_LOG_LEVEL_ERROR

Define SDK log level to log only error events

NSString* const HID_PREFVALUE_LOG_LEVEL_INFO

Define SDK log level to log useful information and errors events

NSString* const HID_PREFVALUE_LOG_LEVEL_OFF

Define SDK log level to disabled, meaning no logs will be generated (default value)

NSString* const HID_PREFVALUE_LOG_LEVEL_VERBOSE

Define SDK log level to log all useful events during software debugging

NSString* const HID_PREFVALUE_LOG_LOGFILEPATH_SUPPORTDIR

Define SDK log file path to default value ("%NSApplicationSupportDirectory%/ApproveSDK.log").