GI.NM.Objects.SettingGsm

GSM-based Mobile Broadband Settings

Exported types

newtype SettingGsm

Memory-managed wrapper type.

Constructors

SettingGsm (ManagedPtr SettingGsm)

Instances

Eq SettingGsm

Defined in GI.NM.Objects.SettingGsm

Methods

(==) :: SettingGsm -> SettingGsm -> Bool

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

GObject SettingGsm

Defined in GI.NM.Objects.SettingGsm

ManagedPtrNewtype SettingGsm

Defined in GI.NM.Objects.SettingGsm

Methods

toManagedPtr :: SettingGsm -> ManagedPtr SettingGsm

TypedObject SettingGsm

Defined in GI.NM.Objects.SettingGsm

Methods

glibType :: IO GType

HasParentTypes SettingGsm

Defined in GI.NM.Objects.SettingGsm

IsGValue (Maybe SettingGsm)

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

Defined in GI.NM.Objects.SettingGsm

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes SettingGsm

Defined in GI.NM.Objects.SettingGsm

type ParentTypes SettingGsm = '[Setting, Object]

class (GObject o, IsDescendantOf SettingGsm o) => IsSettingGsm o

Type class for types which can be safely cast to SettingGsm, for instance with toSettingGsm.

Instances

(GObject o, IsDescendantOf SettingGsm o) => IsSettingGsm o

Defined in GI.NM.Objects.SettingGsm

toSettingGsm :: (MonadIO m, IsSettingGsm o) => o -> m SettingGsm

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

getApn, getAutoConfig, getData, getDbusPropertyType, getDeviceId, getHomeOnly, getInitialEpsApn, getInitialEpsConfig, getMtu, getName, getNetworkId, getNumber, getPassword, getPasswordFlags, getPin, getPinFlags, getProperty, getQdata, getSecretFlags, getSimId, getSimOperatorId, getUsername.

Setters

setData, setDataFull, setProperty, setSecretFlags.

getApn

settingGsmGetApn

Arguments

:: (HasCallStack, MonadIO m, IsSettingGsm a)

=> a

setting: the SettingGsm

-> m Text

Returns: the SettingGsm:apn property of the setting

No description available in the introspection data.

getAutoConfig

settingGsmGetAutoConfig

Arguments

:: (HasCallStack, MonadIO m, IsSettingGsm a)

=> a

setting: the SettingGsm

-> m Bool

Returns: the SettingGsm:autoConfig property of the setting

No description available in the introspection data.

Since: 1.22

getDeviceId

settingGsmGetDeviceId

Arguments

:: (HasCallStack, MonadIO m, IsSettingGsm a)

=> a

setting: the SettingGsm

-> m Text

Returns: the SettingGsm:deviceId property of the setting

No description available in the introspection data.

Since: 1.2

getHomeOnly

settingGsmGetHomeOnly

Arguments

:: (HasCallStack, MonadIO m, IsSettingGsm a)

=> a

setting: the SettingGsm

-> m Bool

Returns: the SettingGsm:homeOnly property of the setting

No description available in the introspection data.

getInitialEpsApn

settingGsmGetInitialEpsApn

Arguments

:: (HasCallStack, MonadIO m, IsSettingGsm a)

=> a

setting: the SettingGsm

-> m Text

Returns: the SettingGsm:initialEpsBearerApn property of the setting

No description available in the introspection data.

Since: 1.44

getInitialEpsConfig

settingGsmGetInitialEpsConfig

Arguments

:: (HasCallStack, MonadIO m, IsSettingGsm a)

=> a

setting: the SettingGsm

-> m Bool

Returns: the SettingGsm:initialEpsBearerConfigure property of the setting

No description available in the introspection data.

Since: 1.44

getMtu

settingGsmGetMtu

Arguments

:: (HasCallStack, MonadIO m, IsSettingGsm a)

=> a

setting: the SettingGsm

-> m Word32

Returns: the SettingGsm:mtu property of the setting

No description available in the introspection data.

Since: 1.8

getNetworkId

settingGsmGetNetworkId

Arguments

:: (HasCallStack, MonadIO m, IsSettingGsm a)

=> a

setting: the SettingGsm

-> m Text

Returns: the SettingGsm:networkId property of the setting

No description available in the introspection data.

getNumber

settingGsmGetNumber

Arguments

:: (HasCallStack, MonadIO m, IsSettingGsm a)

=> a

setting: the SettingGsm

-> m Text

Returns: the SettingGsm:number property of the setting

Deprecated: (Since version 1.16)User-provided values for this setting are no longer used.

No description available in the introspection data.

getPassword

settingGsmGetPassword

Arguments

:: (HasCallStack, MonadIO m, IsSettingGsm a)

=> a

setting: the SettingGsm

-> m Text

Returns: the SettingGsm:password property of the setting

No description available in the introspection data.

getPasswordFlags

settingGsmGetPasswordFlags

Arguments

:: (HasCallStack, MonadIO m, IsSettingGsm a)

=> a

setting: the SettingGsm

-> m [SettingSecretFlags]

Returns: the SettingSecretFlags pertaining to the SettingGsm:password

No description available in the introspection data.

getPin

settingGsmGetPin

Arguments

:: (HasCallStack, MonadIO m, IsSettingGsm a)

=> a

setting: the SettingGsm

-> m Text

Returns: the SettingGsm:pin property of the setting

No description available in the introspection data.

getPinFlags

settingGsmGetPinFlags

Arguments

:: (HasCallStack, MonadIO m, IsSettingGsm a)

=> a

setting: the SettingGsm

-> m [SettingSecretFlags]

Returns: the SettingSecretFlags pertaining to the SettingGsm:pin

No description available in the introspection data.

getSimId

settingGsmGetSimId

Arguments

:: (HasCallStack, MonadIO m, IsSettingGsm a)

=> a

setting: the SettingGsm

-> m Text

Returns: the SettingGsm:simId property of the setting

No description available in the introspection data.

Since: 1.2

getSimOperatorId

settingGsmGetSimOperatorId

Arguments

:: (HasCallStack, MonadIO m, IsSettingGsm a)

=> a

setting: the SettingGsm

-> m Text

Returns: the SettingGsm:simOperatorId property of the setting

No description available in the introspection data.

Since: 1.2

getUsername

settingGsmGetUsername

Arguments

:: (HasCallStack, MonadIO m, IsSettingGsm a)

=> a

setting: the SettingGsm

-> m Text

Returns: the SettingGsm:username property of the setting

No description available in the introspection data.

new

settingGsmNew

Arguments

:: (HasCallStack, MonadIO m)

=> m SettingGsm

Returns: the new empty SettingGsm object

Creates a new SettingGsm object with default values.

Properties

apn

The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.

If the APN is unset (the default) then it may be detected based on "auto-config" setting. The property can be explicitly set to the empty string to prevent that and use no APN.

clearSettingGsmApn :: (MonadIO m, IsSettingGsm o) => o -> m ()

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

clear #apn

constructSettingGsmApn :: (IsSettingGsm o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingGsmApn :: (MonadIO m, IsSettingGsm o) => o -> m Text

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

get settingGsm #apn

setSettingGsmApn :: (MonadIO m, IsSettingGsm o) => o -> Text -> m ()

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

set settingGsm [ #apn := value ]

autoConfig

When True, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.

Since: 1.22

constructSettingGsmAutoConfig :: (IsSettingGsm o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getSettingGsmAutoConfig :: (MonadIO m, IsSettingGsm o) => o -> m Bool

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

get settingGsm #autoConfig

setSettingGsmAutoConfig :: (MonadIO m, IsSettingGsm o) => o -> Bool -> m ()

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

set settingGsm [ #autoConfig := value ]

deviceId

The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.

Since: 1.2

clearSettingGsmDeviceId :: (MonadIO m, IsSettingGsm o) => o -> m ()

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

clear #deviceId

constructSettingGsmDeviceId :: (IsSettingGsm o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingGsmDeviceId :: (MonadIO m, IsSettingGsm o) => o -> m Text

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

get settingGsm #deviceId

setSettingGsmDeviceId :: (MonadIO m, IsSettingGsm o) => o -> Text -> m ()

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

set settingGsm [ #deviceId := value ]

homeOnly

When True, only connections to the home network will be allowed. Connections to roaming networks will not be made.

constructSettingGsmHomeOnly :: (IsSettingGsm o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getSettingGsmHomeOnly :: (MonadIO m, IsSettingGsm o) => o -> m Bool

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

get settingGsm #homeOnly

setSettingGsmHomeOnly :: (MonadIO m, IsSettingGsm o) => o -> Bool -> m ()

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

set settingGsm [ #homeOnly := value ]

initialEpsBearerApn

For LTE modems, this sets the APN for the initial EPS bearer that is set up when attaching to the network. Setting this parameter implies initial-eps-bearer-configure to be TRUE.

Since: 1.44

clearSettingGsmInitialEpsBearerApn :: (MonadIO m, IsSettingGsm o) => o -> m ()

Set the value of the “initial-eps-bearer-apn” property to Nothing. When overloading is enabled, this is equivalent to

clear #initialEpsBearerApn

constructSettingGsmInitialEpsBearerApn :: (IsSettingGsm o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingGsmInitialEpsBearerApn :: (MonadIO m, IsSettingGsm o) => o -> m (Maybe Text)

Get the value of the “initial-eps-bearer-apn” property. When overloading is enabled, this is equivalent to

get settingGsm #initialEpsBearerApn

setSettingGsmInitialEpsBearerApn :: (MonadIO m, IsSettingGsm o) => o -> Text -> m ()

Set the value of the “initial-eps-bearer-apn” property. When overloading is enabled, this is equivalent to

set settingGsm [ #initialEpsBearerApn := value ]

initialEpsBearerConfigure

For LTE modems, this setting determines whether the initial EPS bearer shall be configured when bringing up the connection. It is inferred TRUE if initial-eps-bearer-apn is set.

Since: 1.44

constructSettingGsmInitialEpsBearerConfigure :: (IsSettingGsm o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getSettingGsmInitialEpsBearerConfigure :: (MonadIO m, IsSettingGsm o) => o -> m Bool

Get the value of the “initial-eps-bearer-configure” property. When overloading is enabled, this is equivalent to

get settingGsm #initialEpsBearerConfigure

setSettingGsmInitialEpsBearerConfigure :: (MonadIO m, IsSettingGsm o) => o -> Bool -> m ()

Set the value of the “initial-eps-bearer-configure” property. When overloading is enabled, this is equivalent to

set settingGsm [ #initialEpsBearerConfigure := value ]

mtu

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.

Since: 1.8

constructSettingGsmMtu :: (IsSettingGsm o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSettingGsmMtu :: (MonadIO m, IsSettingGsm o) => o -> m Word32

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

get settingGsm #mtu

setSettingGsmMtu :: (MonadIO m, IsSettingGsm o) => o -> Word32 -> m ()

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

set settingGsm [ #mtu := value ]

networkId

The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.

clearSettingGsmNetworkId :: (MonadIO m, IsSettingGsm o) => o -> m ()

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

clear #networkId

constructSettingGsmNetworkId :: (IsSettingGsm o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingGsmNetworkId :: (MonadIO m, IsSettingGsm o) => o -> m Text

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

get settingGsm #networkId

setSettingGsmNetworkId :: (MonadIO m, IsSettingGsm o) => o -> Text -> m ()

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

set settingGsm [ #networkId := value ]

number

Legacy setting that used to help establishing PPP data sessions for GSM-based modems.

clearSettingGsmNumber :: (MonadIO m, IsSettingGsm o) => o -> m ()

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

clear #number

constructSettingGsmNumber :: (IsSettingGsm o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingGsmNumber :: (MonadIO m, IsSettingGsm o) => o -> m Text

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

get settingGsm #number

setSettingGsmNumber :: (MonadIO m, IsSettingGsm o) => o -> Text -> m ()

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

set settingGsm [ #number := value ]

password

The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.

clearSettingGsmPassword :: (MonadIO m, IsSettingGsm o) => o -> m ()

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

clear #password

constructSettingGsmPassword :: (IsSettingGsm o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingGsmPassword :: (MonadIO m, IsSettingGsm o) => o -> m Text

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

get settingGsm #password

setSettingGsmPassword :: (MonadIO m, IsSettingGsm o) => o -> Text -> m ()

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

set settingGsm [ #password := value ]

passwordFlags

Flags indicating how to handle the SettingGsm:password property.

constructSettingGsmPasswordFlags :: (IsSettingGsm o, MonadIO m) => [SettingSecretFlags] -> m (GValueConstruct o)

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

getSettingGsmPasswordFlags :: (MonadIO m, IsSettingGsm o) => o -> m [SettingSecretFlags]

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

get settingGsm #passwordFlags

setSettingGsmPasswordFlags :: (MonadIO m, IsSettingGsm o) => o -> [SettingSecretFlags] -> m ()

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

set settingGsm [ #passwordFlags := value ]

pin

If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.

clearSettingGsmPin :: (MonadIO m, IsSettingGsm o) => o -> m ()

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

clear #pin

constructSettingGsmPin :: (IsSettingGsm o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingGsmPin :: (MonadIO m, IsSettingGsm o) => o -> m Text

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

get settingGsm #pin

setSettingGsmPin :: (MonadIO m, IsSettingGsm o) => o -> Text -> m ()

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

set settingGsm [ #pin := value ]

pinFlags

Flags indicating how to handle the SettingGsm:pin property.

constructSettingGsmPinFlags :: (IsSettingGsm o, MonadIO m) => [SettingSecretFlags] -> m (GValueConstruct o)

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

getSettingGsmPinFlags :: (MonadIO m, IsSettingGsm o) => o -> m [SettingSecretFlags]

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

get settingGsm #pinFlags

setSettingGsmPinFlags :: (MonadIO m, IsSettingGsm o) => o -> [SettingSecretFlags] -> m ()

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

set settingGsm [ #pinFlags := value ]

simId

The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by SettingGsm:deviceId which contains a SIM card matching the given identifier.

Since: 1.2

clearSettingGsmSimId :: (MonadIO m, IsSettingGsm o) => o -> m ()

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

clear #simId

constructSettingGsmSimId :: (IsSettingGsm o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingGsmSimId :: (MonadIO m, IsSettingGsm o) => o -> m Text

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

get settingGsm #simId

setSettingGsmSimId :: (MonadIO m, IsSettingGsm o) => o -> Text -> m ()

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

set settingGsm [ #simId := value ]

simOperatorId

A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by SettingGsm:deviceId and SettingGsm:simId which contains a SIM card provisioned by the given operator.

Since: 1.2

clearSettingGsmSimOperatorId :: (MonadIO m, IsSettingGsm o) => o -> m ()

Set the value of the “sim-operator-id” property to Nothing. When overloading is enabled, this is equivalent to

clear #simOperatorId

constructSettingGsmSimOperatorId :: (IsSettingGsm o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingGsmSimOperatorId :: (MonadIO m, IsSettingGsm o) => o -> m Text

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

get settingGsm #simOperatorId

setSettingGsmSimOperatorId :: (MonadIO m, IsSettingGsm o) => o -> Text -> m ()

Set the value of the “sim-operator-id” property. When overloading is enabled, this is equivalent to

set settingGsm [ #simOperatorId := value ]

username

The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.

clearSettingGsmUsername :: (MonadIO m, IsSettingGsm o) => o -> m ()

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

clear #username

constructSettingGsmUsername :: (IsSettingGsm o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingGsmUsername :: (MonadIO m, IsSettingGsm o) => o -> m Text

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

get settingGsm #username

setSettingGsmUsername :: (MonadIO m, IsSettingGsm o) => o -> Text -> m ()

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

set settingGsm [ #username := value ]