Gio.RemoteActionGroup

Implementations:  Gio.DBusActionGroup

Methods

	activate_action_full (action_name, parameter, platform_data)
	change_action_state_full (action_name, value, platform_data)

Virtual Methods

	do_activate_action_full (action_name, parameter, platform_data)
	do_change_action_state_full (action_name, value, platform_data)

Properties

None

Signals

None

Fields

None

Class Details

class Gio.RemoteActionGroup

Bases:GObject.GInterface Structure:Gio.RemoteActionGroupInterface

The Gio.RemoteActionGroup interface is implemented by Gio.ActionGroup instances that either transmit action invocations to other processes or receive action invocations in the local process from other processes.

The interface has _full variants of the two methods on Gio.ActionGroup used to activate actions: Gio.ActionGroup.activate_action() and Gio.ActionGroup.change_action_state(). These variants allow a “platform data” GLib.Variant to be specified: a dictionary providing context for the action invocation (for example: timestamps, startup notification IDs, etc).

Gio.DBusActionGroup implements Gio.RemoteActionGroup. This provides a mechanism to send platform data for action invocations over D-Bus.

Additionally, Gio.DBusConnection.export_action_group() will check if the exported Gio.ActionGroup implements Gio.RemoteActionGroup and use the _full variants of the calls if available. This provides a mechanism by which to receive platform data for action invocations that arrive by way of D-Bus.

New in version 2.32.

activate_action_full(action_name, parameter, platform_data)

Parameters:

• action_name (str) – the name of the action to activate
• parameter (GLib.Variant or None) – the optional parameter to the activation
• platform_data (GLib.Variant) – the platform data to send

Activates the remote action.

This is the same as Gio.ActionGroup.activate_action() except that it allows for provision of “platform data” to be sent along with the activation request. This typically contains details such as the user interaction timestamp or startup notification information.

platform_data must be non-None and must have the type %G_VARIANT_TYPE_VARDICT. If it is floating, it will be consumed.

New in version 2.32.

change_action_state_full(action_name, value, platform_data)

Parameters:

• action_name (str) – the name of the action to change the state of
• value (GLib.Variant) – the new requested value for the state
• platform_data (GLib.Variant) – the platform data to send

Changes the state of a remote action.

This is the same as Gio.ActionGroup.change_action_state() except that it allows for provision of “platform data” to be sent along with the state change request. This typically contains details such as the user interaction timestamp or startup notification information.

platform_data must be non-None and must have the type %G_VARIANT_TYPE_VARDICT. If it is floating, it will be consumed.

New in version 2.32.

do_activate_action_full(action_name, parameter, platform_data) virtual

Parameters:

• action_name (str) – the name of the action to activate
• parameter (GLib.Variant or None) – the optional parameter to the activation
• platform_data (GLib.Variant) – the platform data to send

Activates the remote action.

This is the same as Gio.ActionGroup.activate_action() except that it allows for provision of “platform data” to be sent along with the activation request. This typically contains details such as the user interaction timestamp or startup notification information.

platform_data must be non-None and must have the type %G_VARIANT_TYPE_VARDICT. If it is floating, it will be consumed.

New in version 2.32.

do_change_action_state_full(action_name, value, platform_data) virtual

Parameters:

• action_name (str) – the name of the action to change the state of
• value (GLib.Variant) – the new requested value for the state
• platform_data (GLib.Variant) – the platform data to send

Changes the state of a remote action.

This is the same as Gio.ActionGroup.change_action_state() except that it allows for provision of “platform data” to be sent along with the state change request. This typically contains details such as the user interaction timestamp or startup notification information.

platform_data must be non-None and must have the type %G_VARIANT_TYPE_VARDICT. If it is floating, it will be consumed.

New in version 2.32.