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:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
Properties¶
- Inherited:
Signals¶
Fields¶
Name |
Type |
Access |
Description |
---|---|---|---|
parent |
r |
Class Details¶
- class ModemManager.Modem3gpp(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
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:
facility (
ModemManager.Modem3gppFacility
) – Single bit value describing the modem personalization lock to disable.control_key (
str
) – String with control key required to unlock the personalization.cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.callback (
Gio.AsyncReadyCallback
orNone
) – AGio.AsyncReadyCallback
to call when the request is satisfied orNone
.
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 callModemManager.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
) – TheGio.AsyncResult
obtained from theGio.AsyncReadyCallback
passed toModemManager.Modem3gpp.disable_facility_lock
().- Raises:
- Returns:
True
if the operation was successful,False
if error is set.- Return type:
Finishes an operation started with
ModemManager.Modem3gpp.disable_facility_lock
().New in version 1.20.
- disable_facility_lock_sync(facility, control_key, cancellable)¶
- Parameters:
facility (
ModemManager.Modem3gppFacility
) – Single bit value describing the modem personalization lock to disable.control_key (
str
) – String with control key required to unlock the personalization.cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.
- Raises:
- Returns:
True
if the operation was successful,False
if error is set.- Return type:
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 withGLib.free
().- Return type:
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
, orNone
if none available. The returned value should be freed withGLib.free
().- Return type:
Gets a copy of the DBus path of the initial EPS
ModemManager.Bearer
exposed in thisModemManager.Modem3gpp
.New in version 1.10.
- dup_operator_code()¶
- Returns:
The operator code, or
None
if none available. The returned value should be freed withGLib.free
().- Return type:
Gets a copy of the code of the operator to which the mobile is currently registered.
Returned in the format
"MCCMNC"
, whereMCC
is the three-digit ITU E.212 Mobile Country Code andMNC
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 withGLib.free
().- Return type:
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 withGLib.free
().- Return type:
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:
Get the list of facilities for which PIN locking is enabled.
New in version 1.0.
- get_eps_ue_mode_operation()¶
- Returns:
- Return type:
Get the UE mode of operation for EPS.
New in version 1.8.
- get_imei()¶
-
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:
cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.callback (
Gio.AsyncReadyCallback
orNone
) – AGio.AsyncReadyCallback
to call when the request is satisfied orNone
.
Asynchronously gets the initial EPS
ModemManager.Bearer
object exposed by thisModemManager.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 callModemManager.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
) – TheGio.AsyncResult
obtained from theGio.AsyncReadyCallback
passed toModemManager.Modem3gpp.get_initial_eps_bearer
().- Raises:
- Returns:
a
ModemManager.Sim
orNone
if error is set. The returned value should be freed withGObject.Object.unref
().- Return type:
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 withGObject.Object.unref
() orNone
if unknown.- Return type:
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 newModemManager.BearerProperties
with the new values.New in version 1.10.
- get_initial_eps_bearer_sync(cancellable)¶
- Parameters:
cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.- Raises:
- Returns:
a
ModemManager.Bearer
orNone
if error is set. The returned value should be freed withGObject.Object.unref
().- Return type:
Synchronously gets the initial EPS
ModemManager.Bearer
object exposed by thisModemManager.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 withGObject.Object.unref
() orNone
if unknown.- Return type:
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 newModemManager.Nr5gRegistrationSettings
with the new values.New in version 1.20.
- get_operator_code()¶
-
Gets the code of the operator to which the mobile is currently registered.
Returned in the format
"MCCMNC"
, whereMCC
is the three-digit ITU E.212 Mobile Country Code andMNC
is the two- or three-digit GSM Mobile Network Code. e.g. e``”31026”`` or"310260"
.If the
MCC
andMNC
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()¶
-
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:
Get the packet domain service state.
New in version 1.20.
- get_path()¶
- Returns:
The DBus path of the
ModemManager.Object
object.- Return type:
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, orNone
if error is set. The returned value should be freed with g_list_free_full() usingGObject.Object.unref
() asGLib.DestroyNotify
function.- Return type:
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:
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:
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:
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:
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:
network_id (
str
) – The operator ID to register. An empty string can be used to register to the home network.cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.callback (
Gio.AsyncReadyCallback
orNone
) – AGio.AsyncReadyCallback
to call when the request is satisfied orNone
.
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 callModemManager.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
) – TheGio.AsyncResult
obtained from theGio.AsyncReadyCallback
passed toModemManager.Modem3gpp.register
().- Raises:
- Returns:
- Return type:
Finishes an operation started with
ModemManager.Modem3gpp.register
().New in version 1.0.
- register_sync(network_id, cancellable)¶
- Parameters:
network_id (
str
) – The operator ID to register. An empty string can be used to register to the home network.cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.
- Raises:
- Returns:
- Return type:
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:
cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.callback (
Gio.AsyncReadyCallback
orNone
) – AGio.AsyncReadyCallback
to call when the request is satisfied orNone
.
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 callModemManager.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
) – TheGio.AsyncResult
obtained from theGio.AsyncReadyCallback
passed toModemManager.Modem3gpp.scan
().- Raises:
- Returns:
a list of
ModemManager.Modem3gppNetwork
structs, orNone
if error is set. The returned value should be freed with g_list_free_full() usingModemManager.Modem3gppNetwork.free
() asGLib.DestroyNotify
function.- Return type:
Finishes an operation started with
ModemManager.Modem3gpp.scan
().New in version 1.0.
- scan_sync(cancellable)¶
- Parameters:
cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.- Raises:
- Returns:
a list of
ModemManager.Modem3gppNetwork
structs, orNone
if error is set. The returned value should be freed with g_list_free_full() usingModemManager.Modem3gppNetwork.free
() asGLib.DestroyNotify
function.- Return type:
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:
data (
bytes
) – Carrier lock information.cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.callback (
Gio.AsyncReadyCallback
orNone
) – AGio.AsyncReadyCallback
to call when the request is satisfied orNone
.
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 callModemManager.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
) – TheGio.AsyncResult
obtained from theGio.AsyncReadyCallback
passed toModemManager.GdbusModem3gpp.call_set_carrier_lock
().- Raises:
- Returns:
- Return type:
Finishes an operation started with
ModemManager.Modem3gpp.set_carrier_lock
().New in version 1.22.
- set_carrier_lock_sync(data, cancellable)¶
- Parameters:
data (
bytes
) – Carrier lock information.cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.
- Raises:
- Returns:
True
if the carrier network info is successfully send,False
if error is set.- Return type:
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:
mode (
ModemManager.Modem3gppEpsUeModeOperation
) – AModemManager.Modem3gppEpsUeModeOperation
.cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.callback (
Gio.AsyncReadyCallback
orNone
) – AGio.AsyncReadyCallback
to call when the request is satisfied orNone
.
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 callModemManager.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
) – TheGio.AsyncResult
obtained from theGio.AsyncReadyCallback
passed toModemManager.Modem3gpp.set_eps_ue_mode_operation
().- Raises:
- Returns:
True
if the operation was successful,False
if error is set.- Return type:
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:
mode (
ModemManager.Modem3gppEpsUeModeOperation
) – AModemManager.Modem3gppEpsUeModeOperation
.cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.
- Raises:
- Returns:
True
if the operation was successful,False
if error is set.- Return type:
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:
config (
ModemManager.BearerProperties
) – AModemManager.BearerProperties
object with the properties to use.cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.callback (
Gio.AsyncReadyCallback
orNone
) – AGio.AsyncReadyCallback
to call when the request is satisfied orNone
.
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 callModemManager.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
) – TheGio.AsyncResult
obtained from theGio.AsyncReadyCallback
passed toModemManager.Modem3gpp.set_initial_eps_bearer_settings
().- Raises:
- Returns:
True
if the operation was successful,False
if error is set.- Return type:
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:
config (
ModemManager.BearerProperties
) – AModemManager.BearerProperties
object with the properties to use.cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.
- Raises:
- Returns:
True
if the operation was successful,False
if error is set.- Return type:
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:
settings (
ModemManager.Nr5gRegistrationSettings
) – AModemManager.Nr5gRegistrationSettings
.cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.callback (
Gio.AsyncReadyCallback
orNone
) – AGio.AsyncReadyCallback
to call when the request is satisfied orNone
.
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 callModemManager.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
) – TheGio.AsyncResult
obtained from theGio.AsyncReadyCallback
passed toModemManager.Modem3gpp.set_nr5g_registration_settings
().- Raises:
- Returns:
True
if the operation was successful,False
if error is set.- Return type:
Finishes an operation started with
ModemManager.Modem3gpp.set_nr5g_registration_settings
().New in version 1.20.
- set_nr5g_registration_settings_sync(settings, cancellable)¶
- Parameters:
settings (
ModemManager.Nr5gRegistrationSettings
) – AModemManager.Nr5gRegistrationSettings
.cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.
- Raises:
- Returns:
True
if the operation was successful,False
if error is set.- Return type:
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:
state (
ModemManager.Modem3gppPacketServiceState
) – AModemManager.Modem3gppPacketServiceState
.cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.callback (
Gio.AsyncReadyCallback
orNone
) – AGio.AsyncReadyCallback
to call when the request is satisfied orNone
.
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 callModemManager.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
) – TheGio.AsyncResult
obtained from theGio.AsyncReadyCallback
passed toModemManager.Modem3gpp.set_packet_service_state
().- Raises:
- Returns:
True
if the operation was successful,False
if error is set.- Return type:
Finishes an operation started with
ModemManager.Modem3gpp.set_packet_service_state
().New in version 1.20.
- set_packet_service_state_sync(state, cancellable)¶
- Parameters:
state (
ModemManager.Modem3gppPacketServiceState
) – AModemManager.Modem3gppPacketServiceState
.cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.
- Raises:
- Returns:
True
if the operation was successful,False
if error is set.- Return type:
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.