GI.NM.Objects.SettingUser

General User Profile Settings

Since: 1.8

Exported types

newtype SettingUser

Memory-managed wrapper type.

Constructors

SettingUser (ManagedPtr SettingUser)

Instances

Eq SettingUser

Defined in GI.NM.Objects.SettingUser

Methods

(==) :: SettingUser -> SettingUser -> Bool

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

GObject SettingUser

Defined in GI.NM.Objects.SettingUser

ManagedPtrNewtype SettingUser

Defined in GI.NM.Objects.SettingUser

Methods

toManagedPtr :: SettingUser -> ManagedPtr SettingUser

TypedObject SettingUser

Defined in GI.NM.Objects.SettingUser

Methods

glibType :: IO GType

HasParentTypes SettingUser

Defined in GI.NM.Objects.SettingUser

IsGValue (Maybe SettingUser)

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

Defined in GI.NM.Objects.SettingUser

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes SettingUser

Defined in GI.NM.Objects.SettingUser

type ParentTypes SettingUser = '[Setting, Object]

class (GObject o, IsDescendantOf SettingUser o) => IsSettingUser o

Type class for types which can be safely cast to SettingUser, for instance with toSettingUser.

Instances

(GObject o, IsDescendantOf SettingUser o) => IsSettingUser o

Defined in GI.NM.Objects.SettingUser

toSettingUser :: (MonadIO m, IsSettingUser o) => o -> m SettingUser

Cast to SettingUser, 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, compare, diff, duplicate, enumerateValues, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, optionClearByName, optionGet, optionGetAllNames, optionGetBoolean, optionGetUint32, optionSet, optionSetBoolean, optionSetUint32, ref, refSink, runDispose, stealData, stealQdata, thawNotify, toString, unref, verify, verifySecrets, watchClosure.

Getters

getData, getDbusPropertyType, getKeys, getName, getProperty, getQdata, getSecretFlags.

Setters

setData, setDataFull, setProperty, setSecretFlags.

checkKey

settingUserCheckKey

Arguments

:: (HasCallStack, MonadIO m)

=> Text

key: the key to check

-> m ()

(Can throw GError)

Checks whether key is a valid user data key. This means, key is not Nothing, not too large and valid ASCII. Also, only digits and numbers are allowed with a few special characters. The key must contain at least one '.' and look like a fully qualified DNS name.

Since: 1.8

checkVal

settingUserCheckVal

Arguments

:: (HasCallStack, MonadIO m)

=> Text

val: the value to check

-> m ()

(Can throw GError)

Checks whether val is a valid user data value. This means, value is not Nothing, not too large and valid UTF-8.

Since: 1.8

getData

settingUserGetData

Arguments

:: (HasCallStack, MonadIO m, IsSettingUser a)

=> a

setting: the SettingUser instance

-> Text

key: the key to lookup

-> m Text

Returns: the value associated with key or Nothing if no such value exists.

No description available in the introspection data.

Since: 1.8

getKeys

settingUserGetKeys

Arguments

:: (HasCallStack, MonadIO m, IsSettingUser a)

=> a

setting: the SettingUser

-> m [Text]

Returns: a Nothing-terminated array containing each key from the table.

No description available in the introspection data.

Since: 1.8

new

settingUserNew

Arguments

:: (HasCallStack, MonadIO m)

=> m SettingUser

Returns: the new empty SettingUser object

Creates a new SettingUser object with default values.

Since: 1.8

setData

settingUserSetData

Arguments

:: (HasCallStack, MonadIO m, IsSettingUser a)

=> a

setting: the SettingUser instance

-> Text

key: the key to set

-> Maybe Text

val: the value to set or Nothing to clear a key.

-> m ()

(Can throw GError)

No description available in the introspection data.

Since: 1.8

Properties

data

A dictionary of key/value pairs with user data. This data is ignored by NetworkManager and can be used at the users discretion. The keys only support a strict ascii format, but the values can be arbitrary UTF8 strings up to a certain length.

Since: 1.8

clearSettingUserData :: (MonadIO m, IsSettingUser o) => o -> m ()

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

clear #data

constructSettingUserData :: (IsSettingUser o, MonadIO m) => Map Text Text -> m (GValueConstruct o)

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

getSettingUserData :: (MonadIO m, IsSettingUser o) => o -> m (Maybe (Map Text Text))

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

get settingUser #data

setSettingUserData :: (MonadIO m, IsSettingUser o) => o -> Map Text Text -> m ()

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

set settingUser [ #data := value ]