:right-sidebar: True

RemoteActionGroup
===================================================================

.. currentmodule:: gi.repository.Gio


.. versionadded:: 2.32




.. class:: RemoteActionGroup(*args, **kwargs)
   :no-contents-entry:





Implementations: :class:`~gi.repository.Gio.DBusActionGroup`


The ``GRemoteActionGroup`` interface is implemented by :obj:`~gi.repository.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 :obj:`~gi.repository.Gio.ActionGroup` used to activate actions:
:obj:`~gi.repository.Gio.ActionGroup.activate_action` and
:obj:`~gi.repository.Gio.ActionGroup.change_action_state`\. These variants allow a
‘platform data’ :obj:`~gi.repository.GLib.Variant` to be specified: a dictionary providing
context for the action invocation (for example: timestamps, startup
notification IDs, etc).

:obj:`~gi.repository.Gio.DBusActionGroup` implements ``GRemoteActionGroup``\.  This provides a
mechanism to send platform data for action invocations over D-Bus.

Additionally, :obj:`~gi.repository.Gio.DBusConnection.export_action_group` will check if
the exported :obj:`~gi.repository.Gio.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.




Methods
-------

.. rst-class:: interim-class

.. class:: RemoteActionGroup
   :no-index:


   .. method:: activate_action_full(action_name: str, parameter: ~gi.repository.GLib.Variant | None, platform_data: ~gi.repository.GLib.Variant) -> None

      Activates the remote action.

      This is the same as :func:`~gi.repository.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-:const:`None` and must have the type
      %G_VARIANT_TYPE_VARDICT.  If it is floating, it will be consumed.


      .. versionadded:: 2.32





      :param action_name: the name of the action to activate

      :param parameter: the optional parameter to the activation

      :param platform_data: the platform data to send




   .. method:: change_action_state_full(action_name: str, value: ~gi.repository.GLib.Variant, platform_data: ~gi.repository.GLib.Variant) -> None

      Changes the state of a remote action.

      This is the same as :func:`~gi.repository.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-:const:`None` and must have the type
      %G_VARIANT_TYPE_VARDICT.  If it is floating, it will be consumed.


      .. versionadded:: 2.32





      :param action_name: the name of the action to change the state of

      :param value: the new requested value for the state

      :param platform_data: the platform data to send












Virtual Methods
---------------

.. rst-class:: interim-class

.. class:: RemoteActionGroup
   :no-index:
   

   .. method:: do_activate_action_full(action_name: str, parameter: ~gi.repository.GLib.Variant | None, platform_data: ~gi.repository.GLib.Variant) -> None

      Activates the remote action.

      This is the same as :func:`~gi.repository.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-:const:`None` and must have the type
      %G_VARIANT_TYPE_VARDICT.  If it is floating, it will be consumed.


      .. versionadded:: 2.32





      :param action_name: the name of the action to activate

      :param parameter: the optional parameter to the activation

      :param platform_data: the platform data to send




   .. method:: do_change_action_state_full(action_name: str, value: ~gi.repository.GLib.Variant, platform_data: ~gi.repository.GLib.Variant) -> None

      Changes the state of a remote action.

      This is the same as :func:`~gi.repository.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-:const:`None` and must have the type
      %G_VARIANT_TYPE_VARDICT.  If it is floating, it will be consumed.


      .. versionadded:: 2.32





      :param action_name: the name of the action to change the state of

      :param value: the new requested value for the state

      :param platform_data: the platform data to send