Structure

HIDApproveLogging

String constants for use with Logging mechanism.

A OSLog Type Properties S let LEVEL: String S let LEVEL_ERROR: String S let LEVEL_INFO: String S let LEVEL_OFF: String S let LEVEL_VERBOSE: String S let LOGFILEPATH: String S let LOGFILEPATH_SUPPORTDIR: String Error Handling S HIDApproveError

Declaration

struct HIDApproveLogging

Overview

To facilitate troubleshooting and debugging, you can activate the SDK logging feature.

For iOS, the logging functionality leverages Apple OSLog.

Logs can also be generated in a log file located in the application bundle.

The SDK logging feature is activated according to the UserDefaults configuration of the application preferences.

Example Code:

    UserDefaults.standard.set(HIDApproveLogging.LEVEL_ERROR, forKey: HIDApproveLogging.LOG_LEVEL);

  

Topics

Type Properties

static let LEVEL: String

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

static let LEVEL_ERROR: String

Define SDK log level to log only error events

static let LEVEL_INFO: String

Define SDK log level to log useful information and errors events

static let LEVEL_OFF: String

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

static let LEVEL_VERBOSE: String

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

static let LOGFILEPATH: String

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).

static let LOGFILEPATH_SUPPORTDIR: String

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