GI.NM.Objects.VpnServicePlugin

No description available in the introspection data.

Since: 1.2

Exported types

newtype VpnServicePlugin

Memory-managed wrapper type.

Constructors

VpnServicePlugin (ManagedPtr VpnServicePlugin)

Instances

Eq VpnServicePlugin

Defined in GI.NM.Objects.VpnServicePlugin

Methods

(==) :: VpnServicePlugin -> VpnServicePlugin -> Bool

(/=) :: VpnServicePlugin -> VpnServicePlugin -> Bool

GObject VpnServicePlugin

Defined in GI.NM.Objects.VpnServicePlugin

ManagedPtrNewtype VpnServicePlugin

Defined in GI.NM.Objects.VpnServicePlugin

Methods

toManagedPtr :: VpnServicePlugin -> ManagedPtr VpnServicePlugin

TypedObject VpnServicePlugin

Defined in GI.NM.Objects.VpnServicePlugin

Methods

glibType :: IO GType

HasParentTypes VpnServicePlugin

Defined in GI.NM.Objects.VpnServicePlugin

IsGValue (Maybe VpnServicePlugin)

Convert VpnServicePlugin to and from GValue. See toGValue and fromGValue.

Defined in GI.NM.Objects.VpnServicePlugin

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe VpnServicePlugin -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe VpnServicePlugin)

type ParentTypes VpnServicePlugin

Defined in GI.NM.Objects.VpnServicePlugin

type ParentTypes VpnServicePlugin = '[Object, Initable]

class (GObject o, IsDescendantOf VpnServicePlugin o) => IsVpnServicePlugin o

Type class for types which can be safely cast to VpnServicePlugin, for instance with toVpnServicePlugin.

Instances

(GObject o, IsDescendantOf VpnServicePlugin o) => IsVpnServicePlugin o

Defined in GI.NM.Objects.VpnServicePlugin

toVpnServicePlugin :: (MonadIO m, IsVpnServicePlugin o) => o -> m VpnServicePlugin

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

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, disconnect, failure, forceFloating, freezeNotify, getv, init, isFloating, notify, notifyByPspec, ref, refSink, runDispose, secretsRequired, shutdown, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getConnection, getData, getProperty, getQdata.

Setters

setConfig, setData, setDataFull, setIp4Config, setIp6Config, setLoginBanner, setProperty.

disconnect

vpnServicePluginDisconnect

Arguments

:: (HasCallStack, MonadIO m, IsVpnServicePlugin a)

=> a

-> m ()

(Can throw GError)

No description available in the introspection data.

Since: 1.2

failure

vpnServicePluginFailure :: (HasCallStack, MonadIO m, IsVpnServicePlugin a) => a -> VpnPluginFailure -> m ()

No description available in the introspection data.

Since: 1.2

getConnection

vpnServicePluginGetConnection :: (HasCallStack, MonadIO m, IsVpnServicePlugin a) => a -> m DBusConnection

No description available in the introspection data.

Since: 1.2

getSecretFlags

vpnServicePluginGetSecretFlags

Arguments

:: (HasCallStack, MonadIO m)

=> Map (Ptr ()) (Ptr ())

data: hash table containing VPN key/value pair data items

-> Text

secretName: VPN secret key name for which to retrieve flags for

-> m (Bool, [SettingSecretFlags])

Returns: True if the flag data item was found and successfully converted to flags, False if not

Given a VPN secret key name, attempts to find the corresponding flags data item in data. If found, converts the flags data item to SettingSecretFlags and returns it.

Since: 1.2

readVpnDetails

vpnServicePluginReadVpnDetails

Arguments

:: (HasCallStack, MonadIO m)

=> Int32

fd: file descriptor to read from, usually stdin (0)

-> m (Bool, Map (Ptr ()) (Ptr ()), Map (Ptr ()) (Ptr ()))

Returns: True if reading values was successful, False if not

Parses key/value pairs from a file descriptor (normally stdin) passed by an applet when the applet calls the authentication dialog of the VPN plugin.

Since: 1.2

secretsRequired

vpnServicePluginSecretsRequired

Arguments

:: (HasCallStack, MonadIO m, IsVpnServicePlugin a)

=> a

plugin: the VpnServicePlugin

-> Text

message: an information message about why secrets are required, if any

-> Text

hints: VPN specific secret names for required new secrets

-> m ()

Called by VPN plugin implementations to signal to NetworkManager that secrets are required during the connection process. This signal may be used to request new secrets when the secrets originally provided by NetworkManager are insufficient, or the VPN process indicates that it needs additional information to complete the request.

Since: 1.2

setConfig

vpnServicePluginSetConfig :: (HasCallStack, MonadIO m, IsVpnServicePlugin a) => a -> GVariant -> m ()

No description available in the introspection data.

Since: 1.2

setIp4Config

vpnServicePluginSetIp4Config :: (HasCallStack, MonadIO m, IsVpnServicePlugin a) => a -> GVariant -> m ()

No description available in the introspection data.

Since: 1.2

setIp6Config

vpnServicePluginSetIp6Config :: (HasCallStack, MonadIO m, IsVpnServicePlugin a) => a -> GVariant -> m ()

No description available in the introspection data.

Since: 1.2

setLoginBanner

vpnServicePluginSetLoginBanner :: (HasCallStack, MonadIO m, IsVpnServicePlugin a) => a -> Text -> m ()

No description available in the introspection data.

Since: 1.2

shutdown

vpnServicePluginShutdown

Arguments

:: (HasCallStack, MonadIO m, IsVpnServicePlugin a)

=> a

plugin: the VpnServicePlugin instance

-> m ()

Shutdown the plugin and disconnect from D-Bus. After this, the plugin instance is dead and should no longer be used. It ensures to get no more requests from D-Bus. In principle, you don't need to shutdown the plugin, disposing the instance has the same effect. However, this gives a way to deactivate the plugin before giving up the last reference.

Since: 1.12

Properties

serviceName

The D-Bus service name of this plugin.

Since: 1.2

constructVpnServicePluginServiceName :: (IsVpnServicePlugin o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “service-name” property. This is rarely needed directly, but it is used by new.

getVpnServicePluginServiceName :: (MonadIO m, IsVpnServicePlugin o) => o -> m (Maybe Text)

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

get vpnServicePlugin #serviceName

state

The state of the plugin.

Since: 1.2

constructVpnServicePluginState :: (IsVpnServicePlugin o, MonadIO m) => VpnServiceState -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “state” property. This is rarely needed directly, but it is used by new.

getVpnServicePluginState :: (MonadIO m, IsVpnServicePlugin o) => o -> m VpnServiceState

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

get vpnServicePlugin #state

setVpnServicePluginState :: (MonadIO m, IsVpnServicePlugin o) => o -> VpnServiceState -> m ()

Set the value of the “state” property. When overloading is enabled, this is equivalent to

set vpnServicePlugin [ #state := value ]

watchPeer

Whether to watch for D-Bus peer's changes.

Since: 1.2

constructVpnServicePluginWatchPeer :: (IsVpnServicePlugin o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “watch-peer” property. This is rarely needed directly, but it is used by new.

getVpnServicePluginWatchPeer :: (MonadIO m, IsVpnServicePlugin o) => o -> m Bool

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

get vpnServicePlugin #watchPeer

Signals

config

type VpnServicePluginConfigCallback = GVariant -> IO ()

No description available in the introspection data.

afterVpnServicePluginConfig :: (IsVpnServicePlugin a, MonadIO m) => a -> ((?self :: a) => VpnServicePluginConfigCallback) -> m SignalHandlerId

Connect a signal handler for the config signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after vpnServicePlugin #config callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onVpnServicePluginConfig :: (IsVpnServicePlugin a, MonadIO m) => a -> ((?self :: a) => VpnServicePluginConfigCallback) -> m SignalHandlerId

Connect a signal handler for the config signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on vpnServicePlugin #config callback

failure

type VpnServicePluginFailureCallback = Word32 -> IO ()

No description available in the introspection data.

afterVpnServicePluginFailure :: (IsVpnServicePlugin a, MonadIO m) => a -> ((?self :: a) => VpnServicePluginFailureCallback) -> m SignalHandlerId

Connect a signal handler for the failure signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after vpnServicePlugin #failure callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onVpnServicePluginFailure :: (IsVpnServicePlugin a, MonadIO m) => a -> ((?self :: a) => VpnServicePluginFailureCallback) -> m SignalHandlerId

Connect a signal handler for the failure signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on vpnServicePlugin #failure callback

ip4Config

type VpnServicePluginIp4ConfigCallback = GVariant -> IO ()

No description available in the introspection data.

afterVpnServicePluginIp4Config :: (IsVpnServicePlugin a, MonadIO m) => a -> ((?self :: a) => VpnServicePluginIp4ConfigCallback) -> m SignalHandlerId

Connect a signal handler for the ip4Config signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after vpnServicePlugin #ip4Config callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onVpnServicePluginIp4Config :: (IsVpnServicePlugin a, MonadIO m) => a -> ((?self :: a) => VpnServicePluginIp4ConfigCallback) -> m SignalHandlerId

Connect a signal handler for the ip4Config signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on vpnServicePlugin #ip4Config callback

ip6Config

type VpnServicePluginIp6ConfigCallback = GVariant -> IO ()

No description available in the introspection data.

afterVpnServicePluginIp6Config :: (IsVpnServicePlugin a, MonadIO m) => a -> ((?self :: a) => VpnServicePluginIp6ConfigCallback) -> m SignalHandlerId

Connect a signal handler for the ip6Config signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after vpnServicePlugin #ip6Config callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onVpnServicePluginIp6Config :: (IsVpnServicePlugin a, MonadIO m) => a -> ((?self :: a) => VpnServicePluginIp6ConfigCallback) -> m SignalHandlerId

Connect a signal handler for the ip6Config signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on vpnServicePlugin #ip6Config callback

loginBanner

type VpnServicePluginLoginBannerCallback = Text -> IO ()

No description available in the introspection data.

afterVpnServicePluginLoginBanner :: (IsVpnServicePlugin a, MonadIO m) => a -> ((?self :: a) => VpnServicePluginLoginBannerCallback) -> m SignalHandlerId

Connect a signal handler for the loginBanner signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after vpnServicePlugin #loginBanner callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onVpnServicePluginLoginBanner :: (IsVpnServicePlugin a, MonadIO m) => a -> ((?self :: a) => VpnServicePluginLoginBannerCallback) -> m SignalHandlerId

Connect a signal handler for the loginBanner signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on vpnServicePlugin #loginBanner callback

quit

type VpnServicePluginQuitCallback = IO ()

No description available in the introspection data.

afterVpnServicePluginQuit :: (IsVpnServicePlugin a, MonadIO m) => a -> ((?self :: a) => VpnServicePluginQuitCallback) -> m SignalHandlerId

Connect a signal handler for the quit signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after vpnServicePlugin #quit callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onVpnServicePluginQuit :: (IsVpnServicePlugin a, MonadIO m) => a -> ((?self :: a) => VpnServicePluginQuitCallback) -> m SignalHandlerId

Connect a signal handler for the quit signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on vpnServicePlugin #quit callback

secretsRequired

type VpnServicePluginSecretsRequiredCallback = Text -> [Text] -> IO ()

No description available in the introspection data.

afterVpnServicePluginSecretsRequired :: (IsVpnServicePlugin a, MonadIO m) => a -> ((?self :: a) => VpnServicePluginSecretsRequiredCallback) -> m SignalHandlerId

Connect a signal handler for the secretsRequired signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after vpnServicePlugin #secretsRequired callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onVpnServicePluginSecretsRequired :: (IsVpnServicePlugin a, MonadIO m) => a -> ((?self :: a) => VpnServicePluginSecretsRequiredCallback) -> m SignalHandlerId

Connect a signal handler for the secretsRequired signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on vpnServicePlugin #secretsRequired callback

stateChanged

type VpnServicePluginStateChangedCallback = Word32 -> IO ()

No description available in the introspection data.

afterVpnServicePluginStateChanged :: (IsVpnServicePlugin a, MonadIO m) => a -> ((?self :: a) => VpnServicePluginStateChangedCallback) -> m SignalHandlerId

Connect a signal handler for the stateChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after vpnServicePlugin #stateChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onVpnServicePluginStateChanged :: (IsVpnServicePlugin a, MonadIO m) => a -> ((?self :: a) => VpnServicePluginStateChangedCallback) -> m SignalHandlerId

Connect a signal handler for the stateChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on vpnServicePlugin #stateChanged callback