Interface RemoteActionGroup

All Superinterfaces:

ActionGroup, Proxy

All Known Implementing Classes:

DBusActionGroup, RemoteActionGroup.RemoteActionGroup$Impl

@Generated("org.javagi.JavaGI")
public interface RemoteActionGroup
extends Proxy, ActionGroup

The GRemoteActionGroup interface is implemented by 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 ActionGroup used to activate actions: ActionGroup.activateAction(String, Variant) and ActionGroup.changeActionState(String, Variant). 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).

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

Additionally, DBusConnection.exportActionGroup(String, ActionGroup) will check if the exported ActionGroup implements GRemoteActionGroup 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.

Since:

2.32

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	RemoteActionGroup.RemoteActionGroup$Impl	The RemoteActionGroup$Impl type represents a native instance of the RemoteActionGroup interface.
static class	RemoteActionGroup.RemoteActionGroupInterface	The virtual function table for GRemoteActionGroup.

Nested classes/interfaces inherited from interface ActionGroup

ActionGroup.ActionAddedCallback, ActionGroup.ActionEnabledChangedCallback, ActionGroup.ActionGroup$Impl, ActionGroup.ActionGroupInterface, ActionGroup.ActionRemovedCallback, ActionGroup.ActionStateChangedCallback

Method Summary

Modifier and Type	Method	Description
default void	activateActionFull(String actionName, @Nullable Variant parameter, Variant platformData)	Activates the remote action.
default void	changeActionStateFull(String actionName, Variant value, Variant platformData)	Changes the state of a remote action.
static @Nullable Type	getType()	Get the GType of the RemoteActionGroup class.

Methods inherited from interface ActionGroup

actionAdded, actionEnabledChanged, actionRemoved, actionStateChanged, activateAction, changeActionState, emitActionAdded, emitActionEnabledChanged, emitActionRemoved, emitActionStateChanged, getActionEnabled, getActionParameterType, getActionState, getActionStateHint, getActionStateType, hasAction, listActions, onActionAdded, onActionEnabledChanged, onActionRemoved, onActionStateChanged, queryAction

Methods inherited from interface Proxy

handle

Method Details

getType

static @Nullable Type getType()

Get the GType of the RemoteActionGroup class.

Returns:

the GType

activateActionFull

default void activateActionFull(String actionName,
 @Nullable Variant parameter,
 Variant platformData)

Activates the remote action.

This is the same as g_action_group_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.

platformData must be non-null and must have the type G_VARIANT_TYPE_VARDICT. If it is floating, it will be consumed.

Parameters:

actionName - the name of the action to activate

parameter - the optional parameter to the activation

platformData - the platform data to send

Since:

2.32

changeActionStateFull

default void changeActionStateFull(String actionName,
 Variant value,
 Variant platformData)

Changes the state of a remote action.

This is the same as g_action_group_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.

platformData must be non-null and must have the type G_VARIANT_TYPE_VARDICT. If it is floating, it will be consumed.

Parameters:

actionName - the name of the action to change the state of

value - the new requested value for the state

platformData - the platform data to send

Since:

2.32