ModemManager.SimpleConnectProperties

g GObject.Object GObject.Object ModemManager.SimpleConnectProperties ModemManager.SimpleConnectProperties GObject.Object->ModemManager.SimpleConnectProperties

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class

new ()

get_allow_roaming ()

get_allowed_auth ()

get_apn ()

get_apn_type ()

get_ip_type ()

get_multiplex ()

get_number ()

get_operator_id ()

get_password ()

get_pin ()

get_profile_id ()

get_rm_protocol ()

get_user ()

set_allow_roaming (allow_roaming)

set_allowed_auth (allowed_auth)

set_apn (apn)

set_apn_type (apn_type)

set_ip_type (ip_type)

set_multiplex (multiplex)

set_number (number)

set_operator_id (operator_id)

set_password (password)

set_pin (pin)

set_profile_id (profile_id)

set_rm_protocol (protocol)

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.SimpleConnectProperties(**kwargs)
Bases:

GObject.Object

Abstract:

No

Structure:

ModemManager.SimpleConnectPropertiesClass

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

classmethod new()
Returns:

a ModemManager.SimpleConnectProperties. The returned value should be freed with GObject.Object.unref().

Return type:

ModemManager.SimpleConnectProperties

Creates a new empty ModemManager.SimpleConnectProperties.

New in version 1.0.

get_allow_roaming()
Returns:

True if roaming is allowed, False otherwise.

Return type:

bool

Checks whether roaming is allowed in the connection.

New 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.

New 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.

New in version 1.0.

get_apn_type()
Returns:

a mask of ModemManager.BearerApnType values.

Return type:

ModemManager.BearerApnType

Gets the APN types to use.

New in version 1.18.

get_ip_type()
Returns:

a ModemManager.BearerIpFamily.

Return type:

ModemManager.BearerIpFamily

Sets the IP type to use.

New in version 1.0.

get_multiplex()
Returns:

a ModemManager.BearerMultiplexSupport.

Return type:

ModemManager.BearerMultiplexSupport

Get the multiplex support requested by the user.

New 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.

New 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_operator_id()
Returns:

the operator ID, or None if not set. Do not free the returned value, it is owned by self.

Return type:

str

Gets the ID of the network to which register before connecting.

New in version 1.0.

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.

New in version 1.0.

get_pin()
Returns:

the PIN, or None if not set. Do not free the returned value, it is owned by self.

Return type:

str

Gets the PIN code to use when unlocking the modem.

New in version 1.0.

get_profile_id()
Returns:

the profile id.

Return type:

int

Gets the profile ID to use.

New in version 1.18.

get_rm_protocol()
Returns:

a ModemManager.ModemCdmaRmProtocol.

Return type:

ModemManager.ModemCdmaRmProtocol

Get the RM protocol requested by the user.

New in version 1.16.

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.

New in version 1.0.

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.

New 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.

New 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.

New 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.

New in version 1.18.

set_ip_type(ip_type)
Parameters:

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

Sets the IP type to use.

New in version 1.0.

set_multiplex(multiplex)
Parameters:

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

Sets the multiplex support requested by the user.

New in version 1.18.

set_number(number)
Parameters:

number (str) – the number.

Sets the number to use when performing the connection.

New 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_operator_id(operator_id)
Parameters:

operator_id (str) – operator ID, given as MCC/MNC.

Sets the ID of the network to which register before connecting.

New in version 1.0.

set_password(password)
Parameters:

password (str) – the password

Sets the password used to authenticate with the access point.

New in version 1.0.

set_pin(pin)
Parameters:

pin (str) – PIN code.

Sets the PIN code to use when unlocking the modem.

New in version 1.0.

set_profile_id(profile_id)
Parameters:

profile_id (int) – a profile id.

Sets the profile ID to use.

New in version 1.18.

set_rm_protocol(protocol)
Parameters:

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

Sets the RM protocol requested by the user.

New in version 1.16.

set_user(user)
Parameters:

user (str) – the username

Sets the username used to authenticate with the access point.

New in version 1.0.