Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: RemoteActionGroup

[26:7] extends: object

The GRemoteActionGroup interface is implemented by [iface@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 [iface@Gio.ActionGroup] used to activate actions: [method@Gio.ActionGroup.activate_action] and [method@Gio.ActionGroup.change_action_state]. These variants allow a ‘platform data’ [struct@GLib.Variant] to be specified: a dictionary providing context for the action invocation (for example: timestamps, startup notification IDs, etc). [class@Gio.DBusActionGroup] implements GRemoteActionGroup. This provides a mechanism to send platform data for action invocations over D-Bus. Additionally, [method@Gio.DBusConnection.export_action_group] will check if the exported [iface@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.

Members

  • handleObj
  • lib
  • retainedCallbacks
  • signalHandlerNames
  • signalSetterHandlers

Methods

  • RemoteActionGroup (Handle = null)

    Creates a new RemoteActionGroup by wrapping a native handle or another wrapper.

    • @p Handle is the native handle or another wrapper whose handle to adopt.
  • toNativeHandle (Source)

    Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

    • @p Source is the raw handle, raw buffer, wrapper, or null.
    • @r A raw pointer carrier or null when no pointer is present.
  • getLib ()

    Returns the opened native library for this generated wrapper.

    • @r The opened native library.
  • handle ()

    Returns the wrapped NativeHandle.

    • @r The wrapped NativeHandle.
  • isNull ()

    Returns true when the wrapped handle is null.

    • @r A bool.
  • describe ()

    Returns a small string for debugging generated wrappers.

    • @r A string.
  • activate_action_full (string action_name, object parameter, object platform_data)

    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. @platform_data must be non-%NULL and must have the type %G_VARIANT_TYPE_VARDICT. If it is floating, it will be consumed.

    • @p action_name is the name of the action to activate.
    • @p parameter is the optional parameter to the activation.
    • @p platform_data is the platform data to send.
    • @r None.
  • change_action_state_full (string action_name, object value, object platform_data)

    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. @platform_data must be non-%NULL and must have the type %G_VARIANT_TYPE_VARDICT. If it is floating, it will be consumed.

    • @p action_name is the name of the action to change the state of.
    • @p value is the new requested value for the state.
    • @p platform_data is the platform data to send.
    • @r None.