Debug — Telepathy D-Bus Interface Specification

# Interface Debug

Interface Index (Compact) | Summary | Description | Methods | Signals | Properties | Types

### Methods

GetMessages | () | → | a(dsus): Messages |

### Signals

NewDebugMessage | (d: time, s: domain, u: level, s: message) |

### Properties

Enabled | b | Read/Write |  |

### Types

Debug_Level | Enum | u |
Debug_Message | Struct | (dsus) |

Added in 0.17.27. (as stable API)

### Description

An interface for providing debug messages.

This interface is primarily provided by one object per service, at the path `/org/freedesktop/Telepathy/debug`.

# Methods

(Permalink)

## GetMessages () → a(dsus): Messages

### Returns

- Messages — a(dsus) (Debug_Message_List)
A list of debug messages.

Retrieve buffered debug messages. An implementation could have a limit on how many message it keeps and so the array returned from this method should not be assumed to be all of the messages in the lifetime of the service.

# Signals

(Permalink)

## NewDebugMessage (d: time, s: domain, u: level, s: message)

### Parameters

- time — d
Timestamp of the debug message.
- domain — s
Domain of the debug message, as described in the Debug_Message struct.
- level — u (Debug_Level)
Level of the debug message.
- message — s
The text of the debug message.

Emitted when a debug messages is generated if the Enabled property is set to TRUE.

# Properties

Accessed using the org.freedesktop.DBus.Properties interface.
(Permalink)

## Enabled — b

Read/Write
TRUE if the NewDebugMessage signal should be emitted when a new debug message is generated.

# Types

Enum (Permalink)

## Debug_Level — u

- Error (0)
Log level for errors. Error messages are always fatal, resulting in the service terminating after something completely unexpected occurred.
- Critical (1)
Log level for critical messages. Critical messages are messages that the service might predict and it is up to the service itself to decide whether to terminate following a critical message.
- Warning (2)
Log level for warnings.
- Message (3)
Log level for messages.
- Info (4)
Log level for information messages.
- Debug (5)
Log level for debug messages.

Struct (Permalink)

## Debug_Message — (dsus)

A struct representing a debug message, as returned by GetMessages.

- Timestamp — d
Timestamp of the debug message. This is a double to allow more accuracy in the time the message was logged.
- Domain — s

Domain of the debug message. This is used to identify the source of debug messages. For example, debug messages from a connection manager could have this Domain struct member be the name of the connection manager, and logs from any helper library could have the name of the helper library.

The domain could also contain a category as to where the log message originated separated by a forward-slash. For example, if a debug message was output in a connection manager called "dummy", in the file-transfer code, this Domain struct member might be `dummy/file-transfer`.

- Level — u (Debug_Level)
Level of the debug message. This states the severity of the debug message.
- Message — s
The text of the debug message.