RemoteActionGroup

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.

Since

2.32

Inheritors

Types

Link copied to clipboard
object Companion
Link copied to clipboard
class RemoteActionGroupImpl(gioRemoteActionGroupPointer: <Error class: unknown class><<Error class: unknown class>>) : RemoteActionGroup

The RemoteActionGroupImpl type represents a native instance of the RemoteActionGroup interface.

Properties

Link copied to clipboard
open override val gioActionGroupPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
abstract val gioProxyPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
abstract val gioRemoteActionGroupPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

Link copied to clipboard
open fun actionAdded(actionName: String)

Emits the signal@Gio.ActionGroup::action-added signal on @action_group.

Link copied to clipboard
open fun actionEnabledChanged(actionName: String, enabled: Boolean)

Emits the signal@Gio.ActionGroup::action-enabled-changed signal on @action_group.

Link copied to clipboard
open fun actionRemoved(actionName: String)

Emits the signal@Gio.ActionGroup::action-removed signal on @action_group.

Link copied to clipboard
open fun actionStateChanged(actionName: String, state: <Error class: unknown class>)

Emits the signal@Gio.ActionGroup::action-state-changed signal on @action_group.

Link copied to clipboard
open fun activateAction(actionName: String, parameter: <Error class: unknown class>? = null)

Activate the named action within @action_group.

Link copied to clipboard
open fun activateActionFull(actionName: String, parameter: <Error class: unknown class>? = null, platformData: <Error class: unknown class>)

Activates the remote action.

Link copied to clipboard
open fun changeActionState(actionName: String, value: <Error class: unknown class>)

Request for the state of the named action within @action_group to be changed to @value.

Link copied to clipboard
open fun changeActionStateFull(actionName: String, value: <Error class: unknown class>, platformData: <Error class: unknown class>)

Changes the state of a remote action.

Link copied to clipboard
open fun connect(connection: IoStream, proxyAddress: ProxyAddress, cancellable: Cancellable? = null): <Error class: unknown class><IoStream>

Given @connection to communicate with a proxy (eg, a #GSocketConnection that is connected to the proxy server), this does the necessary handshake to connect to @proxy_address, and if required, wraps the #GIOStream to handle proxy payload.

Link copied to clipboard
open fun connectAsync(connection: IoStream, proxyAddress: ProxyAddress, cancellable: Cancellable? = null, callback: AsyncReadyCallback?)

Asynchronous version of g_proxy_connect().

Link copied to clipboard
open fun connectFinish(result: AsyncResult): <Error class: unknown class><IoStream>

See g_proxy_connect().

Link copied to clipboard
open fun getActionEnabled(actionName: String): Boolean

Checks if the named action within @action_group is currently enabled.

Link copied to clipboard
open fun getActionParameterType(actionName: String): <Error class: unknown class>?

Queries the type of the parameter that must be given when activating the named action within @action_group.

Link copied to clipboard
open fun getActionState(actionName: String): <Error class: unknown class>?

Queries the current state of the named action within @action_group.

Link copied to clipboard
open fun getActionStateHint(actionName: String): <Error class: unknown class>?

Requests a hint about the valid range of values for the state of the named action within @action_group.

Link copied to clipboard
open fun getActionStateType(actionName: String): <Error class: unknown class>?

Queries the type of the state of the named action within

Link copied to clipboard
open fun hasAction(actionName: String): Boolean

Checks if the named action exists within @action_group.

Link copied to clipboard
open fun listActions(): List<String>

Lists the actions contained within @action_group.

Link copied to clipboard
open fun onActionAdded(    connectFlags: <Error class: unknown class> = ConnectFlags(0u),     detail: String? = null,     handler: (actionName: String) -> Unit): <Error class: unknown class>

Signals that a new action was just added to the group.

Link copied to clipboard
open fun onActionEnabledChanged(    connectFlags: <Error class: unknown class> = ConnectFlags(0u),     detail: String? = null,     handler: (actionName: String, enabled: Boolean) -> Unit): <Error class: unknown class>

Signals that the enabled status of the named action has changed.

Link copied to clipboard
open fun onActionRemoved(    connectFlags: <Error class: unknown class> = ConnectFlags(0u),     detail: String? = null,     handler: (actionName: String) -> Unit): <Error class: unknown class>

Signals that an action is just about to be removed from the group.

Link copied to clipboard
open fun onActionStateChanged(    connectFlags: <Error class: unknown class> = ConnectFlags(0u),     detail: String? = null,     handler: (actionName: String, <Error class: unknown class>) -> Unit): <Error class: unknown class>

Signals that the state of the named action has changed.

Link copied to clipboard

Some proxy protocols expect to be passed a hostname, which they will resolve to an IP address themselves. Others, like SOCKS4, do not allow this. This function will return false if @proxy is implementing such a protocol. When false is returned, the caller should resolve the destination hostname first, and then pass a #GProxyAddress containing the stringified IP address to g_proxy_connect() or g_proxy_connect_async().