ModemManager.Modem3gpp

g GObject.GInterface GObject.GInterface Gio.AsyncInitable Gio.AsyncInitable GObject.GInterface->Gio.AsyncInitable Gio.DBusInterface Gio.DBusInterface GObject.GInterface->Gio.DBusInterface Gio.Initable Gio.Initable GObject.GInterface->Gio.Initable ModemManager.GdbusModem3gpp ModemManager.GdbusModem3gpp GObject.GInterface->ModemManager.GdbusModem3gpp GObject.Object GObject.Object Gio.DBusProxy Gio.DBusProxy GObject.Object->Gio.DBusProxy Gio.AsyncInitable->Gio.DBusProxy Gio.DBusInterface->Gio.DBusProxy ModemManager.GdbusModem3gppProxy ModemManager.GdbusModem3gppProxy Gio.DBusProxy->ModemManager.GdbusModem3gppProxy Gio.Initable->Gio.DBusProxy ModemManager.GdbusModem3gpp->ModemManager.GdbusModem3gppProxy ModemManager.Modem3gpp ModemManager.Modem3gpp ModemManager.GdbusModem3gppProxy->ModemManager.Modem3gpp

Subclasses:

None

Methods

Inherited:

ModemManager.GdbusModem3gppProxy (6), Gio.DBusProxy (25), GObject.Object (37), Gio.AsyncInitable (4), Gio.DBusInterface (3), Gio.Initable (2), ModemManager.GdbusModem3gpp (34)

Structs:

GObject.ObjectClass (5)

disable_facility_lock (facility, control_key, cancellable, callback, *user_data)

disable_facility_lock_finish (res)

disable_facility_lock_sync (facility, control_key, cancellable)

dup_imei ()

dup_initial_eps_bearer_path ()

dup_operator_code ()

dup_operator_name ()

dup_path ()

get_enabled_facility_locks ()

get_eps_ue_mode_operation ()

get_imei ()

get_initial_eps_bearer (cancellable, callback, *user_data)

get_initial_eps_bearer_finish (res)

get_initial_eps_bearer_settings ()

get_initial_eps_bearer_sync (cancellable)

get_nr5g_registration_settings ()

get_operator_code ()

get_operator_name ()

get_packet_service_state ()

get_path ()

get_pco ()

get_registration_state ()

get_subscription_state ()

peek_initial_eps_bearer_settings ()

peek_nr5g_registration_settings ()

register (network_id, cancellable, callback, *user_data)

register_finish (res)

register_sync (network_id, cancellable)

scan (cancellable, callback, *user_data)

scan_finish (res)

scan_sync (cancellable)

set_carrier_lock (data, cancellable, callback, *user_data)

set_carrier_lock_finish (res)

set_carrier_lock_sync (data, cancellable)

set_eps_ue_mode_operation (mode, cancellable, callback, *user_data)

set_eps_ue_mode_operation_finish (res)

set_eps_ue_mode_operation_sync (mode, cancellable)

set_initial_eps_bearer_settings (config, cancellable, callback, *user_data)

set_initial_eps_bearer_settings_finish (res)

set_initial_eps_bearer_settings_sync (config, cancellable)

set_nr5g_registration_settings (settings, cancellable, callback, *user_data)

set_nr5g_registration_settings_finish (res)

set_nr5g_registration_settings_sync (settings, cancellable)

set_packet_service_state (state, cancellable, callback, *user_data)

set_packet_service_state_finish (res)

set_packet_service_state_sync (state, cancellable)

Virtual Methods

Inherited:

Gio.DBusProxy (2), GObject.Object (7), Gio.AsyncInitable (2), Gio.DBusInterface (3), Gio.Initable (1), ModemManager.GdbusModem3gpp (8)

Properties

Inherited:

Gio.DBusProxy (9), ModemManager.GdbusModem3gpp (12)

Signals

Inherited:

Gio.DBusProxy (2), GObject.Object (1), ModemManager.GdbusModem3gpp (8)

Fields

Inherited:

Gio.DBusProxy (2), GObject.Object (1), ModemManager.GdbusModem3gpp (8)

Name

Type

Access

Description

parent

ModemManager.GdbusModem3gppProxy

r

Class Details

class ModemManager.Modem3gpp(**kwargs)
Bases:

ModemManager.GdbusModem3gppProxy

Abstract:

No

Structure:

ModemManager.Modem3gppClass

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

disable_facility_lock(facility, control_key, cancellable, callback, *user_data)
Parameters:

Asynchronously disables the modem personalization lock.

When the operation is finished, callback will be invoked in the

thread-default main loop of the thread you are calling this method from. You can then call ModemManager.Modem3gpp.disable_facility_lock_finish() to get the result of the operation.

New in version 1.20.

disable_facility_lock_finish(res)
Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.Modem3gpp.disable_facility_lock().

Raises:

GLib.Error

Returns:

True if the operation was successful, False if error is set.

Return type:

bool

Finishes an operation started with ModemManager.Modem3gpp.disable_facility_lock().

New in version 1.20.

disable_facility_lock_sync(facility, control_key, cancellable)
Parameters:
Raises:

GLib.Error

Returns:

True if the operation was successful, False if error is set.

Return type:

bool

Synchronously disables facility lock.

The calling thread is blocked until a reply is received. See ModemManager.Modem3gpp.disable_facility_lock() for the asynchronous version of this method.

New in version 1.20.

dup_imei()
Returns:

The IMEI, or None if none available. The returned value should be freed with GLib.free().

Return type:

str

Gets a copy of the IMEI, as reported by this ModemManager.Modem3gpp.

New in version 1.0.

dup_initial_eps_bearer_path()
Returns:

The DBus path of the ModemManager.Bearer, or None if none available. The returned value should be freed with GLib.free().

Return type:

str

Gets a copy of the DBus path of the initial EPS ModemManager.Bearer exposed in this ModemManager.Modem3gpp.

New in version 1.10.

dup_operator_code()
Returns:

The operator code, or None if none available. The returned value should be freed with GLib.free().

Return type:

str

Gets a copy of the code of the operator to which the mobile is currently registered.

Returned in the format "MCCMNC", where MCC is the three-digit ITU E.212 Mobile Country Code and MNC is the two- or three-digit GSM Mobile Network Code. e.g. e``”31026”`` or "310260".

New in version 1.0.

dup_operator_name()
Returns:

The operator name, or None if none available. The returned value should be freed with GLib.free().

Return type:

str

Gets a copy of the name of the operator to which the mobile is currently registered.

New in version 1.0.

dup_path()
Returns:

The DBus path of the ModemManager.Object. The returned value should be freed with GLib.free().

Return type:

str

Gets a copy of the DBus path of the ModemManager.Object object which implements this interface.

New in version 1.0.

get_enabled_facility_locks()
Returns:

A bitmask of ModemManager.Modem3gppFacility flags, specifying which facilities have locks enabled.

Return type:

ModemManager.Modem3gppFacility

Get the list of facilities for which PIN locking is enabled.

New in version 1.0.

get_eps_ue_mode_operation()
Returns:

A ModemManager.Modem3gppEpsUeModeOperation.

Return type:

ModemManager.Modem3gppEpsUeModeOperation

Get the UE mode of operation for EPS.

New in version 1.8.

get_imei()
Returns:

The IMEI, or None if none available.

Return type:

str

Gets the IMEI, as reported by this ModemManager.Modem3gpp.

The returned value is only valid until the property changes so it is only safe to use this function on the thread where self was constructed. Use ModemManager.Modem3gpp.dup_imei() if on another thread.

New in version 1.0.

get_initial_eps_bearer(cancellable, callback, *user_data)
Parameters:

Asynchronously gets the initial EPS ModemManager.Bearer object exposed by this ModemManager.Modem3gpp.

When the operation is finished, callback will be invoked in the

thread-default main loop of the thread you are calling this method from. You can then call ModemManager.Modem3gpp.get_initial_eps_bearer_finish() to get the result of the operation.

See ModemManager.Modem3gpp.get_initial_eps_bearer_sync() for the synchronous, blocking version of this method.

New in version 1.10.

get_initial_eps_bearer_finish(res)
Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.Modem3gpp.get_initial_eps_bearer().

Raises:

GLib.Error

Returns:

a ModemManager.Sim or None if error is set. The returned value should be freed with GObject.Object.unref().

Return type:

ModemManager.Bearer

Finishes an operation started with ModemManager.Modem3gpp.get_initial_eps_bearer().

New in version 1.10.

get_initial_eps_bearer_settings()
Returns:

A ModemManager.BearerProperties that must be freed with GObject.Object.unref() or None if unknown.

Return type:

ModemManager.BearerProperties

Gets a ModemManager.BearerProperties object specifying the settings configured in the device to use when attaching to the LTE network.

The values reported by self are not updated when the values in the interface change. Instead, the client is expected to call ModemManager.Modem3gpp.get_initial_eps_bearer_settings() again to get a new ModemManager.BearerProperties with the new values.

New in version 1.10.

get_initial_eps_bearer_sync(cancellable)
Parameters:

cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

a ModemManager.Bearer or None if error is set. The returned value should be freed with GObject.Object.unref().

Return type:

ModemManager.Bearer

Synchronously gets the initial EPS ModemManager.Bearer object exposed by this ModemManager.Modem3gpp.

The calling thread is blocked until a reply is received. See ModemManager.Modem3gpp.get_initial_eps_bearer() for the asynchronous version of this method.

New in version 1.10.

get_nr5g_registration_settings()
Returns:

A ModemManager.Nr5gRegistrationSettings that must be freed with GObject.Object.unref() or None if unknown.

Return type:

ModemManager.Nr5gRegistrationSettings

Gets a ModemManager.Nr5gRegistrationSettings object including the configured 5GNR registration settings.

The values reported by self are not updated when the values in the interface change. Instead, the client is expected to call ModemManager.Modem3gpp.get_nr5g_registration_settings() again to get a new ModemManager.Nr5gRegistrationSettings with the new values.

New in version 1.20.

get_operator_code()
Returns:

The operator code, or None if none available.

Return type:

str

Gets the code of the operator to which the mobile is currently registered.

Returned in the format "MCCMNC", where MCC is the three-digit ITU E.212 Mobile Country Code and MNC is the two- or three-digit GSM Mobile Network Code. e.g. e``”31026”`` or "310260".

If the MCC and MNC are not known or the mobile is not registered to a mobile network, this property will be a zero-length (blank) string.

The returned value is only valid until the property changes so it is only safe to use this function on the thread where self was constructed. Use ModemManager.Modem3gpp.dup_operator_code() if on another thread.

New in version 1.0.

get_operator_name()
Returns:

The operator name, or None if none available.

Return type:

str

Gets the name of the operator to which the mobile is currently registered.

The returned value is only valid until the property changes so it is only safe to use this function on the thread where self was constructed. Use ModemManager.Modem3gpp.dup_operator_name() if on another thread.

New in version 1.0.

get_packet_service_state()
Returns:

A ModemManager.Modem3gppPacketServiceState value, specifying the current PS attach state.

Return type:

ModemManager.Modem3gppPacketServiceState

Get the packet domain service state.

New in version 1.20.

get_path()
Returns:

The DBus path of the ModemManager.Object object.

Return type:

str

Gets the DBus path of the ModemManager.Object which implements this interface.

New in version 1.0.

get_pco()
Returns:

a list of ModemManager.Pco objects, or None if error is set. The returned value should be freed with g_list_free_full() using GObject.Object.unref() as GLib.DestroyNotify function.

Return type:

[ModemManager.Pco]

Get the list of ModemManager.Pco received from the network.

New in version 1.10.

get_registration_state()
Returns:

A ModemManager.Modem3gppRegistrationState value, specifying the current registration state.

Return type:

ModemManager.Modem3gppRegistrationState

Get the the mobile registration status as defined in 3GPP TS 27.007 section 10.1.19.

New in version 1.0.

get_subscription_state()
Returns:

A ModemManager.Modem3gppSubscriptionState value, specifying the current subscription state.

Return type:

ModemManager.Modem3gppSubscriptionState

Get the current subscription status of the account. This value is only available after the modem attempts to register with the network.

The value of this property can only be obtained with operator specific logic (e.g. processing specific PCO info), and therefore it doesn’t make sense to expose it in the ModemManager interface.

New in version 1.0.

Deprecated since version 1.10.0.: The value of this property can only be obtained with operator specific logic (e.g. processing specific PCO info), and therefore it doesn’t make sense to expose it in the ModemManager interface.

peek_initial_eps_bearer_settings()
Returns:

A ModemManager.BearerProperties. Do not free the returned value, it belongs to self.

Return type:

ModemManager.BearerProperties

Gets a ModemManager.BearerProperties object specifying the settings configured in the device to use when attaching to the LTE network.

The returned value is only valid until the property changes so it is only safe to use this function on the thread where self was constructed. Use ModemManager.Modem3gpp.get_initial_eps_bearer_settings() if on another thread.

New in version 1.10.

peek_nr5g_registration_settings()
Returns:

A ModemManager.Nr5gRegistrationSettings Do not free the returned value, it belongs to self.

Return type:

ModemManager.Nr5gRegistrationSettings

Gets a ModemManager.Nr5gRegistrationSettings object including the configured 5GNR registration settings.

The returned value is only valid until the property changes so it is only safe to use this function on the thread where self was constructed. Use ModemManager.Modem3gpp.get_nr5g_registration_settings() if on another thread.

New in version 1.20.

register(network_id, cancellable, callback, *user_data)
Parameters:

Asynchronously requests registration with a given mobile network.

When the operation is finished, callback will be invoked in the

thread-default main loop of the thread you are calling this method from. You can then call ModemManager.Modem3gpp.register_finish() to get the result of the operation.

See ModemManager.Modem3gpp.register_sync() for the synchronous, blocking version of this method.

New in version 1.0.

register_finish(res)
Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.Modem3gpp.register().

Raises:

GLib.Error

Returns:

True if the modem was registered, False if error is set.

Return type:

bool

Finishes an operation started with ModemManager.Modem3gpp.register().

New in version 1.0.

register_sync(network_id, cancellable)
Parameters:
Raises:

GLib.Error

Returns:

True if the modem was registered, False if error is set.

Return type:

bool

Synchronously requests registration with a given mobile network.

The calling thread is blocked until a reply is received. See ModemManager.Modem3gpp.register() for the asynchronous version of this method.

New in version 1.0.

scan(cancellable, callback, *user_data)
Parameters:

Asynchronously requests to scan available 3GPP networks.

When the operation is finished, callback will be invoked in the

thread-default main loop of the thread you are calling this method from. You can then call ModemManager.Modem3gpp.scan_finish() to get the result of the operation.

See ModemManager.Modem3gpp.scan_sync() for the synchronous, blocking version of this method.

New in version 1.0.

scan_finish(res)
Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.Modem3gpp.scan().

Raises:

GLib.Error

Returns:

a list of ModemManager.Modem3gppNetwork structs, or None if error is set. The returned value should be freed with g_list_free_full() using ModemManager.Modem3gppNetwork.free() as GLib.DestroyNotify function.

Return type:

[ModemManager.Modem3gppNetwork]

Finishes an operation started with ModemManager.Modem3gpp.scan().

New in version 1.0.

scan_sync(cancellable)
Parameters:

cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

a list of ModemManager.Modem3gppNetwork structs, or None if error is set. The returned value should be freed with g_list_free_full() using ModemManager.Modem3gppNetwork.free() as GLib.DestroyNotify function.

Return type:

[ModemManager.Modem3gppNetwork]

Synchronously requests to scan available 3GPP networks.

The calling thread is blocked until a reply is received. See ModemManager.Modem3gpp.scan() for the asynchronous version of this method.

New in version 1.0.

set_carrier_lock(data, cancellable, callback, *user_data)
Parameters:

Asynchronously sends the carrier lock information to the modem.

When the operation is finished, callback will be invoked in the

thread-default main loop of the thread you are calling this method from. You can then call ModemManager.ModemLocation.inject_assistance_data_finish() to get the result of the operation.

See ModemManager.Modem3gpp.set_carrier_lock_sync() for the synchronous, blocking version of this method.

New in version 1.22.

set_carrier_lock_finish(res)
Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.GdbusModem3gpp.call_set_carrier_lock().

Raises:

GLib.Error

Returns:

True if the call succeded, False if error is set.

Return type:

bool

Finishes an operation started with ModemManager.Modem3gpp.set_carrier_lock().

New in version 1.22.

set_carrier_lock_sync(data, cancellable)
Parameters:
Raises:

GLib.Error

Returns:

True if the carrier network info is successfully send, False if error is set.

Return type:

bool

Synchronously sends the carrier lock information to the modem..

The calling thread is blocked until a reply is received. See ModemManager.Modem3gpp.set_carrier_lock() for the asynchronous version of this method.

New in version 1.22.

set_eps_ue_mode_operation(mode, cancellable, callback, *user_data)
Parameters:

Asynchronously requests to update the EPS UE mode of operation.

When the operation is finished, callback will be invoked in the

thread-default main loop of the thread you are calling this method from. You can then call ModemManager.Modem3gpp.set_eps_ue_mode_operation_finish() to get the result of the operation.

See ModemManager.Modem3gpp.set_eps_ue_mode_operation_sync() for the synchronous, blocking version of this method. The calling thread is blocked until a reply is received.

New in version 1.8.

set_eps_ue_mode_operation_finish(res)
Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.Modem3gpp.set_eps_ue_mode_operation().

Raises:

GLib.Error

Returns:

True if the operation was successful, False if error is set.

Return type:

bool

Finishes an operation started with ModemManager.Modem3gpp.set_eps_ue_mode_operation().

New in version 1.8.

set_eps_ue_mode_operation_sync(mode, cancellable)
Parameters:
Raises:

GLib.Error

Returns:

True if the operation was successful, False if error is set.

Return type:

bool

Synchronously requests to update the EPS UE mode of operation.

The calling thread is blocked until a reply is received. See ModemManager.Modem3gpp.set_eps_ue_mode_operation() for the asynchronous version of this method.

New in version 1.8.

set_initial_eps_bearer_settings(config, cancellable, callback, *user_data)
Parameters:

Asynchronously configures the settings for the initial LTE default bearer.

When the operation is finished, callback will be invoked in the

thread-default main loop of the thread you are calling this method from. You can then call ModemManager.Modem3gpp.set_initial_eps_bearer_settings_finish() to get the result of the operation.

New in version 1.10.

set_initial_eps_bearer_settings_finish(res)
Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.Modem3gpp.set_initial_eps_bearer_settings().

Raises:

GLib.Error

Returns:

True if the operation was successful, False if error is set.

Return type:

bool

Finishes an operation started with ModemManager.Modem3gpp.set_initial_eps_bearer_settings().

New in version 1.10.

set_initial_eps_bearer_settings_sync(config, cancellable)
Parameters:
Raises:

GLib.Error

Returns:

True if the operation was successful, False if error is set.

Return type:

bool

Synchronously configures the settings for the initial LTE default bearer.

The calling thread is blocked until a reply is received. See ModemManager.Modem3gpp.set_initial_eps_bearer_settings() for the asynchronous version of this method.

New in version 1.10.

set_nr5g_registration_settings(settings, cancellable, callback, *user_data)
Parameters:

Asynchronously configures the 5GNR registration settings.

When the operation is finished, callback will be invoked in the

thread-default main loop of the thread you are calling this method from. You can then call ModemManager.Modem3gpp.set_nr5g_registration_settings_finish() to get the result of the operation.

See ModemManager.Modem3gpp.set_nr5g_registration_settings_sync() for the synchronous, blocking version of this method.

New in version 1.20.

set_nr5g_registration_settings_finish(res)
Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.Modem3gpp.set_nr5g_registration_settings().

Raises:

GLib.Error

Returns:

True if the operation was successful, False if error is set.

Return type:

bool

Finishes an operation started with ModemManager.Modem3gpp.set_nr5g_registration_settings().

New in version 1.20.

set_nr5g_registration_settings_sync(settings, cancellable)
Parameters:
Raises:

GLib.Error

Returns:

True if the operation was successful, False if error is set.

Return type:

bool

Synchronously configures the 5GNR registration settings.

The calling thread is blocked until a reply is received. See ModemManager.Modem3gpp.set_nr5g_registration_settings() for the asynchronous version of this method.

New in version 1.20.

set_packet_service_state(state, cancellable, callback, *user_data)
Parameters:

Asynchronously tries to attach or detach from the packet domain service.

When the operation is finished, callback will be invoked in the

thread-default main loop of the thread you are calling this method from. You can then call ModemManager.Modem3gpp.set_packet_service_state_finish() to get the result of the operation.

See ModemManager.Modem3gpp.set_packet_service_state_sync() for the synchronous, blocking version of this method.

New in version 1.20.

set_packet_service_state_finish(res)
Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.Modem3gpp.set_packet_service_state().

Raises:

GLib.Error

Returns:

True if the operation was successful, False if error is set.

Return type:

bool

Finishes an operation started with ModemManager.Modem3gpp.set_packet_service_state().

New in version 1.20.

set_packet_service_state_sync(state, cancellable)
Parameters:
Raises:

GLib.Error

Returns:

True if the operation was successful, False if error is set.

Return type:

bool

Synchronously tries to attach or detach from the packet domain service.

The calling thread is blocked until a reply is received. See ModemManager.Modem3gpp.set_packet_service_state() for the asynchronous version of this method.

New in version 1.20.