TelepathyLogger.LogWalker¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`get_events_async` (num_events, callback, *user_data)
	`get_events_finish` (result)
	`is_end` ()
	`is_start` ()
	`rewind_async` (num_events, callback, *user_data)
	`rewind_finish` (result)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`filter`	`int`	r/w/co	An optional filter function
`filter-data`	`int`	r/w/co	User data to pass to the filter function

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r
priv	`TelepathyLogger.LogWalkerPriv`	r

Class Details¶

class TelepathyLogger.LogWalker(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: TelepathyLogger.LogWalkerClass

An object used to iterate over the logs

New in version 0.8.0.

get_events_async(num_events, callback, *user_data)¶

Parameters:

num_events (int) – number of maximum events to fetch
callback (Gio.AsyncReadyCallback or None) – a callback to call when the request is satisfied
user_data (object or None) – data to pass to callback

Walk the logs to retrieve the next most recent num_event events.

New in version 0.8.0.

get_events_finish(result)¶

Parameters:

result (Gio.AsyncResult) – a Gio.AsyncResult

Raises:

GLib.Error

Returns:

True if the operation was successful, otherwise False.

events:: a pointer to a GLib.List used to return the list TelepathyLogger.Event

Return type:

(bool, events: [TelepathyLogger.Event])

New in version 0.8.0.

is_end()¶

Returns:: True if self has run out of events, otherwise False.
Return type:: bool

Determines whether self has run out of events. This is the case when self has returned all the events from the logs.

New in version 0.8.0.

is_start()¶

Returns:: True if self is pointing at the most recent event, otherwise False.
Return type:: bool

Determines whether self is pointing at the most recent event in the logs. This is the case when self has not yet returned any events or has been rewound completely.

New in version 0.8.0.

rewind_async(num_events, callback, *user_data)¶

Parameters:

num_events (int) – number of events to move back
callback (Gio.AsyncReadyCallback or None) – a callback to call when the request is satisfied
user_data (object or None) – data to pass to callback

Move the self back by the last num_event events that were returned by TelepathyLogger.LogWalker.get_events_async().

New in version 0.8.0.

rewind_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Returns:: True if the operation was successful, otherwise False.
Return type:: bool

New in version 0.8.0.

Property Details¶

TelepathyLogger.LogWalker.props.filter¶

Name:: filter
Type:: int
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

An optional filter function

TelepathyLogger.LogWalker.props.filter_data¶

Name:: filter-data
Type:: int
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

User data to pass to the filter function