gi-nm-1.0.1: NM bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.NM.Interfaces.VpnEditorPlugin

Description

No description available in the introspection data.

Synopsis

Exported types

class (GObject o, IsDescendantOf VpnEditorPlugin o) => IsVpnEditorPlugin o Source #

Type class for types which can be safely cast to VpnEditorPlugin, for instance with toVpnEditorPlugin.

Instances

Instances details
(GObject o, IsDescendantOf VpnEditorPlugin o) => IsVpnEditorPlugin o Source # 
Instance details

Defined in GI.NM.Interfaces.VpnEditorPlugin

toVpnEditorPlugin :: (MonadIO m, IsVpnEditorPlugin o) => o -> m VpnEditorPlugin Source #

Cast to VpnEditorPlugin, for types for which this is known to be safe. For general casts, use castTo.

Methods

export

vpnEditorPluginExport Source #

Arguments

:: (HasCallStack, MonadIO m, IsVpnEditorPlugin a, IsConnection b) 
=> a 
-> Text 
-> b 
-> m ()

(Can throw GError)

No description available in the introspection data.

getCapabilities

vpnEditorPluginGetCapabilities :: (HasCallStack, MonadIO m, IsVpnEditorPlugin a) => a -> m [VpnEditorPluginCapability] Source #

No description available in the introspection data.

getEditor

vpnEditorPluginGetEditor Source #

Arguments

:: (HasCallStack, MonadIO m, IsVpnEditorPlugin a, IsConnection b) 
=> a

plugin: the VpnEditorPlugin

-> b

connection: the Connection to be edited

-> m VpnEditor

Returns: a new VpnEditor or Nothing on error (Can throw GError)

No description available in the introspection data.

getPluginInfo

vpnEditorPluginGetPluginInfo Source #

Arguments

:: (HasCallStack, MonadIO m, IsVpnEditorPlugin a) 
=> a

plugin: the VpnEditorPlugin instance

-> m VpnPluginInfo

Returns: if set, return the VpnPluginInfo instance.

No description available in the introspection data.

Since: 1.4

getSuggestedFilename

vpnEditorPluginGetSuggestedFilename :: (HasCallStack, MonadIO m, IsVpnEditorPlugin a, IsConnection b) => a -> b -> m Text Source #

No description available in the introspection data.

import

vpnEditorPluginImport Source #

Arguments

:: (HasCallStack, MonadIO m, IsVpnEditorPlugin a) 
=> a

plugin: the VpnEditorPlugin

-> Text

path: full path to the file to attempt to read into a new Connection

-> m Connection

Returns: a new Connection imported from path, or Nothing on error or if the file at path was not recognized by this plugin (Can throw GError)

No description available in the introspection data.

load

vpnEditorPluginLoad Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Text

pluginName: The name of the shared library to load. This path will be directly passed to dlopen() without further checks.

-> Text

checkService: if not-null, check that the loaded plugin advertises the given service.

-> m VpnEditorPlugin

Returns: a new plugin instance or Nothing on error. (Can throw GError)

Load the shared library pluginName and create a new VpnEditorPlugin instance via the NMVpnEditorPluginFactory function.

This is similar to vpnEditorPluginLoadFromFile, but it does no validation of the plugin name, instead passes it directly to dlopen(). If you have the full path to a plugin file, vpnEditorPluginLoadFromFile is preferred.

Since: 1.4

loadFromFile

vpnEditorPluginLoadFromFile Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Text

pluginName: The path or name of the shared library to load. The path must either be an absolute filename to an existing file. Alternatively, it can be the name (without path) of a library in the plugin directory of NetworkManager.

-> Text

checkService: if not-null, check that the loaded plugin advertises the given service.

-> Int32

checkOwner: if non-negative, check whether the file is owned by UID checkOwner or by root. In this case also check that the file is not writable by anybody else.

-> FunPtr C_UtilsCheckFilePredicate

checkFile: optional callback to validate the file prior to loading the shared library.

-> m VpnEditorPlugin

Returns: a new plugin instance or Nothing on error. (Can throw GError)

Load the shared library pluginName and create a new VpnEditorPlugin instance via the NMVpnEditorPluginFactory function.

If pluginName is not an absolute path name, it assumes the file is in the plugin directory of NetworkManager. In any case, the call will do certain checks on the file before passing it to dlopen. A consequence for that is, that you cannot omit the ".so" suffix as you could for vpnEditorPluginLoad.

Since: 1.2

setPluginInfo

vpnEditorPluginSetPluginInfo Source #

Arguments

:: (HasCallStack, MonadIO m, IsVpnEditorPlugin a, IsVpnPluginInfo b) 
=> a

plugin: the VpnEditorPlugin instance

-> Maybe b

pluginInfo: a VpnPluginInfo instance or Nothing

-> m () 

Set or clear the plugin-info instance. This takes a weak reference on pluginInfo, to avoid circular reference as the plugin-info might also reference the editor-plugin.

Since: 1.4

Properties

description

Longer description of the VPN plugin.

getVpnEditorPluginDescription :: (MonadIO m, IsVpnEditorPlugin o) => o -> m (Maybe Text) Source #

Get the value of the “description” property. When overloading is enabled, this is equivalent to

get vpnEditorPlugin #description

name

Short display name of the VPN plugin.

getVpnEditorPluginName :: (MonadIO m, IsVpnEditorPlugin o) => o -> m (Maybe Text) Source #

Get the value of the “name” property. When overloading is enabled, this is equivalent to

get vpnEditorPlugin #name

service

D-Bus service name of the plugin's VPN service.

getVpnEditorPluginService :: (MonadIO m, IsVpnEditorPlugin o) => o -> m (Maybe Text) Source #

Get the value of the “service” property. When overloading is enabled, this is equivalent to

get vpnEditorPlugin #service