Lfb.GdbusFeedback¶

Implementations:: Lfb.GdbusFeedbackProxy, Lfb.GdbusFeedbackSkeleton

Methods¶

class	`interface_info` ()
class	`override_properties` (klass, property_id_begin)
	`call_end_feedback` (arg_id, cancellable, callback, *user_data)
	`call_end_feedback_finish` (res)
	`call_end_feedback_sync` (arg_id, cancellable)
	`call_trigger_feedback` (arg_app_id, arg_event, arg_hints, arg_timeout, cancellable, callback, *user_data)
	`call_trigger_feedback_finish` (res)
	`call_trigger_feedback_sync` (arg_app_id, arg_event, arg_hints, arg_timeout, cancellable)
	`complete_end_feedback` (invocation)
	`complete_trigger_feedback` (invocation, id)
	`emit_feedback_ended` (arg_id, arg_reason)

Virtual Methods¶

	`do_feedback_ended` (arg_id, arg_reason)
	`do_handle_end_feedback` (invocation, arg_id)
	`do_handle_trigger_feedback` (invocation, arg_app_id, arg_event, arg_hints, arg_timeout)

Properties¶

Name	Type	Flags	Short Description
`profile`	`str`	r/w	Profile

Signals¶

Name	Short Description
`feedback-ended`	On the client-side, this signal is emitted whenever the D-Bus signal ‘“FeedbackEnded” [gdbus-signal-org-sigxcpu-Feedback.FeedbackEnded]’ is received.
`handle-end-feedback`	Signal emitted when a remote caller is invoking the ‘EndFeedback() [gdbus-method-org-sigxcpu-Feedback.EndFeedback]’ D-Bus method.
`handle-trigger-feedback`	Signal emitted when a remote caller is invoking the ‘TriggerFeedback() [gdbus-method-org-sigxcpu-Feedback.TriggerFeedback]’ D-Bus method.

Fields¶

None

Class Details¶

class Lfb.GdbusFeedback¶

Bases:: GObject.GInterface
Structure:: Lfb.GdbusFeedbackIface

Abstract interface type for the D-Bus interface ‘org.sigxcpu.Feedback [gdbus-interface-org-sigxcpu-Feedback.top_of_page]’.

classmethod interface_info()¶

Returns:: A Gio.DBusInterfaceInfo. Do not free.
Return type:: Gio.DBusInterfaceInfo

Gets a machine-readable description of the ‘org.sigxcpu.Feedback [gdbus-interface-org-sigxcpu-Feedback.top_of_page]’ D-Bus interface.

classmethod override_properties(klass, property_id_begin)¶

Parameters:

klass (GObject.ObjectClass) – The class structure for a GObject.Object derived class.
property_id_begin (int) – The property id to assign to the first overridden property.

Returns:

The last property id.

Return type:

int

Overrides all GObject.Object properties in the Lfb.GdbusFeedback interface for a concrete class. The properties are overridden in the order they are defined.

call_end_feedback(arg_id, cancellable, callback, *user_data)¶

Parameters:

arg_id (int) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘EndFeedback() [gdbus-method-org-sigxcpu-Feedback.EndFeedback]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call Lfb.GdbusFeedback.call_end_feedback_finish() to get the result of the operation.

See Lfb.GdbusFeedback.call_end_feedback_sync() for the synchronous, blocking version of this method.

call_end_feedback_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Lfb.GdbusFeedback.call_end_feedback().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with Lfb.GdbusFeedback.call_end_feedback().

call_end_feedback_sync(arg_id, cancellable)¶

Parameters:

arg_id (int) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Synchronously invokes the ‘EndFeedback() [gdbus-method-org-sigxcpu-Feedback.EndFeedback]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See Lfb.GdbusFeedback.call_end_feedback() for the asynchronous version of this method.

call_trigger_feedback(arg_app_id, arg_event, arg_hints, arg_timeout, cancellable, callback, *user_data)¶

Parameters:

arg_app_id (str) – Argument to pass with the method invocation.
arg_event (str) – Argument to pass with the method invocation.
arg_hints (GLib.Variant) – Argument to pass with the method invocation.
arg_timeout (int) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘TriggerFeedback() [gdbus-method-org-sigxcpu-Feedback.TriggerFeedback]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call Lfb.GdbusFeedback.call_trigger_feedback_finish() to get the result of the operation.

See Lfb.GdbusFeedback.call_trigger_feedback_sync() for the synchronous, blocking version of this method.

call_trigger_feedback_finish(res)¶

Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Lfb.GdbusFeedback.call_trigger_feedback().

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

out_id:: Return location for return parameter or None to ignore.

Return type:

(bool, out_id: int)

Finishes an operation started with Lfb.GdbusFeedback.call_trigger_feedback().

call_trigger_feedback_sync(arg_app_id, arg_event, arg_hints, arg_timeout, cancellable)¶

Parameters:

arg_app_id (str) – Argument to pass with the method invocation.
arg_event (str) – Argument to pass with the method invocation.
arg_hints (GLib.Variant) – Argument to pass with the method invocation.
arg_timeout (int) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

out_id:: Return location for return parameter or None to ignore.

Return type:

(bool, out_id: int)

Synchronously invokes the ‘TriggerFeedback() [gdbus-method-org-sigxcpu-Feedback.TriggerFeedback]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See Lfb.GdbusFeedback.call_trigger_feedback() for the asynchronous version of this method.

complete_end_feedback(invocation)¶

Parameters:: invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the ‘EndFeedback() [gdbus-method-org-sigxcpu-Feedback.EndFeedback]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

complete_trigger_feedback(invocation, id)¶

Parameters:

invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
id (int) – Parameter to return.

Helper function used in service implementations to finish handling invocations of the ‘TriggerFeedback() [gdbus-method-org-sigxcpu-Feedback.TriggerFeedback]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

emit_feedback_ended(arg_id, arg_reason)¶

Parameters:

arg_id (int) – Argument to pass with the signal.
arg_reason (int) – Argument to pass with the signal.

Emits the ‘“FeedbackEnded” [gdbus-signal-org-sigxcpu-Feedback.FeedbackEnded]’ D-Bus signal.

do_feedback_ended(arg_id, arg_reason) virtual¶

Parameters:

arg_id (int) –
arg_reason (int) –

do_handle_end_feedback(invocation, arg_id) virtual¶

Parameters:

invocation (Gio.DBusMethodInvocation) –
arg_id (int) –

Return type:

bool

do_handle_trigger_feedback(invocation, arg_app_id, arg_event, arg_hints, arg_timeout) virtual¶

Parameters:

invocation (Gio.DBusMethodInvocation) –
arg_app_id (str) –
arg_event (str) –
arg_hints (GLib.Variant) –
arg_timeout (int) –

Return type:

bool

Signal Details¶

Lfb.GdbusFeedback.signals.feedback_ended(gdbus_feedback, arg_id, arg_reason)¶

Signal Name:

feedback-ended

Flags:

RUN_LAST

Parameters:

gdbus_feedback (Lfb.GdbusFeedback) – The object which received the signal
arg_id (int) – Argument.
arg_reason (int) – Argument.

On the client-side, this signal is emitted whenever the D-Bus signal ‘“FeedbackEnded” [gdbus-signal-org-sigxcpu-Feedback.FeedbackEnded]’ is received.

On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal.

Lfb.GdbusFeedback.signals.handle_end_feedback(gdbus_feedback, invocation, arg_id)¶

Signal Name:

handle-end-feedback

Flags:

RUN_LAST

Parameters:

gdbus_feedback (Lfb.GdbusFeedback) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
arg_id (int) – Argument passed by remote caller.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘EndFeedback() [gdbus-method-org-sigxcpu-Feedback.EndFeedback]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call Lfb.GdbusFeedback.complete_end_feedback() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

Lfb.GdbusFeedback.signals.handle_trigger_feedback(gdbus_feedback, invocation, arg_app_id, arg_event, arg_hints, arg_timeout)¶

Signal Name:

handle-trigger-feedback

Flags:

RUN_LAST

Parameters:

gdbus_feedback (Lfb.GdbusFeedback) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
arg_app_id (str) – Argument passed by remote caller.
arg_event (str) – Argument passed by remote caller.
arg_hints (GLib.Variant) – Argument passed by remote caller.
arg_timeout (int) – Argument passed by remote caller.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘TriggerFeedback() [gdbus-method-org-sigxcpu-Feedback.TriggerFeedback]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call Lfb.GdbusFeedback.complete_trigger_feedback() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

Property Details¶

Lfb.GdbusFeedback.props.profile¶

Name:: profile
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“Profile” [gdbus-property-org-sigxcpu-Feedback.Profile]’.

Since the D-Bus property for this GObject.Object property is both readable and writable, it is meaningful to both read from it and write to it on both the service- and client-side.