ModemManager.BearerProperties¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` ()
	`get_access_type_preference` ()
	`get_allow_roaming` ()
	`get_allowed_auth` ()
	`get_apn` ()
	`get_apn_type` ()
	`get_force` ()
	`get_ip_type` ()
	`get_multiplex` ()
	`get_number` ()
	`get_password` ()
	`get_profile_id` ()
	`get_profile_name` ()
	`get_rm_protocol` ()
	`get_roaming_allowance` ()
	`get_user` ()
	`set_access_type_preference` (access_type_preference)
	`set_allow_roaming` (allow_roaming)
	`set_allowed_auth` (allowed_auth)
	`set_apn` (apn)
	`set_apn_type` (apn_type)
	`set_force` (force)
	`set_ip_type` (ip_type)
	`set_multiplex` (multiplex)
	`set_number` (number)
	`set_password` (password)
	`set_profile_id` (profile_id)
	`set_profile_name` (profile_name)
	`set_rm_protocol` (protocol)
	`set_roaming_allowance` (roaming_allowance)
	`set_user` (user)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class ModemManager.BearerProperties(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: ModemManager.BearerPropertiesClass

The ModemManager.BearerProperties structure contains private data and should only be accessed using the provided API.

classmethod new()¶

Returns:: a ModemManager.BearerProperties. The returned value should be freed with GObject.Object.unref().
Return type:: ModemManager.BearerProperties

Creates a new empty ModemManager.BearerProperties.

Added in version 1.0.

get_access_type_preference()¶

Returns:: a ModemManager.BearerAccessTypePreference value.
Return type:: ModemManager.BearerAccessTypePreference

Gets the 5G network access type preference.

Added in version 1.20.

get_allow_roaming()¶

Returns:: True if roaming is allowed, False otherwise.
Return type:: bool

Checks whether roaming is allowed in the connection.

Added in version 1.0.

get_allowed_auth()¶

Returns:: a bitmask of ModemManager.BearerAllowedAuth values, or ModemManager.BearerAllowedAuth.UNKNOWN to request the modem-default method.
Return type:: ModemManager.BearerAllowedAuth

Gets the authentication methods allowed in the connection.

Added in version 1.0.

get_apn()¶

Returns:: the access point, or None if not set. Do not free the returned value, it is owned by self.
Return type:: str

Gets the name of the access point to use when connecting.

Added in version 1.0.

get_apn_type()¶

Returns:: a mask of ModemManager.BearerApnType values.
Return type:: ModemManager.BearerApnType

Gets the APN types to use.

Added in version 1.18.

get_force()¶

Returns:: True if force send is required, False otherwise.
Return type:: bool

Checks whether initial EPS bearer settings should be forced sent to the modem.This method does not apply when the bearer properties are used for other operations.

Added in version 1.24.

get_ip_type()¶

Returns:: a ModemManager.BearerIpFamily.
Return type:: ModemManager.BearerIpFamily

Sets the IP type to use.

Added in version 1.0.

get_multiplex()¶

Returns:: a ModemManager.BearerMultiplexSupport.
Return type:: ModemManager.BearerMultiplexSupport

Gets the type of multiplex support requested by the user.

Added in version 1.18.

get_number()¶

Returns:: the number, or None if not set. Do not free the returned value, it is owned by self.
Return type:: str

Gets the number to use when performing the connection.

Added in version 1.0.

Deprecated since version 1.10.0.: The number setting is not used anywhere, and therefore it doesn’t make sense to expose it in the ModemManager interface.

get_password()¶

Returns:: the password, or None if not set. Do not free the returned value, it is owned by self.
Return type:: str

Gets the password used to authenticate with the access point.

Added in version 1.0.

get_profile_id()¶

Returns:: the profile id.
Return type:: int

Gets the profile ID to use.

Added in version 1.18.

get_profile_name()¶

Returns:: the profile name, or None if not set. Do not free the returned value, it is owned by self.
Return type:: str

Gets the name of the profile to use when connecting.

Added in version 1.20.

get_rm_protocol()¶

Returns:: a ModemManager.ModemCdmaRmProtocol.
Return type:: ModemManager.ModemCdmaRmProtocol

Gets the RM protocol requested to use in the CDMA connection.

Added in version 1.0.

get_roaming_allowance()¶

Returns:: a mask of ModemManager.BearerRoamingAllowance values.
Return type:: ModemManager.BearerRoamingAllowance

Gets the roaming allowance rules.

Added in version 1.20.

get_user()¶

Returns:: the username, or None if not set. Do not free the returned value, it is owned by self.
Return type:: str

Gets the username used to authenticate with the access point.

Added in version 1.0.

set_access_type_preference(access_type_preference)¶

Parameters:: access_type_preference (ModemManager.BearerAccessTypePreference) – a ModemManager.BearerAccessTypePreference value.

Sets the 5G network access type preference.

Added in version 1.20.

set_allow_roaming(allow_roaming)¶

Parameters:: allow_roaming (bool) – boolean value.

Sets the flag to indicate whether roaming is allowed or not in the connection.

Added in version 1.0.

set_allowed_auth(allowed_auth)¶

Parameters:: allowed_auth (ModemManager.BearerAllowedAuth) – a bitmask of ModemManager.BearerAllowedAuth values. ModemManager.BearerAllowedAuth.UNKNOWN may be given to request the modem-default method.

Sets the authentication method to use.

Added in version 1.0.

set_apn(apn)¶

Parameters:: apn (str) – Name of the access point.

Sets the name of the access point to use when connecting.

Added in version 1.0.

set_apn_type(apn_type)¶

Parameters:: apn_type (ModemManager.BearerApnType) – a mask of ModemManager.BearerApnType values.

Sets the APN types to use.

Added in version 1.18.

set_force(force)¶

Parameters:: force (bool) – boolean value.

Sets the flag to indicate whether initial EPS bearer settings should be forced sent to the modem even if they match existing properties. This method does not apply when the bearer properties are used for other operations.

Added in version 1.24.

set_ip_type(ip_type)¶

Parameters:: ip_type (ModemManager.BearerIpFamily) – a ModemManager.BearerIpFamily.

Sets the IP type to use.

Added in version 1.0.

set_multiplex(multiplex)¶

Parameters:: multiplex (ModemManager.BearerMultiplexSupport) – a ModemManager.BearerMultiplexSupport.

Gets the type of multiplex support requested by the user.

Added in version 1.18.

set_number(number)¶

Parameters:: number (str) – the number.

Sets the number to use when performing the connection.

Added in version 1.0.

Deprecated since version 1.10.0.: The number setting is not used anywhere, and therefore it doesn’t make sense to expose it in the ModemManager interface.

set_password(password)¶

Parameters:: password (str) – the password

Sets the password used to authenticate with the access point.

Added in version 1.0.

set_profile_id(profile_id)¶

Parameters:: profile_id (int) – a profile id.

Sets the profile ID to use.

Added in version 1.18.

set_profile_name(profile_name)¶

Parameters:: profile_name (str) – Name of the profile.

Sets the name of the profile to use when connecting.

Added in version 1.20.

set_rm_protocol(protocol)¶

Parameters:: protocol (ModemManager.ModemCdmaRmProtocol) – a ModemManager.ModemCdmaRmProtocol.

Sets the RM protocol to use in the CDMA connection.

Added in version 1.0.

set_roaming_allowance(roaming_allowance)¶

Parameters:: roaming_allowance (ModemManager.BearerRoamingAllowance) – a mask of ModemManager.BearerRoamingAllowance values

Sets the roaming allowance rules.

Added in version 1.20.

set_user(user)¶

Parameters:: user (str) – the username

Sets the username used to authenticate with the access point.

Added in version 1.0.