Class

ValentDevicePlugin

since: 1.0

Description [src] 

abstract class Valent.DevicePlugin : Valent.Object {
  parent_instance: ValentObject
}

An abstract base class for device plugins.

ValentDevicePlugin is a base class for plugins that operate in the scope of a single device. This usually means communicating with other devices, however plugins aren’t required to be packet based and may offer connectionless functionality.

Plugin Requirements

Device plugins essentially have two sets of dependent conditions for being enabled. Plugins become available (i.e. can be enabled) when any of the following are true:

  • any of the device’s outgoing capabilities match any of the plugin’s incoming capabilities
  • any of the device’s incoming capabilities match any of the plugin’s outgoing capabilities
  • the plugin doesn’t list any capabilities (eg. a non-packet based plugin)

When a plugin becomes available it may be enabled, disabled and configured.

Plugin Actions

ValentDevicePlugin implements the GActionGroup and GActionMap interfaces, providing a simple way for plugins to expose functions and states. Each GAction added to the action map will be included in the device action group with the plugin’s module name as a prefix (eg. share.uri).

If the ValentDeviceManager is exported on D-Bus, the actions will be exported along with the ValentDevice.

Implementation Notes

Implementations that define X-DevicePluginIncoming in the .plugin file must override Valent.DevicePluginClass.handle_packet to handle incoming packets. Implementations that depend on the device state, especially those that define X-DevicePluginOutgoing in the .plugin file, should override Valent.DevicePluginClass.update_state.

For device plugin preferences see ValentDevicePreferencesPage.

.plugin File

Implementations may define the following extra fields in the .plugin file:

  • X-DevicePluginIncoming

    A list of packet types (eg. kdeconnect.ping) separated by semi-colons indicating the packets that the plugin can handle.

  • X-DevicePluginOutgoing

    A list of packet types (eg. kdeconnect.share.request) separated by semi-colons indicating the packets that the plugin may send.

  • X-DevicePluginSettings

    A GSettings schema ID for the plugin’s settings. See valent_context_get_plugin_settings() for more information.

Available since: 1.0

Hierarchy

hierarchy this ValentDevicePlugin implements_0 GActionGroup this--implements_0 implements_1 GActionMap this--implements_1 ancestor_0 ValentObject ancestor_0--this ancestor_1 GObject ancestor_1--ancestor_0

Ancestors

Implements

Instance methods

valent_device_plugin_add_menu_entries

A convenience function for creating multiple GMenuItem instances and adding them to the device GMenuModel. Each item is constructed as per one ValentMenuEntry.

since: 1.0

valent_device_plugin_disable

Disable the plugin.

since: 1.0

valent_device_plugin_enable

Enable the plugin.

since: 1.0

valent_device_plugin_get_context

Get the settings for this plugin.

since: 1.0

valent_device_plugin_get_device

Get the device this plugin is bound to.

since: 1.0

valent_device_plugin_get_settings

Get the settings for this plugin.

since: 1.0

valent_device_plugin_handle_packet

Handle a packet from the device the plugin is bound to.

since: 1.0

valent_device_plugin_hide_notification

A convenience for withdrawing a notification.

since: 1.0

valent_device_plugin_queue_packet

Queue a KDE Connect packet to be sent to the device this plugin is bound to.

since: 1.0

valent_device_plugin_remove_menu_entries

A counterpart to valent_device_plugin_add_menu_entries().

since: 1.0

valent_device_plugin_replace_menu_item

Replace an item in the top-level of the device GMenuModel with item.

since: 1.0

valent_device_plugin_show_notification

A convenience for showing a local notification.

since: 1.0

valent_device_plugin_toggle_actions

Enable or disable all actions.

since: 1.0

valent_device_plugin_update_state

Update the plugin based on the new state of the device.

since: 1.0

Methods inherited from ValentObject (9)
valent_object_attach_cancellable

Attach the object’s cancellable another cancellable.

since: 1.0

valent_object_chain_cancellable

Chain a cancellable to the object’s cancellable.

since: 1.0

valent_object_destroy

Destroy the object.

since: 1.0

valent_object_in_destruction

Get whether the object is destroyed or in destruction.

since: 1.0

valent_object_lock

Acquire a lock on object.

since: 1.0

valent_object_notify

Emit GObject::notify on object, on the main thread.

since: 1.0

valent_object_notify_by_pspec

Emit GObject::notify on object, on the main thread.

since: 1.0

valent_object_ref_cancellable

Get a GCancellable for the object.

since: 1.0

valent_object_unlock

Release a lock on object.

since: 1.0

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GActionGroup (14)
g_action_group_action_added

Emits the GActionGroup::action-added signal on action_group.

unstable since: 2.28

g_action_group_action_enabled_changed

Emits the GActionGroup::action-enabled-changed signal on action_group.

unstable since: 2.28

g_action_group_action_removed

Emits the GActionGroup::action-removed signal on action_group.

unstable since: 2.28

g_action_group_action_state_changed

Emits the GActionGroup::action-state-changed signal on action_group.

unstable since: 2.28

g_action_group_activate_action

Activate the named action within action_group.

unstable since: 2.28

g_action_group_change_action_state

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

unstable since: 2.28

g_action_group_get_action_enabled

Checks if the named action within action_group is currently enabled.

unstable since: 2.28

g_action_group_get_action_parameter_type

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

unstable since: 2.28

g_action_group_get_action_state

Queries the current state of the named action within action_group.

unstable since: 2.28

g_action_group_get_action_state_hint

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

unstable since: 2.28

g_action_group_get_action_state_type

Queries the type of the state of the named action within action_group.

unstable since: 2.28

g_action_group_has_action

Checks if the named action exists within action_group.

unstable since: 2.28

g_action_group_list_actions

Lists the actions contained within action_group.

unstable since: 2.28

g_action_group_query_action

Queries all aspects of the named action within an action_group.

unstable since: 2.32

Methods inherited from GActionMap (4)
g_action_map_add_action

Adds an action to the action_map.

unstable since: 2.32

g_action_map_add_action_entries

A convenience function for creating multiple GSimpleAction instances and adding them to a GActionMap.

unstable since: 2.32

g_action_map_lookup_action

Looks up the action with the name action_name in action_map.

unstable since: 2.32

g_action_map_remove_action

Removes the named action from the action map.

unstable since: 2.32

Properties

Valent.DevicePlugin:context

The ValentDevice this plugin is bound to.

since: 1.0

Valent.DevicePlugin:device

The ValentDevice this plugin is bound to.

since: 1.0

Valent.DevicePlugin:plugin-info

The PeasPluginInfo describing this plugin.

since: 1.0

Valent.DevicePlugin:settings

The GSettings for this plugin.

since: 1.0

Properties inherited from ValentObject (1)
Valent.Object:cancellable

The object GCancellable.

since: 1.0

Signals

Signals inherited from ValentObject (1)
ValentObject::destroy

Emitted when the object is being destroyed.

since: 1.0

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Signals inherited from GActionGroup (4)
GActionGroup::action-added

Signals that a new action was just added to the group. This signal is emitted after the action has been added and is now visible.

unstable since: 2.28

GActionGroup::action-enabled-changed

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

unstable since: 2.28

GActionGroup::action-removed

Signals that an action is just about to be removed from the group. This signal is emitted before the action is removed, so the action is still visible and can be queried from the signal handler.

unstable since: 2.28

GActionGroup::action-state-changed

Signals that the state of the named action has changed.

unstable since: 2.28

Class structure 

struct ValentDevicePluginClass {
  ValentObjectClass parent_class;
  void (* disable) (
    ValentDevicePlugin* plugin
  );
  void (* enable) (
    ValentDevicePlugin* plugin
  );
  void (* handle_packet) (
    ValentDevicePlugin* plugin,
    const char* type,
    JsonNode* packet
  );
  void (* update_state) (
    ValentDevicePlugin* plugin,
    ValentDeviceState state
  );
  
}

The virtual function table for ValentDevicePlugin.

Class members
parent_class: ValentObjectClass
No description available.
disable: void (* disable) ( ValentDevicePlugin* plugin )
No description available.
enable: void (* enable) ( ValentDevicePlugin* plugin )
No description available.
handle_packet: void (* handle_packet) ( ValentDevicePlugin* plugin, const char* type, JsonNode* packet )
No description available.
update_state: void (* update_state) ( ValentDevicePlugin* plugin, ValentDeviceState state )
No description available.

Virtual methods

Valent.DevicePluginClass.disable

Disable the plugin.

since: 1.0

Valent.DevicePluginClass.enable

Enable the plugin.

since: 1.0

Valent.DevicePluginClass.handle_packet

Handle a packet from the device the plugin is bound to.

since: 1.0

Valent.DevicePluginClass.update_state

Update the plugin based on the new state of the device.

since: 1.0