WorkspacesLogger Class

Provides logging services for the Workspaces SDK. Currently uses NLog as the underlying logging provider.

Inheritance Hierarchy

SystemObject
BlackBerry.Workspaces.LoggerWorkspacesLogger

Namespace: BlackBerry.Workspaces.Logger
Assembly: BlackBerryWorkspacesSDK (in BlackBerryWorkspacesSDK.dll) Version: 7.0.0.223 (7.0.0.223)

Syntax

Copy

public class WorkspacesLogger

The WorkspacesLogger type exposes the following members.

Properties

	Name	Description
	IsDebugEnabled	Indicates if logging is enabled at DEBUG level
	IsErrorEnabled	Indicates if logging is enabled at ERROR level
	IsFatalEnabled	Indicates if logging is enabled at FATAL level
	IsInfoEnabled	Indicates if logging is enabled at INFO level
	IsTraceEnabled	Indicates if logging is enabled at TRACE level
	IsWarnEnabled	Indicates if logging is enabled at WARN level

Top

Methods

	Name	Description
	Debug(String, Object)	Logs a message at the DEBUG log level
	Debug(Exception, String, Object)	Logs an exception at the DEBUG log level
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Error(String, Object)	Logs a message at the ERROR log level
	Error(Exception, String, Object)	Logs an exception at the ERROR log level
	Fatal(String, Object)	Logs a message at the FATAL log level
	Fatal(Exception, String, Object)	Logs an exception at the FATAL log level
	GetAssemblyLogger	Get a logger for the calling assembly
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetLoggerT	Get a logger by type
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Info(String, Object)	Logs a message at the INFO log level
	Info(Exception, String, Object)	Logs an exception at the INFO log level
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Trace(String, Object)	Logs a message at the TRACE log level
	Trace(Exception, String, Object)	Logs an exception at the TRACE log level
	Warn(String, Object)	Logs a message at the WARN log level
	Warn(Exception, String, Object)	Logs an exception at the WARN log level

Top

Fields

	Name	Description
	Log	Static WorkspacesLogger associated with the calling assembly.

Top

Remarks

To configure logging add a "section" element for nlog to the "configSections" element of app.config. Then add the Nlog configuration as a nlog element. See https://github.com/NLog/NLog/wiki/Tutorial#configuration

Copy

<configSections>
  <section name = "nlog" type="NLog.Config.ConfigSectionHandler, NLog"/>
</configSections>

<nlog autoReload="true" xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <targets>
    <target name="logfile" xsi:type="File" fileName="${basedir}/workspacessdk.log" layout="${message}" keepFileOpen="true" />
    <target name="console" xsi:type="ColoredConsole" layout="${date:format=HH\:MM\:ss} ${logger} ${message}"/>
  </targets>
  <rules>
    <logger name = "*" minlevel="Trace" writeTo="logfile, console"/>
  </rules>
</nlog>

Reference

BlackBerry.Workspaces.Logger Namespace