Interface IPluginLog
Contract for logging
Namespace: Sdl.Desktop.IntegrationApi.Interfaces
Assembly: Sdl.Desktop.IntegrationApi.dll
Syntax
public interface IPluginLogRemarks
You can get an instance of a logger through the logging service (see IPluginLoggerFactory
Methods
Debug(Object)
Logs a debug message.
Declaration
void Debug(object message)Parameters
| Type | Name | Description |
|---|---|---|
| Object | message | The message to log. |
DebugFormat(String, Object[])
Logs a debug message using the specified format and arguments.
Declaration
void DebugFormat(string format, params object[] args)Parameters
| Type | Name | Description |
|---|---|---|
| String | format | The format for the message. |
| Object[] | args | The arguments to populate the message format. |
Error(Object)
Logs an error message.
Declaration
void Error(object message)Parameters
| Type | Name | Description |
|---|---|---|
| Object | message | The message to log. |
Error(Object, Exception)
Logs an error message, including the specified exception.
Declaration
void Error(object message, Exception exception)Parameters
| Type | Name | Description |
|---|---|---|
| Object | message | The message to log. |
| Exception | exception | The exception. |
ErrorFormat(String, Object[])
Logs an error message using the specified format and arguments.
Declaration
void ErrorFormat(string format, params object[] args)Parameters
| Type | Name | Description |
|---|---|---|
| String | format | The format for the message. |
| Object[] | args | The arguments to populate the message format. |
Fatal(Object)
Logs a fatal error message.
Declaration
void Fatal(object message)Parameters
| Type | Name | Description |
|---|---|---|
| Object | message | The message to log. |
Fatal(Object, Exception)
Logs an fatal error message, including the specified exception.
Declaration
void Fatal(object message, Exception exception)Parameters
| Type | Name | Description |
|---|---|---|
| Object | message | The message to log. |
| Exception | exception | The exception. |
FatalFormat(String, Object[])
Logs a fatal error message using the specified format and arguments.
Declaration
void FatalFormat(string format, params object[] args)Parameters
| Type | Name | Description |
|---|---|---|
| String | format | The format for the message. |
| Object[] | args | The arguments to populate the message format. |
Info(Object)
Logs a debug message.
Declaration
void Info(object message)Parameters
| Type | Name | Description |
|---|---|---|
| Object | message | The message to log. |
Info(Object, Exception)
Logs an info message, including the specified exception.
Declaration
void Info(object message, Exception exception)Parameters
| Type | Name | Description |
|---|---|---|
| Object | message | The message to log. |
| Exception | exception | The exception. |
InfoFormat(String, Object[])
Logs an info message using the specified format and arguments.
Declaration
void InfoFormat(string format, params object[] args)Parameters
| Type | Name | Description |
|---|---|---|
| String | format | The format for the message. |
| Object[] | args | The arguments to populate the message format. |
Warn(Object)
Logs a warning message.
Declaration
void Warn(object message)Parameters
| Type | Name | Description |
|---|---|---|
| Object | message | The message to log. |
Warn(Object, Exception)
Logs a warning message, including the specified exception.
Declaration
void Warn(object message, Exception exception)Parameters
| Type | Name | Description |
|---|---|---|
| Object | message | The message to log. |
| Exception | exception | The exception. |
WarnFormat(String, Object[])
Logs a warning message using the specified format and arguments.
Declaration
void WarnFormat(string format, params object[] args)Parameters
| Type | Name | Description |
|---|---|---|
| String | format | The format for the message. |
| Object[] | args | The arguments to populate the message format. |