GI.NM.Objects.RemoteConnection

No description available in the introspection data.

Exported types

newtype RemoteConnection

Memory-managed wrapper type.

Constructors

RemoteConnection (ManagedPtr RemoteConnection)

Instances

Eq RemoteConnection

Defined in GI.NM.Objects.RemoteConnection

Methods

(==) :: RemoteConnection -> RemoteConnection -> Bool

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

GObject RemoteConnection

Defined in GI.NM.Objects.RemoteConnection

ManagedPtrNewtype RemoteConnection

Defined in GI.NM.Objects.RemoteConnection

Methods

toManagedPtr :: RemoteConnection -> ManagedPtr RemoteConnection

TypedObject RemoteConnection

Defined in GI.NM.Objects.RemoteConnection

Methods

glibType :: IO GType

HasParentTypes RemoteConnection

Defined in GI.NM.Objects.RemoteConnection

IsGValue (Maybe RemoteConnection)

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

Defined in GI.NM.Objects.RemoteConnection

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes RemoteConnection

Defined in GI.NM.Objects.RemoteConnection

type ParentTypes RemoteConnection = '[Object, Object, Connection]

class (GObject o, IsDescendantOf RemoteConnection o) => IsRemoteConnection o

Type class for types which can be safely cast to RemoteConnection, for instance with toRemoteConnection.

Instances

(GObject o, IsDescendantOf RemoteConnection o) => IsRemoteConnection o

Defined in GI.NM.Objects.RemoteConnection

toRemoteConnection :: (MonadIO m, IsRemoteConnection o) => o -> m RemoteConnection

Cast to RemoteConnection, 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

addSetting, bindProperty, bindPropertyFull, clearSecrets, clearSecretsWithFlags, clearSettings, commitChanges, commitChangesAsync, commitChangesFinish, compare, delete, deleteAsync, deleteFinish, dump, forEachSettingValue, forceFloating, freezeNotify, getv, isFloating, isType, isVirtual, needSecrets, normalize, notify, notifyByPspec, ref, refSink, removeSetting, replaceSettings, replaceSettingsFromConnection, runDispose, save, saveAsync, saveFinish, stealData, stealQdata, thawNotify, toDbus, unref, update2, update2Finish, updateSecrets, verify, verifySecrets, watchClosure.

Getters

getClient, getConnectionType, getData, getFilename, getFlags, getId, getInterfaceName, getPath, getProperty, getQdata, getSecrets, getSecretsAsync, getSecretsFinish, getSetting, getSetting8021x, getSettingAdsl, getSettingBluetooth, getSettingBond, getSettingBridge, getSettingBridgePort, getSettingByName, getSettingCdma, getSettingConnection, getSettingDcb, getSettingDummy, getSettingGeneric, getSettingGsm, getSettingInfiniband, getSettingIp4Config, getSettingIp6Config, getSettingIpTunnel, getSettingMacsec, getSettingMacvlan, getSettingOlpcMesh, getSettingOvsBridge, getSettingOvsInterface, getSettingOvsPatch, getSettingOvsPort, getSettingPpp, getSettingPppoe, getSettingProxy, getSettingSerial, getSettingTcConfig, getSettingTeam, getSettingTeamPort, getSettingTun, getSettingVlan, getSettingVpn, getSettingVxlan, getSettingWimax, getSettingWired, getSettingWireless, getSettingWirelessSecurity, getSettings, getUnsaved, getUuid, getVersionId, getVirtualDeviceDescription, getVisible.

Setters

setData, setDataFull, setPath, setProperty.

commitChanges

remoteConnectionCommitChanges

Arguments

:: (HasCallStack, MonadIO m, IsRemoteConnection a, IsCancellable b)

=> a

connection: the RemoteConnection

-> Bool

saveToDisk: whether to persist the changes to disk

-> Maybe b

cancellable: a Cancellable, or Nothing

-> m ()

(Can throw GError)

Deprecated: (Since version 1.22)Use remoteConnectionCommitChangesAsync or GDBusConnection.

Send any local changes to the settings and properties of connection to NetworkManager. If saveToDisk is True, the updated connection will be saved to disk; if False, then only the in-memory representation will be changed.

commitChangesAsync

remoteConnectionCommitChangesAsync

Arguments

:: (HasCallStack, MonadIO m, IsRemoteConnection a, IsCancellable b)

=> a

connection: the RemoteConnection

-> Bool

saveToDisk: whether to save the changes to persistent storage

-> Maybe b

cancellable: a Cancellable, or Nothing

-> Maybe AsyncReadyCallback

callback: callback to be called when the commit operation completes

-> m ()

Asynchronously sends any local changes to the settings and properties of connection to NetworkManager. If save is True, the updated connection will be saved to disk; if False, then only the in-memory representation will be changed.

commitChangesFinish

remoteConnectionCommitChangesFinish

Arguments

:: (HasCallStack, MonadIO m, IsRemoteConnection a, IsAsyncResult b)

=> a

connection: the RemoteConnection

-> b

result: the result passed to the AsyncReadyCallback

-> m ()

(Can throw GError)

Gets the result of a call to remoteConnectionCommitChangesAsync.

delete

remoteConnectionDelete

Arguments

:: (HasCallStack, MonadIO m, IsRemoteConnection a, IsCancellable b)

=> a

connection: the RemoteConnection

-> Maybe b

cancellable: a Cancellable, or Nothing

-> m ()

(Can throw GError)

Deprecated: (Since version 1.22)Use remoteConnectionDeleteAsync or GDBusConnection.

Deletes the connection.

deleteAsync

remoteConnectionDeleteAsync

Arguments

:: (HasCallStack, MonadIO m, IsRemoteConnection a, IsCancellable b)

=> a

connection: the RemoteConnection

-> Maybe b

cancellable: a Cancellable, or Nothing

-> Maybe AsyncReadyCallback

callback: callback to be called when the delete operation completes

-> m ()

Asynchronously deletes the connection.

deleteFinish

remoteConnectionDeleteFinish

Arguments

:: (HasCallStack, MonadIO m, IsRemoteConnection a, IsAsyncResult b)

=> a

connection: the RemoteConnection

-> b

result: the result passed to the AsyncReadyCallback

-> m ()

(Can throw GError)

Gets the result of a call to remoteConnectionDeleteAsync.

getFilename

remoteConnectionGetFilename

Arguments

:: (HasCallStack, MonadIO m, IsRemoteConnection a)

=> a

connection: the RemoteConnection

-> m Text

Returns: file that stores the connection in case the connection is file-backed.

No description available in the introspection data.

Since: 1.12

getFlags

remoteConnectionGetFlags

Arguments

:: (HasCallStack, MonadIO m, IsRemoteConnection a)

=> a

connection: the RemoteConnection

-> m [SettingsConnectionFlags]

Returns: the flags of the connection of type SettingsConnectionFlags.

No description available in the introspection data.

Since: 1.12

getSecrets

remoteConnectionGetSecrets

Arguments

:: (HasCallStack, MonadIO m, IsRemoteConnection a, IsCancellable b)

=> a

connection: the RemoteConnection

-> Text

settingName: the Setting object name to get secrets for

-> Maybe b

cancellable: a Cancellable, or Nothing

-> m GVariant

Returns: a GVariant of type NM_VARIANT_TYPE_CONNECTION containing connection's secrets, or Nothing on error.

Warning: NMClient contains a cache of objects on D-Bus. This cache gets updated with D-Bus signals when iterating the GMainContext. This function performs a (pseudo) blocking D-Bus call. Aside blocking, the result will not be in sync and not be ordered with the content of the NMClient cache. This function used to be deprecated between 1.22 and 1.38 releases. (Can throw GError)

Request the connection's secrets. Note that this is a blocking D-Bus call, not a simple property accessor.

getSecretsAsync

remoteConnectionGetSecretsAsync

Arguments

:: (HasCallStack, MonadIO m, IsRemoteConnection a, IsCancellable b)

=> a

connection: the RemoteConnection

-> Text

settingName: the Setting object name to get secrets for

-> Maybe b

cancellable: a Cancellable, or Nothing

-> Maybe AsyncReadyCallback

callback: callback to be called when the secret request completes

-> m ()

Asynchronously requests the connection's secrets.

getSecretsFinish

remoteConnectionGetSecretsFinish

Arguments

:: (HasCallStack, MonadIO m, IsRemoteConnection a, IsAsyncResult b)

=> a

connection: the RemoteConnection

-> b

result: the result passed to the AsyncReadyCallback

-> m GVariant

Returns: a GVariant of type NM_VARIANT_TYPE_CONNECTION containing connection's secrets, or Nothing on error. (Can throw GError)

Gets the result of a call to remoteConnectionGetSecretsAsync.

getUnsaved

remoteConnectionGetUnsaved

Arguments

:: (HasCallStack, MonadIO m, IsRemoteConnection a)

=> a

connection: the RemoteConnection

-> m Bool

Returns: True if the remote connection contains changes that have not been saved to disk, False if the connection is the same as its on-disk representation.

No description available in the introspection data.

getVersionId

remoteConnectionGetVersionId

Arguments

:: (HasCallStack, MonadIO m, IsRemoteConnection a)

=> a

connection: the RemoteConnection

-> m Word64

Returns: the version-id of the profile. This ID is incremented whenever the profile is modified.

No description available in the introspection data.

Since: 1.44

getVisible

remoteConnectionGetVisible

Arguments

:: (HasCallStack, MonadIO m, IsRemoteConnection a)

=> a

connection: the RemoteConnection

-> m Bool

Returns: True if the remote connection is visible to the current user, False if not.

Checks if the connection is visible to the current user. If the connection is not visible then it is essentially useless; it will not contain any settings, and operations such as remoteConnectionSave and remoteConnectionDelete will always fail. (NMRemoteSettings will not normally return non-visible connections to callers, but it is possible for a connection's visibility to change after you already have a reference to it.)

save

remoteConnectionSave

Arguments

:: (HasCallStack, MonadIO m, IsRemoteConnection a, IsCancellable b)

=> a

connection: the RemoteConnection

-> Maybe b

cancellable: a Cancellable, or Nothing

-> m ()

(Can throw GError)

Deprecated: (Since version 1.22)Use remoteConnectionSaveAsync or GDBusConnection.

Saves the connection to disk if the connection has changes that have not yet been written to disk, or if the connection has never been saved.

saveAsync

remoteConnectionSaveAsync

Arguments

:: (HasCallStack, MonadIO m, IsRemoteConnection a, IsCancellable b)

=> a

connection: the RemoteConnection

-> Maybe b

cancellable: a Cancellable, or Nothing

-> Maybe AsyncReadyCallback

callback: callback to be called when the save operation completes

-> m ()

Saves the connection to disk if the connection has changes that have not yet been written to disk, or if the connection has never been saved.

saveFinish

remoteConnectionSaveFinish

Arguments

:: (HasCallStack, MonadIO m, IsRemoteConnection a, IsAsyncResult b)

=> a

connection: the RemoteConnection

-> b

result: the result passed to the AsyncReadyCallback

-> m ()

(Can throw GError)

Gets the result of a call to remoteConnectionSaveAsync.

update2

remoteConnectionUpdate2

Arguments

:: (HasCallStack, MonadIO m, IsRemoteConnection a, IsCancellable b)

=> a

connection: the RemoteConnection

-> Maybe GVariant

settings: optional connection to update the settings.

-> [SettingsUpdate2Flags]

flags: update-flags

-> Maybe GVariant

args: optional arguments.

-> Maybe b

cancellable: a Cancellable, or Nothing

-> Maybe AsyncReadyCallback

callback: callback to be called when the commit operation completes

-> m ()

Asynchronously calls the Update2() D-Bus method.

Since: 1.12

update2Finish

remoteConnectionUpdate2Finish

Arguments

:: (HasCallStack, MonadIO m, IsRemoteConnection a, IsAsyncResult b)

=> a

connection: the RemoteConnection

-> b

result: the result passed to the AsyncReadyCallback

-> m GVariant

Returns: on success, a GVariant of type "a{sv}" with the result. On failure, Nothing. (Can throw GError)

Gets the result of a call to remoteConnectionCommitChangesAsync.

Since: 1.12

Properties

filename

File that stores the connection in case the connection is file-backed.

Since: 1.12

getRemoteConnectionFilename :: (MonadIO m, IsRemoteConnection o) => o -> m Text

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

get remoteConnection #filename

flags

The flags of the connection as unsigned integer. The values correspond to the SettingsConnectionFlags enum.

Since: 1.12

getRemoteConnectionFlags :: (MonadIO m, IsRemoteConnection o) => o -> m Word32

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

get remoteConnection #flags

unsaved

True if the remote connection contains changes that have not been saved to disk, False if the connection is the same as its on-disk representation.

getRemoteConnectionUnsaved :: (MonadIO m, IsRemoteConnection o) => o -> m Bool

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

get remoteConnection #unsaved

versionId

The version ID of the profile that is incremented when the profile gets modified. This can be used to track concurrent modifications of the profile.

Since: 1.44

getRemoteConnectionVersionId :: (MonadIO m, IsRemoteConnection o) => o -> m Word64

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

get remoteConnection #versionId

visible

True if the remote connection is visible to the current user, False if not. If the connection is not visible then it is essentially useless; it will not contain any settings, and operations such as remoteConnectionSave and remoteConnectionDelete will always fail. (NMRemoteSettings will not normally return non-visible connections to callers, but it is possible for a connection's visibility to change after you already have a reference to it.)

getRemoteConnectionVisible :: (MonadIO m, IsRemoteConnection o) => o -> m Bool

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

get remoteConnection #visible