Mbim.Message¶
Fields¶
None
Methods¶
Details¶
- class Mbim.Message¶
An opaque type representing a MBIM message.
New in version 1.0.
- classmethod atds_location_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Location’ query command in the ‘ATDS’ service.
New in version 1.16.
- classmethod atds_operators_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Operators’ query command in the ‘ATDS’ service.
New in version 1.16.
- classmethod atds_rat_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘RAT’ query command in the ‘ATDS’ service.
New in version 1.16.
- classmethod atds_rat_set_new(mode)¶
- Parameters:
mode (
Mbim.AtdsRatMode
) – the ‘Mode’ field, given as aMbim.AtdsRatMode
.- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘RAT’ set command in the ‘ATDS’ service.
New in version 1.16.
- classmethod atds_register_state_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Register State’ query command in the ‘ATDS’ service.
New in version 1.16.
- classmethod atds_signal_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Signal’ query command in the ‘ATDS’ service.
New in version 1.16.
- classmethod auth_aka_query_new(rand, autn)¶
- Parameters:
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Aka’ query command in the ‘Auth’ service.
New in version 1.4.
- classmethod auth_akap_query_new(rand, autn, network_name)¶
- Parameters:
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Akap’ query command in the ‘Auth’ service.
New in version 1.4.
- classmethod auth_sim_query_new(rand1, rand2, rand3, n)¶
- Parameters:
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Sim’ query command in the ‘Auth’ service.
New in version 1.4.
- classmethod close_done_new(transaction_id, error_status_code)¶
- Parameters:
transaction_id (
int
) – transaction ID.error_status_code (
Mbim.StatusError
) – aMbim.StatusError
.
- Returns:
a newly created
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new
Mbim.Message
of typeMbim.MessageType.CLOSE_DONE
with the specified parameters.New in version 1.10.
- classmethod close_new(transaction_id)¶
- Parameters:
transaction_id (
int
) – transaction ID.- Returns:
a newly created
Mbim.Message
. The returned value should be freed withMbim.Message.unref
().- Return type:
Create a new
Mbim.Message
of typeMbim.MessageType.CLOSE
with the specified parameters.New in version 1.0.
- classmethod command_new(transaction_id, service, cid, command_type)¶
- Parameters:
transaction_id (
int
) – transaction ID.service (
Mbim.Service
) – aMbim.Service
.cid (
int
) – the command ID.command_type (
Mbim.MessageCommandType
) – the command type.
- Returns:
a newly created
Mbim.Message
. The returned value should be freed withMbim.Message.unref
().- Return type:
Create a new
Mbim.Message
of typeMbim.MessageType.COMMAND
with the specified parameters and an empty information buffer.New in version 1.0.
- classmethod connect_query_new(session_id, activation_state, voice_call_state, ip_type, context_type, nw_error)¶
- Parameters:
session_id (
int
) – the ‘SessionId’ field, given as a #guint32.activation_state (
Mbim.ActivationState
) – the ‘ActivationState’ field, given as aMbim.ActivationState
.voice_call_state (
Mbim.VoiceCallState
) – the ‘VoiceCallState’ field, given as aMbim.VoiceCallState
.ip_type (
Mbim.ContextIpType
) – the ‘IpType’ field, given as aMbim.ContextIpType
.context_type (
Mbim.Uuid
) – the ‘ContextType’ field, given as aMbim.Uuid
.nw_error (
int
) – the ‘NwError’ field, given as a #guint32.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Connect’ query command in the ‘Basic Connect’ service.
New in version 1.0.
- classmethod connect_set_new(session_id, activation_command, access_string, user_name, password, compression, auth_protocol, ip_type, context_type)¶
- Parameters:
session_id (
int
) – the ‘SessionId’ field, given as a #guint32.activation_command (
Mbim.ActivationCommand
) – the ‘ActivationCommand’ field, given as aMbim.ActivationCommand
.access_string (
str
) – the ‘AccessString’ field, given as a string.user_name (
str
) – the ‘UserName’ field, given as a string.password (
str
) – the ‘Password’ field, given as a string.compression (
Mbim.Compression
) – the ‘Compression’ field, given as aMbim.Compression
.auth_protocol (
Mbim.AuthProtocol
) – the ‘AuthProtocol’ field, given as aMbim.AuthProtocol
.ip_type (
Mbim.ContextIpType
) – the ‘IpType’ field, given as aMbim.ContextIpType
.context_type (
Mbim.Uuid
) – the ‘ContextType’ field, given as aMbim.Uuid
.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Connect’ set command in the ‘Basic Connect’ service.
New in version 1.0.
- classmethod device_caps_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Device Caps’ query command in the ‘Basic Connect’ service.
New in version 1.0.
- classmethod device_service_subscribe_list_set_new(events_count, events)¶
- Parameters:
events_count (
int
) – the ‘EventsCount’ field, given as a #guint32.events ([
Mbim.EventEntry
]) – the ‘Events’ field, given as an array ofMbim.EventEntry
items.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Device Service Subscribe List’ set command in the ‘Basic Connect’ service.
New in version 1.8.
- classmethod device_service_subscriber_list_set_new(events_count, events)¶
- Parameters:
events_count (
int
) – the ‘EventsCount’ field, given as a #guint32.events (
Mbim.EventEntry
) – the ‘Events’ field, given as an array ofMbim.EventEntrys
.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Device Service Subscribe List’ set command in the ‘Basic Connect’ service.
New in version 1.0.
Deprecated since version 1.8: Use
Mbim.Message.device_service_subscribe_list_set_new
() instead.
- classmethod device_services_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Device Services’ query command in the ‘Basic Connect’ service.
New in version 1.0.
- classmethod dss_connect_set_new(device_service_id, dss_session_id, dss_link_state)¶
- Parameters:
device_service_id (
Mbim.Uuid
) – the ‘DeviceServiceId’ field, given as aMbim.Uuid
.dss_session_id (
int
) – the ‘DssSessionId’ field, given as a #guint32.dss_link_state (
Mbim.DssLinkState
) – the ‘DssLinkState’ field, given as aMbim.DssLinkState
.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Connect’ set command in the ‘DSS’ service.
New in version 1.4.
- classmethod emergency_mode_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Emergency Mode’ query command in the ‘Basic Connect’ service.
New in version 1.4.
- classmethod emergency_mode_set_new(state)¶
- Parameters:
state (
Mbim.EmergencyModeState
) – the ‘State’ field, given as aMbim.EmergencyModeState
.- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Emergency Mode’ set command in the ‘Basic Connect’ service.
New in version 1.4.
- classmethod error_new(transaction_id, error_status_code)¶
- Parameters:
transaction_id (
int
) – transaction ID.error_status_code (
Mbim.ProtocolError
) – aMbim.ProtocolError
.
- Returns:
a newly created
Mbim.Message
. The returned value should be freed withMbim.Message.unref
().- Return type:
Create a new
Mbim.Message
of typeMbim.MessageType.HOST_ERROR
with the specified parameters.New in version 1.0.
- classmethod function_error_new(transaction_id, error_status_code)¶
- Parameters:
transaction_id (
int
) – transaction ID.error_status_code (
Mbim.ProtocolError
) – aMbim.ProtocolError
.
- Returns:
a newly created
Mbim.Message
. The returned value should be freed withMbim.Message.unref
().- Return type:
Create a new
Mbim.Message
of typeMbim.MessageType.FUNCTION_ERROR
with the specified parameters.New in version 1.12.
- classmethod google_carrier_lock_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Carrier Lock’ query command in the ‘Google’ service.
New in version 1.30.
- classmethod google_carrier_lock_set_new(data)¶
- Parameters:
data (
bytes
) – the ‘Data’ field, given as an array of #guint8 values.- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Carrier Lock’ set command in the ‘Google’ service.
New in version 1.30.
- classmethod home_provider_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Home Provider’ query command in the ‘Basic Connect’ service.
New in version 1.2.
- classmethod home_provider_set_new(provider)¶
- Parameters:
provider (
Mbim.Provider
) – the ‘Provider’ field, given as aMbim.Provider
.- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Home Provider’ set command in the ‘Basic Connect’ service.
New in version 1.2.
- classmethod intel_firmware_update_modem_reboot_set_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Modem Reboot’ set command in the ‘Intel Firmware Update’ service.
New in version 1.16.
- classmethod intel_firmware_update_v2_modem_reboot_set_new(boot_mode, timeout)¶
- Parameters:
boot_mode (
Mbim.IntelBootMode
) – the ‘BootMode’ field, given as aMbim.IntelBootMode
.timeout (
int
) – the ‘Timeout’ field, given as a #guint32.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Modem Reboot’ set command in the ‘Intel Firmware Update V2’ service.
New in version 1.28.
- classmethod intel_mutual_authentication_fcc_lock_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘FCC Lock’ query command in the ‘Intel Mutual Authentication’ service.
New in version 1.30.
- classmethod intel_mutual_authentication_fcc_lock_set_new(response_present, response)¶
- Parameters:
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘FCC Lock’ set command in the ‘Intel Mutual Authentication’ service.
New in version 1.30.
- classmethod intel_thermal_rf_rfim_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘RFIM’ query command in the ‘Intel Thermal RF’ service.
New in version 1.28.
- classmethod intel_thermal_rf_rfim_set_new(activation_state)¶
- Parameters:
activation_state (
bool
) – the ‘ActivationState’ field, given as abool
.- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘RFIM’ set command in the ‘Intel Thermal RF’ service.
New in version 1.28.
- classmethod intel_tools_trace_config_query_new(trace_cmd)¶
- Parameters:
trace_cmd (
Mbim.TraceCommand
) – the ‘TraceCmd’ field, given as aMbim.TraceCommand
.- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Trace Config’ query command in the ‘Intel Tools’ service.
New in version 1.30.
- classmethod intel_tools_trace_config_set_new(trace_cmd, trace_value)¶
- Parameters:
trace_cmd (
Mbim.TraceCommand
) – the ‘TraceCmd’ field, given as aMbim.TraceCommand
.trace_value (
int
) – the ‘TraceValue’ field, given as a #guint32.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Trace Config’ set command in the ‘Intel Tools’ service.
New in version 1.30.
- classmethod ip_configuration_query_new(session_id, ipv4_configuration_available, ipv6_configuration_available, ipv4_address_count, ipv4_address, ipv6_address_count, ipv6_address, ipv4_gateway, ipv6_gateway, ipv4_dns_server_count, ipv4_dns_server, ipv6_dns_server_count, ipv6_dns_server, ipv4_mtu, ipv6_mtu)¶
- Parameters:
session_id (
int
) – the ‘SessionId’ field, given as a #guint32.ipv4_configuration_available (
Mbim.IPConfigurationAvailableFlag
) – the ‘IPv4ConfigurationAvailable’ field, given as aMbim.IPConfigurationAvailableFlag
.ipv6_configuration_available (
Mbim.IPConfigurationAvailableFlag
) – the ‘IPv6ConfigurationAvailable’ field, given as aMbim.IPConfigurationAvailableFlag
.ipv4_address_count (
int
) – the ‘IPv4AddressCount’ field, given as a #guint32.ipv4_address ([
Mbim.IPv4Element
]) – the ‘IPv4Address’ field, given as an array ofMbim.IPv4Element
items.ipv6_address_count (
int
) – the ‘IPv6AddressCount’ field, given as a #guint32.ipv6_address ([
Mbim.IPv6Element
]) – the ‘IPv6Address’ field, given as an array ofMbim.IPv6Element
items.ipv4_gateway (
Mbim.IPv4
) – the ‘IPv4Gateway’ field, given as aMbim.IPv4
.ipv6_gateway (
Mbim.IPv6
) – the ‘IPv6Gateway’ field, given as aMbim.IPv6
.ipv4_dns_server_count (
int
) – the ‘IPv4DnsServerCount’ field, given as a #guint32.ipv4_dns_server ([
Mbim.IPv4
]) – the ‘IPv4DnsServer’ field, given as an array ofMbim.IPv4
items.ipv6_dns_server_count (
int
) – the ‘IPv6DnsServerCount’ field, given as a #guint32.ipv6_dns_server ([
Mbim.IPv6
]) – the ‘IPv6DnsServer’ field, given as an array ofMbim.IPv6
items.ipv4_mtu (
int
) – the ‘IPv4Mtu’ field, given as a #guint32.ipv6_mtu (
int
) – the ‘IPv6Mtu’ field, given as a #guint32.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘IP Configuration’ query command in the ‘Basic Connect’ service.
New in version 1.0.
- classmethod ip_packet_filters_query_new(session_id, packet_filters_count, packet_filters)¶
- Parameters:
session_id (
int
) – the ‘SessionId’ field, given as a #guint32.packet_filters_count (
int
) – the ‘PacketFiltersCount’ field, given as a #guint32.packet_filters ([
Mbim.PacketFilter
]) – the ‘PacketFilters’ field, given as an array ofMbim.PacketFilter
items.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘IP Packet Filters’ query command in the ‘Basic Connect’ service.
New in version 1.4.
- classmethod ip_packet_filters_set_new(session_id, packet_filters_count, packet_filters)¶
- Parameters:
session_id (
int
) – the ‘SessionId’ field, given as a #guint32.packet_filters_count (
int
) – the ‘PacketFiltersCount’ field, given as a #guint32.packet_filters ([
Mbim.PacketFilter
]) – the ‘PacketFilters’ field, given as an array ofMbim.PacketFilter
items.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘IP Packet Filters’ set command in the ‘Basic Connect’ service.
New in version 1.4.
- classmethod ms_basic_connect_extensions_base_stations_info_query_new(max_gsm_count, max_umts_count, max_tdscdma_count, max_lte_count, max_cdma_count)¶
- Parameters:
max_gsm_count (
int
) – the ‘MaxGsmCount’ field, given as a #guint32.max_umts_count (
int
) – the ‘MaxUmtsCount’ field, given as a #guint32.max_tdscdma_count (
int
) – the ‘MaxTdscdmaCount’ field, given as a #guint32.max_lte_count (
int
) – the ‘MaxLteCount’ field, given as a #guint32.max_cdma_count (
int
) – the ‘MaxCdmaCount’ field, given as a #guint32.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Base Stations Info’ query command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.28.
- classmethod ms_basic_connect_extensions_device_caps_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Device Caps’ query command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.26.
- classmethod ms_basic_connect_extensions_device_reset_set_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Device Reset’ set command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.30.
- classmethod ms_basic_connect_extensions_device_slot_mappings_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Device Slot Mappings’ query command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.26.
- classmethod ms_basic_connect_extensions_device_slot_mappings_set_new(map_count, slot_map)¶
- Parameters:
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Device Slot Mappings’ set command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.26.
- classmethod ms_basic_connect_extensions_location_info_status_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Location Info Status’ query command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.28.
- classmethod ms_basic_connect_extensions_lte_attach_configuration_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Lte Attach Configuration’ query command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.18.
- classmethod ms_basic_connect_extensions_lte_attach_configuration_set_new(operation, configuration_count, configurations)¶
- Parameters:
operation (
Mbim.LteAttachContextOperation
) – the ‘Operation’ field, given as aMbim.LteAttachContextOperation
.configuration_count (
int
) – the ‘ConfigurationCount’ field, given as a #guint32.configurations ([
Mbim.LteAttachConfiguration
]) – the ‘Configurations’ field, given as an array ofMbim.LteAttachConfiguration
items.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Lte Attach Configuration’ set command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.18.
- classmethod ms_basic_connect_extensions_lte_attach_info_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Lte Attach Info’ query command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.26.
- classmethod ms_basic_connect_extensions_lte_attach_status_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Lte Attach Status’ query command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.18.
Deprecated since version 1.26: Use
Mbim.Message.ms_basic_connect_extensions_lte_attach_info_query_new
() instead.
- classmethod ms_basic_connect_extensions_pco_query_new(pco_value)¶
- Parameters:
pco_value (
Mbim.PcoValue
) – the ‘PcoValue’ field, given as aMbim.PcoValue
.- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘PCO’ query command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.18.
- classmethod ms_basic_connect_extensions_provisioned_contexts_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Provisioned Contexts’ query command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.28.
- classmethod ms_basic_connect_extensions_provisioned_contexts_set_new(operation, context_type, ip_type, state, roaming, media_type, source, access_string, user_name, password, compression, auth_protocol)¶
- Parameters:
operation (
Mbim.ContextOperation
) – the ‘Operation’ field, given as aMbim.ContextOperation
.context_type (
Mbim.Uuid
) – the ‘ContextType’ field, given as aMbim.Uuid
.ip_type (
Mbim.ContextIpType
) – the ‘IpType’ field, given as aMbim.ContextIpType
.state (
Mbim.ContextState
) – the ‘State’ field, given as aMbim.ContextState
.roaming (
Mbim.ContextRoamingControl
) – the ‘Roaming’ field, given as aMbim.ContextRoamingControl
.media_type (
Mbim.ContextMediaType
) – the ‘MediaType’ field, given as aMbim.ContextMediaType
.source (
Mbim.ContextSource
) – the ‘Source’ field, given as aMbim.ContextSource
.access_string (
str
) – the ‘AccessString’ field, given as a string.user_name (
str
) – the ‘UserName’ field, given as a string.password (
str
) – the ‘Password’ field, given as a string.compression (
Mbim.Compression
) – the ‘Compression’ field, given as aMbim.Compression
.auth_protocol (
Mbim.AuthProtocol
) – the ‘AuthProtocol’ field, given as aMbim.AuthProtocol
.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Provisioned Contexts’ set command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.28.
- classmethod ms_basic_connect_extensions_slot_info_status_query_new(slot_index)¶
- Parameters:
slot_index (
int
) – the ‘SlotIndex’ field, given as a #guint32.- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Slot Info Status’ query command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.26.
- classmethod ms_basic_connect_extensions_sys_caps_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Sys Caps’ query command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.26.
- classmethod ms_basic_connect_extensions_v2_version_query_new(mbim_version, mbim_extended_version)¶
- Parameters:
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Version’ query command in the ‘Ms Basic Connect Extensions V2’ service.
New in version 1.28.
- classmethod ms_basic_connect_extensions_v3_base_stations_info_query_new(max_gsm_count, max_umts_count, max_tdscdma_count, max_lte_count, max_cdma_count, max_nr_count)¶
- Parameters:
max_gsm_count (
int
) – the ‘MaxGsmCount’ field, given as a #guint32.max_umts_count (
int
) – the ‘MaxUmtsCount’ field, given as a #guint32.max_tdscdma_count (
int
) – the ‘MaxTdscdmaCount’ field, given as a #guint32.max_lte_count (
int
) – the ‘MaxLteCount’ field, given as a #guint32.max_cdma_count (
int
) – the ‘MaxCdmaCount’ field, given as a #guint32.max_nr_count (
int
) – the ‘MaxNrCount’ field, given as a #guint32.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Base Stations Info’ query command in the ‘Ms Basic Connect Extensions V3’ service.
New in version 1.28.
- classmethod ms_basic_connect_extensions_v3_modem_configuration_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Modem Configuration’ query command in the ‘Ms Basic Connect Extensions V3’ service.
New in version 1.28.
- classmethod ms_basic_connect_extensions_v3_registration_parameters_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Registration Parameters’ query command in the ‘Ms Basic Connect Extensions V3’ service.
New in version 1.28.
- classmethod ms_basic_connect_extensions_v3_registration_parameters_set_new(mico_mode, drx_cycle, ladn_info, default_pdu_activation_hint, re_register_if_nedeed, unnamed_ies)¶
- Parameters:
mico_mode (
Mbim.MicoMode
) – the ‘MicoMode’ field, given as aMbim.MicoMode
.drx_cycle (
Mbim.DrxCycle
) – the ‘DrxCycle’ field, given as aMbim.DrxCycle
.ladn_info (
Mbim.LadnInfo
) – the ‘LadnInfo’ field, given as aMbim.LadnInfo
.default_pdu_activation_hint (
Mbim.DefaultPduActivationHint
) – the ‘DefaultPduActivationHint’ field, given as aMbim.DefaultPduActivationHint
.re_register_if_nedeed (
bool
) – the ‘ReRegisterIfNedeed’ field, given as abool
.unnamed_ies ([
Mbim.Tlv
]) – the ‘UnnamedIes’ field, given as a list of # items.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Registration Parameters’ set command in the ‘Ms Basic Connect Extensions V3’ service.
New in version 1.28.
- classmethod ms_basic_connect_extensions_v3_wake_reason_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Wake Reason’ query command in the ‘Ms Basic Connect Extensions V3’ service.
New in version 1.28.
- classmethod ms_basic_connect_v3_connect_query_new(session_id)¶
- Parameters:
session_id (
int
) – the ‘SessionId’ field, given as a #guint32.- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Connect’ query command in the ‘Ms Basic Connect V3’ service.
New in version 1.28.
- classmethod ms_basic_connect_v3_connect_set_new(session_id, activation_command, compression, auth_protocol, ip_type, context_type, media_preference, access_string, user_name, password, unnamed_ies)¶
- Parameters:
session_id (
int
) – the ‘SessionId’ field, given as a #guint32.activation_command (
Mbim.ActivationCommand
) – the ‘ActivationCommand’ field, given as aMbim.ActivationCommand
.compression (
Mbim.Compression
) – the ‘Compression’ field, given as aMbim.Compression
.auth_protocol (
Mbim.AuthProtocol
) – the ‘AuthProtocol’ field, given as aMbim.AuthProtocol
.ip_type (
Mbim.ContextIpType
) – the ‘IpType’ field, given as aMbim.ContextIpType
.context_type (
Mbim.Uuid
) – the ‘ContextType’ field, given as aMbim.Uuid
.media_preference (
Mbim.AccessMediaType
) – the ‘MediaPreference’ field, given as aMbim.AccessMediaType
.access_string (
str
) – the ‘AccessString’ field, given as a string.user_name (
str
) – the ‘UserName’ field, given as a string.password (
str
) – the ‘Password’ field, given as a string.unnamed_ies ([
Mbim.Tlv
]) – the ‘UnnamedIes’ field, given as a list of # items.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Connect’ set command in the ‘Ms Basic Connect V3’ service.
New in version 1.28.
- classmethod ms_basic_connect_v3_ip_packet_filters_query_new(session_id, packet_filters_count, packet_filters)¶
- Parameters:
session_id (
int
) – the ‘SessionId’ field, given as a #guint32.packet_filters_count (
int
) – the ‘PacketFiltersCount’ field, given as a #guint32.packet_filters ([
Mbim.PacketFilterV3
]) – the ‘PacketFilters’ field, given as an array ofMbim.PacketFilterV3
items.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘IP Packet Filters’ query command in the ‘Ms Basic Connect V3’ service.
New in version 1.28.
- classmethod ms_basic_connect_v3_ip_packet_filters_set_new(session_id, packet_filters_count, packet_filters)¶
- Parameters:
session_id (
int
) – the ‘SessionId’ field, given as a #guint32.packet_filters_count (
int
) – the ‘PacketFiltersCount’ field, given as a #guint32.packet_filters ([
Mbim.PacketFilterV3
]) – the ‘PacketFilters’ field, given as an array ofMbim.PacketFilterV3
items.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘IP Packet Filters’ set command in the ‘Ms Basic Connect V3’ service.
New in version 1.28.
- classmethod ms_firmware_id_get_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Get’ query command in the ‘MS Firmware ID’ service.
New in version 1.8.
- classmethod ms_host_shutdown_notify_set_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Notify’ set command in the ‘MS Host Shutdown’ service.
New in version 1.8.
- classmethod ms_sar_config_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Config’ query command in the ‘MS SAR’ service.
New in version 1.26.
- classmethod ms_sar_config_set_new(mode, backoff_state, config_states_count, config_states)¶
- Parameters:
mode (
Mbim.SarControlMode
) – the ‘Mode’ field, given as aMbim.SarControlMode
.backoff_state (
Mbim.SarBackoffState
) – the ‘BackoffState’ field, given as aMbim.SarBackoffState
.config_states_count (
int
) – the ‘ConfigStatesCount’ field, given as a #guint32.config_states ([
Mbim.SarConfigState
]) – the ‘ConfigStates’ field, given as an array ofMbim.SarConfigState
items.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Config’ set command in the ‘MS SAR’ service.
New in version 1.26.
- classmethod ms_sar_transmission_status_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Transmission status’ query command in the ‘MS SAR’ service.
New in version 1.26.
- classmethod ms_sar_transmission_status_set_new(channel_notification, hysteresis_timer)¶
- Parameters:
channel_notification (
Mbim.TransmissionNotificationStatus
) – the ‘ChannelNotification’ field, given as aMbim.TransmissionNotificationStatus
.hysteresis_timer (
int
) – the ‘HysteresisTimer’ field, given as a #guint32.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Transmission status’ set command in the ‘MS SAR’ service.
New in version 1.26.
- classmethod ms_uicc_low_level_access_apdu_set_new(channel, secure_messaging, class_byte_type, command)¶
- Parameters:
channel (
int
) – the ‘Channel’ field, given as a #guint32.secure_messaging (
Mbim.UiccSecureMessaging
) – the ‘SecureMessaging’ field, given as aMbim.UiccSecureMessaging
.class_byte_type (
Mbim.UiccClassByteType
) – the ‘ClassByteType’ field, given as aMbim.UiccClassByteType
.command (
bytes
) – the ‘Command’ field, given as an array of #guint8 values.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘APDU’ set command in the ‘MS UICC Low Level Access’ service.
New in version 1.26.
- classmethod ms_uicc_low_level_access_application_list_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Application List’ query command in the ‘MS UICC Low Level Access’ service.
New in version 1.28.
- classmethod ms_uicc_low_level_access_atr_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘ATR’ query command in the ‘MS UICC Low Level Access’ service.
New in version 1.26.
- classmethod ms_uicc_low_level_access_close_channel_set_new(channel, channel_group)¶
- Parameters:
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Close Channel’ set command in the ‘MS UICC Low Level Access’ service.
New in version 1.26.
- classmethod ms_uicc_low_level_access_file_status_query_new(version, application_id, file_path)¶
- Parameters:
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘File Status’ query command in the ‘MS UICC Low Level Access’ service.
New in version 1.28.
- classmethod ms_uicc_low_level_access_open_channel_set_new(app_id, select_p2_arg, channel_group)¶
- Parameters:
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Open Channel’ set command in the ‘MS UICC Low Level Access’ service.
New in version 1.26.
- classmethod ms_uicc_low_level_access_read_binary_query_new(version, application_id, file_path, read_offset, read_size, local_pin, data)¶
- Parameters:
version (
int
) – the ‘Version’ field, given as a #guint32.application_id (
bytes
) – the ‘ApplicationId’ field, given as an array of #guint8 values.file_path (
bytes
) – the ‘FilePath’ field, given as an array of #guint8 values.read_offset (
int
) – the ‘ReadOffset’ field, given as a #guint32.read_size (
int
) – the ‘ReadSize’ field, given as a #guint32.local_pin (
str
) – the ‘LocalPin’ field, given as a string.data (
bytes
) – the ‘Data’ field, given as an array of #guint8 values.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Read Binary’ query command in the ‘MS UICC Low Level Access’ service.
New in version 1.28.
- classmethod ms_uicc_low_level_access_read_record_query_new(version, application_id, file_path, record_number, local_pin, data)¶
- Parameters:
version (
int
) – the ‘Version’ field, given as a #guint32.application_id (
bytes
) – the ‘ApplicationId’ field, given as an array of #guint8 values.file_path (
bytes
) – the ‘FilePath’ field, given as an array of #guint8 values.record_number (
int
) – the ‘RecordNumber’ field, given as a #guint32.local_pin (
str
) – the ‘LocalPin’ field, given as a string.data (
bytes
) – the ‘Data’ field, given as an array of #guint8 values.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Read Record’ query command in the ‘MS UICC Low Level Access’ service.
New in version 1.28.
- classmethod ms_uicc_low_level_access_reset_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Reset’ query command in the ‘MS UICC Low Level Access’ service.
New in version 1.26.
- classmethod ms_uicc_low_level_access_reset_set_new(pass_through_action)¶
- Parameters:
pass_through_action (
Mbim.UiccPassThroughAction
) – the ‘PassThroughAction’ field, given as aMbim.UiccPassThroughAction
.- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Reset’ set command in the ‘MS UICC Low Level Access’ service.
New in version 1.26.
- classmethod ms_uicc_low_level_access_terminal_capability_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Terminal Capability’ query command in the ‘MS UICC Low Level Access’ service.
New in version 1.26.
- classmethod ms_uicc_low_level_access_terminal_capability_set_new(terminal_capability_count, terminal_capability)¶
- Parameters:
terminal_capability_count (
int
) – the ‘TerminalCapabilityCount’ field, given as a #guint32.terminal_capability ([
Mbim.TerminalCapabilityInfo
]) – the ‘TerminalCapability’ field, given as an array ofMbim.TerminalCapabilityInfo
items.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Terminal Capability’ set command in the ‘MS UICC Low Level Access’ service.
New in version 1.26.
- classmethod ms_voice_extensions_nitz_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘NITZ’ query command in the ‘MS Voice Extensions’ service.
New in version 1.28.
- classmethod multicarrier_providers_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Multicarrier Providers’ query command in the ‘Basic Connect’ service.
New in version 1.4.
- classmethod multicarrier_providers_set_new(providers_count, providers)¶
- Parameters:
providers_count (
int
) – the ‘ProvidersCount’ field, given as a #guint32.providers ([
Mbim.Provider
]) – the ‘Providers’ field, given as an array ofMbim.Provider
items.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Multicarrier Providers’ set command in the ‘Basic Connect’ service.
New in version 1.4.
- classmethod network_idle_hint_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Network Idle Hint’ query command in the ‘Basic Connect’ service.
New in version 1.4.
- classmethod network_idle_hint_set_new(state)¶
- Parameters:
state (
Mbim.NetworkIdleHintState
) – the ‘State’ field, given as aMbim.NetworkIdleHintState
.- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Network Idle Hint’ set command in the ‘Basic Connect’ service.
New in version 1.4.
- classmethod new(data, data_length)¶
- Parameters:
- Returns:
a newly created
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a
Mbim.Message
with the given contents.New in version 1.0.
- classmethod open_done_new(transaction_id, error_status_code)¶
- Parameters:
transaction_id (
int
) – transaction ID.error_status_code (
Mbim.StatusError
) – aMbim.StatusError
.
- Returns:
a newly created
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new
Mbim.Message
of typeMbim.MessageType.OPEN_DONE
with the specified parameters.New in version 1.10.
- classmethod open_new(transaction_id, max_control_transfer)¶
- Parameters:
- Returns:
a newly created
Mbim.Message
. The returned value should be freed withMbim.Message.unref
().- Return type:
Create a new
Mbim.Message
of typeMbim.MessageType.OPEN
with the specified parameters.New in version 1.0.
- classmethod packet_service_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Packet Service’ query command in the ‘Basic Connect’ service.
New in version 1.0.
- classmethod packet_service_set_new(packet_service_action)¶
- Parameters:
packet_service_action (
Mbim.PacketServiceAction
) – the ‘PacketServiceAction’ field, given as aMbim.PacketServiceAction
.- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Packet Service’ set command in the ‘Basic Connect’ service.
New in version 1.0.
- classmethod packet_statistics_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Packet Statistics’ query command in the ‘Basic Connect’ service.
New in version 1.4.
- classmethod phonebook_configuration_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Configuration’ query command in the ‘Phonebook’ service.
New in version 1.4.
- classmethod phonebook_delete_set_new(filter_flag, filter_message_index)¶
- Parameters:
filter_flag (
Mbim.PhonebookFlag
) – the ‘FilterFlag’ field, given as aMbim.PhonebookFlag
.filter_message_index (
int
) – the ‘FilterMessageIndex’ field, given as a #guint32.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Delete’ set command in the ‘Phonebook’ service.
New in version 1.4.
- classmethod phonebook_read_query_new(filter_flag, filter_message_index)¶
- Parameters:
filter_flag (
Mbim.PhonebookFlag
) – the ‘FilterFlag’ field, given as aMbim.PhonebookFlag
.filter_message_index (
int
) – the ‘FilterMessageIndex’ field, given as a #guint32.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Read’ query command in the ‘Phonebook’ service.
New in version 1.4.
- classmethod phonebook_write_set_new(save_flag, save_index, number, name)¶
- Parameters:
save_flag (
Mbim.PhonebookWriteFlag
) – the ‘SaveFlag’ field, given as aMbim.PhonebookWriteFlag
.save_index (
int
) – the ‘SaveIndex’ field, given as a #guint32.number (
str
) – the ‘Number’ field, given as a string.name (
str
) – the ‘Name’ field, given as a string.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Write’ set command in the ‘Phonebook’ service.
New in version 1.4.
- classmethod pin_list_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Pin List’ query command in the ‘Basic Connect’ service.
New in version 1.0.
- classmethod pin_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Pin’ query command in the ‘Basic Connect’ service.
New in version 1.0.
- classmethod pin_set_new(pin_type, pin_operation, pin, new_pin)¶
- Parameters:
pin_type (
Mbim.PinType
) – the ‘PinType’ field, given as aMbim.PinType
.pin_operation (
Mbim.PinOperation
) – the ‘PinOperation’ field, given as aMbim.PinOperation
.pin (
str
) – the ‘Pin’ field, given as a string.new_pin (
str
) – the ‘NewPin’ field, given as a string.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Pin’ set command in the ‘Basic Connect’ service.
New in version 1.0.
- classmethod preferred_providers_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Preferred Providers’ query command in the ‘Basic Connect’ service.
New in version 1.2.
- classmethod preferred_providers_set_new(providers_count, providers)¶
- Parameters:
providers_count (
int
) – the ‘ProvidersCount’ field, given as a #guint32.providers ([
Mbim.Provider
]) – the ‘Providers’ field, given as an array ofMbim.Provider
items.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Preferred Providers’ set command in the ‘Basic Connect’ service.
New in version 1.2.
- classmethod provisioned_contexts_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Provisioned Contexts’ query command in the ‘Basic Connect’ service.
New in version 1.0.
- classmethod provisioned_contexts_set_new(context_id, context_type, access_string, user_name, password, compression, auth_protocol, provider_id)¶
- Parameters:
context_id (
int
) – the ‘ContextId’ field, given as a #guint32.context_type (
Mbim.Uuid
) – the ‘ContextType’ field, given as aMbim.Uuid
.access_string (
str
) – the ‘AccessString’ field, given as a string.user_name (
str
) – the ‘UserName’ field, given as a string.password (
str
) – the ‘Password’ field, given as a string.compression (
Mbim.Compression
) – the ‘Compression’ field, given as aMbim.Compression
.auth_protocol (
Mbim.AuthProtocol
) – the ‘AuthProtocol’ field, given as aMbim.AuthProtocol
.provider_id (
str
) – the ‘ProviderId’ field, given as a string.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Provisioned Contexts’ set command in the ‘Basic Connect’ service.
New in version 1.0.
- classmethod proxy_control_configuration_set_new(device_path, timeout)¶
- Parameters:
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Configuration’ set command in the ‘Proxy Control’ service.
New in version 1.10.
- classmethod qdu_file_open_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘File Open’ query command in the ‘QDU’ service.
New in version 1.26.
- classmethod qdu_file_open_set_new(file_type, file_size)¶
- Parameters:
file_type (
Mbim.QduFileType
) – the ‘FileType’ field, given as aMbim.QduFileType
.file_size (
int
) – the ‘FileSize’ field, given as a #guint32.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘File Open’ set command in the ‘QDU’ service.
New in version 1.26.
- classmethod qdu_file_write_set_new(data_buffer)¶
- Parameters:
data_buffer (
bytes
) – the ‘DataBuffer’ field, given as an array of #guint8 values.- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘File Write’ set command in the ‘QDU’ service.
New in version 1.26.
- classmethod qdu_quectel_read_version_set_new(version_type)¶
- Parameters:
version_type (
Mbim.QduQuectelVersionType
) – the ‘VersionType’ field, given as aMbim.QduQuectelVersionType
.- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Quectel Read Version’ set command in the ‘QDU’ service.
New in version 1.28.
- classmethod qdu_quectel_reboot_set_new(reboot_type)¶
- Parameters:
reboot_type (
Mbim.QduQuectelRebootType
) – the ‘RebootType’ field, given as aMbim.QduQuectelRebootType
.- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Quectel Reboot’ set command in the ‘QDU’ service.
New in version 1.28.
- classmethod qdu_update_session_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Update Session’ query command in the ‘QDU’ service.
New in version 1.26.
- classmethod qdu_update_session_set_new(session_action, session_type)¶
- Parameters:
session_action (
Mbim.QduSessionAction
) – the ‘SessionAction’ field, given as aMbim.QduSessionAction
.session_type (
Mbim.QduSessionType
) – the ‘SessionType’ field, given as aMbim.QduSessionType
.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Update Session’ set command in the ‘QDU’ service.
New in version 1.26.
- classmethod qmi_msg_set_new(qmi_msg)¶
- Parameters:
qmi_msg (
bytes
) – the ‘QmiMsg’ field, given as an array of #guint8 values.- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘msg’ set command in the ‘QMI’ service.
New in version 1.14.
- classmethod quectel_radio_state_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Radio State’ query command in the ‘Quectel’ service.
New in version 1.26.2.
- classmethod quectel_radio_state_set_new(radio_state)¶
- Parameters:
radio_state (
Mbim.QuectelRadioSwitchState
) – the ‘RadioState’ field, given as aMbim.QuectelRadioSwitchState
.- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Radio State’ set command in the ‘Quectel’ service.
New in version 1.26.2.
- classmethod radio_state_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Radio State’ query command in the ‘Basic Connect’ service.
New in version 1.0.
- classmethod radio_state_set_new(radio_state)¶
- Parameters:
radio_state (
Mbim.RadioSwitchState
) – the ‘RadioState’ field, given as aMbim.RadioSwitchState
.- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Radio State’ set command in the ‘Basic Connect’ service.
New in version 1.0.
- classmethod register_state_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Register State’ query command in the ‘Basic Connect’ service.
New in version 1.0.
- classmethod register_state_set_new(provider_id, register_action, data_class)¶
- Parameters:
provider_id (
str
) – the ‘ProviderId’ field, given as a string.register_action (
Mbim.RegisterAction
) – the ‘RegisterAction’ field, given as aMbim.RegisterAction
.data_class (
Mbim.DataClass
) – the ‘DataClass’ field, given as aMbim.DataClass
.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Register State’ set command in the ‘Basic Connect’ service.
New in version 1.0.
- classmethod service_activation_set_new(buffer)¶
- Parameters:
buffer (
bytes
) – the ‘Buffer’ field, given as an array of #guint8 values.- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Service Activation’ set command in the ‘Basic Connect’ service.
New in version 1.2.
- classmethod signal_state_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Signal State’ query command in the ‘Basic Connect’ service.
New in version 1.0.
- classmethod signal_state_set_new(signal_strength_interval, rssi_threshold, error_rate_threshold)¶
- Parameters:
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Signal State’ set command in the ‘Basic Connect’ service.
New in version 1.0.
- classmethod sms_configuration_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Configuration’ query command in the ‘SMS’ service.
New in version 1.4.
- classmethod sms_configuration_set_new(format, sc_address)¶
- Parameters:
format (
Mbim.SmsFormat
) – the ‘Format’ field, given as aMbim.SmsFormat
.sc_address (
str
) – the ‘ScAddress’ field, given as a string.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Configuration’ set command in the ‘SMS’ service.
New in version 1.4.
- classmethod sms_delete_set_new(flag, message_index)¶
- Parameters:
flag (
Mbim.SmsFlag
) – the ‘Flag’ field, given as aMbim.SmsFlag
.message_index (
int
) – the ‘MessageIndex’ field, given as a #guint32.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Delete’ set command in the ‘SMS’ service.
New in version 1.4.
- classmethod sms_message_store_status_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Message Store Status’ query command in the ‘SMS’ service.
New in version 1.4.
- classmethod sms_read_query_new(format, flag, message_index)¶
- Parameters:
format (
Mbim.SmsFormat
) – the ‘Format’ field, given as aMbim.SmsFormat
.flag (
Mbim.SmsFlag
) – the ‘Flag’ field, given as aMbim.SmsFlag
.message_index (
int
) – the ‘MessageIndex’ field, given as a #guint32.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Read’ query command in the ‘SMS’ service.
New in version 1.4.
- classmethod sms_send_set_new(format, pdu_message, cdma_message)¶
- Parameters:
format (
Mbim.SmsFormat
) – the ‘Format’ field, given as aMbim.SmsFormat
.pdu_message (
Mbim.SmsPduSendRecord
) – the ‘PduMessage’ field, given as aMbim.SmsPduSendRecord
.cdma_message (
Mbim.SmsCdmaSendRecord
) – the ‘CdmaMessage’ field, given as aMbim.SmsCdmaSendRecord
.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Send’ set command in the ‘SMS’ service.
New in version 1.4.
- classmethod stk_envelope_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Envelope’ query command in the ‘STK’ service.
New in version 1.4.
- classmethod stk_envelope_set_new(data)¶
- Parameters:
data (
bytes
) – the ‘Data’ field, given as an array of #guint8 values.- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Envelope’ set command in the ‘STK’ service.
New in version 1.4.
- classmethod stk_pac_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Pac’ query command in the ‘STK’ service.
New in version 1.4.
- classmethod stk_pac_set_new(pac_host_control)¶
- Parameters:
pac_host_control (
bytes
) – the ‘PacHostControl’ field, given as an array of 32 #guint8 values.- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Pac’ set command in the ‘STK’ service.
New in version 1.4.
- classmethod stk_terminal_response_set_new(response)¶
- Parameters:
response (
bytes
) – the ‘Response’ field, given as an array of #guint8 values.- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Terminal Response’ set command in the ‘STK’ service.
New in version 1.4.
- classmethod subscriber_ready_status_query_new()¶
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Subscriber Ready Status’ query command in the ‘Basic Connect’ service.
New in version 1.0.
- classmethod ussd_set_new(action, data_coding_scheme, payload)¶
- Parameters:
action (
Mbim.UssdAction
) – the ‘Action’ field, given as aMbim.UssdAction
.data_coding_scheme (
int
) – the ‘DataCodingScheme’ field, given as a #guint32.payload (
bytes
) – the ‘Payload’ field, given as an array of #guint8 values.
- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘’ set command in the ‘USSD’ service.
New in version 1.4.
- classmethod visible_providers_query_new(action)¶
- Parameters:
action (
Mbim.VisibleProvidersAction
) – the ‘Action’ field, given as aMbim.VisibleProvidersAction
.- Raises:
- Returns:
a newly allocated
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a new request for the ‘Visible Providers’ query command in the ‘Basic Connect’ service.
New in version 1.2.
- atds_location_response_parse()¶
-
Parses and returns parameters of the ‘Location’ response command in the ‘ATDS’ service.
New in version 1.16.
- atds_operators_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_providers_count:
return location for a #guint32, or
None
if the ‘ProvidersCount’ field is not needed.- out_providers:
return location for a newly allocated array of
Mbim.AtdsProvider
items, orNone
if the ‘Providers’ field is not needed. Free the returned value withMbim.AtdsProvider.array_free
().
- Return type:
(
bool
, out_providers_count:int
, out_providers: [Mbim.AtdsProvider
])
Parses and returns parameters of the ‘Operators’ response command in the ‘ATDS’ service.
New in version 1.16.
- atds_rat_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_mode:
return location for a
Mbim.AtdsRatMode
, orNone
if the ‘Mode’ field is not needed.
- Return type:
(
bool
, out_mode:Mbim.AtdsRatMode
)
Parses and returns parameters of the ‘RAT’ response command in the ‘ATDS’ service.
New in version 1.16.
- atds_register_state_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_nw_error:
return location for a
Mbim.NwError
, orNone
if the ‘NwError’ field is not needed.- out_register_state:
return location for a
Mbim.RegisterState
, orNone
if the ‘RegisterState’ field is not needed.- out_register_mode:
return location for a
Mbim.RegisterMode
, orNone
if the ‘RegisterMode’ field is not needed.- out_available_data_classes:
return location for a
Mbim.DataClass
, orNone
if the ‘AvailableDataClasses’ field is not needed.- out_current_cellular_class:
return location for a
Mbim.CellularClass
, orNone
if the ‘CurrentCellularClass’ field is not needed.- out_provider_id:
return location for a newly allocated string, or
None
if the ‘ProviderId’ field is not needed. Free the returned value withGLib.free
().- out_provider_name:
return location for a newly allocated string, or
None
if the ‘ProviderName’ field is not needed. Free the returned value withGLib.free
().- out_roaming_text:
return location for a newly allocated string, or
None
if the ‘RoamingText’ field is not needed. Free the returned value withGLib.free
().- out_registration_flag:
return location for a
Mbim.RegistrationFlag
, orNone
if the ‘RegistrationFlag’ field is not needed.
- Return type:
(
bool
, out_nw_error:Mbim.NwError
, out_register_state:Mbim.RegisterState
, out_register_mode:Mbim.RegisterMode
, out_available_data_classes:Mbim.DataClass
, out_current_cellular_class:Mbim.CellularClass
, out_provider_id:str
, out_provider_name:str
, out_roaming_text:str
, out_registration_flag:Mbim.RegistrationFlag
)
Parses and returns parameters of the ‘Register State’ response command in the ‘ATDS’ service.
New in version 1.16.
- atds_signal_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_rssi:
return location for a #guint32, or
None
if the ‘Rssi’ field is not needed.- out_error_rate:
return location for a #guint32, or
None
if the ‘ErrorRate’ field is not needed.- out_rscp:
return location for a #guint32, or
None
if the ‘Rscp’ field is not needed.- out_ecno:
return location for a #guint32, or
None
if the ‘Ecno’ field is not needed.- out_rsrq:
return location for a #guint32, or
None
if the ‘Rsrq’ field is not needed.- out_rsrp:
return location for a #guint32, or
None
if the ‘Rsrp’ field is not needed.- out_rssnr:
return location for a #guint32, or
None
if the ‘Rssnr’ field is not needed.
- Return type:
(
bool
, out_rssi:int
, out_error_rate:int
, out_rscp:int
, out_ecno:int
, out_rsrq:int
, out_rsrp:int
, out_rssnr:int
)
Parses and returns parameters of the ‘Signal’ response command in the ‘ATDS’ service.
New in version 1.16.
- auth_aka_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_res:
return location for an array of 16 #guint8 values. Do not free the returned value, it is owned by self.
- out_res_len:
return location for a #guint32, or
None
if the ‘ResLen’ field is not needed.- out_integrating_key:
return location for an array of 16 #guint8 values. Do not free the returned value, it is owned by self.
- out_ciphering_key:
return location for an array of 16 #guint8 values. Do not free the returned value, it is owned by self.
- out_auts:
return location for an array of 14 #guint8 values. Do not free the returned value, it is owned by self.
- Return type:
(
bool
, out_res:bytes
, out_res_len:int
, out_integrating_key:bytes
, out_ciphering_key:bytes
, out_auts:bytes
)
Parses and returns parameters of the ‘Aka’ response command in the ‘Auth’ service.
New in version 1.4.
- auth_akap_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_res:
return location for an array of 16 #guint8 values. Do not free the returned value, it is owned by self.
- out_res_len:
return location for a #guint32, or
None
if the ‘ResLen’ field is not needed.- out_integrating_key:
return location for an array of 16 #guint8 values. Do not free the returned value, it is owned by self.
- out_ciphering_key:
return location for an array of 16 #guint8 values. Do not free the returned value, it is owned by self.
- out_auts:
return location for an array of 14 #guint8 values. Do not free the returned value, it is owned by self.
- Return type:
(
bool
, out_res:bytes
, out_res_len:int
, out_integrating_key:bytes
, out_ciphering_key:bytes
, out_auts:bytes
)
Parses and returns parameters of the ‘Akap’ response command in the ‘Auth’ service.
New in version 1.4.
- auth_sim_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_sres1:
return location for a #guint32, or
None
if the ‘Sres1’ field is not needed.- out_kc1:
return location for a #guint64, or
None
if the ‘Kc1’ field is not needed.- out_sres2:
return location for a #guint32, or
None
if the ‘Sres2’ field is not needed.- out_kc2:
return location for a #guint64, or
None
if the ‘Kc2’ field is not needed.- out_sres3:
return location for a #guint32, or
None
if the ‘Sres3’ field is not needed.- out_kc3:
return location for a #guint64, or
None
if the ‘Kc3’ field is not needed.- out_n:
return location for a #guint32, or
None
if the ‘N’ field is not needed.
- Return type:
(
bool
, out_sres1:int
, out_kc1:int
, out_sres2:int
, out_kc2:int
, out_sres3:int
, out_kc3:int
, out_n:int
)
Parses and returns parameters of the ‘Sim’ response command in the ‘Auth’ service.
New in version 1.4.
- close_done_get_result()¶
- Raises:
- Returns:
- Return type:
Gets the result of the ‘Close’ operation in the
Mbim.MessageType.CLOSE_DONE
message.New in version 1.0.
- close_done_get_status_code()¶
- Returns:
- Return type:
Get status code from the
Mbim.MessageType.CLOSE_DONE
message.New in version 1.0.
- command_append(buffer, buffer_size)¶
- Parameters:
Appends the contents of buffer to self.
New in version 1.0.
- command_done_get_cid()¶
- Returns:
a CID.
- Return type:
Get the command id of a
Mbim.MessageType.COMMAND_DONE
message.New in version 1.0.
- command_done_get_raw_information_buffer()¶
- Returns:
The raw data buffer, or
None
if empty.- out_length:
return location for the size of the output buffer.
- Return type:
Gets the information buffer of the
Mbim.MessageType.COMMAND_DONE
message.New in version 1.0.
- command_done_get_result()¶
- Raises:
- Returns:
- Return type:
Gets the result of the ‘Command’ operation in the
Mbim.MessageType.COMMAND_DONE
message.New in version 1.0.
- command_done_get_service()¶
- Returns:
a
Mbim.Service
.- Return type:
Get the service of a
Mbim.MessageType.COMMAND_DONE
message.New in version 1.0.
- command_done_get_service_id()¶
-
Get the service UUID of a
Mbim.MessageType.COMMAND_DONE
message.New in version 1.0.
- command_done_get_status_code()¶
- Returns:
- Return type:
Get status code from the
Mbim.MessageType.COMMAND_DONE
message.New in version 1.0.
- command_get_cid()¶
- Returns:
a CID.
- Return type:
Get the command id of a
Mbim.MessageType.COMMAND
message.New in version 1.0.
- command_get_command_type()¶
- Returns:
- Return type:
Get the command type of a
Mbim.MessageType.COMMAND
message.New in version 1.0.
- command_get_raw_information_buffer()¶
- Returns:
The raw data buffer, or
None
if empty.- out_length:
return location for the size of the output buffer.
- Return type:
Gets the information buffer of the
Mbim.MessageType.COMMAND
message.New in version 1.0.
- command_get_service()¶
- Returns:
a
Mbim.Service
.- Return type:
Get the service of a
Mbim.MessageType.COMMAND
message.New in version 1.0.
- command_get_service_id()¶
-
Get the service UUID of a
Mbim.MessageType.COMMAND
message.New in version 1.0.
- connect_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_session_id:
return location for a #guint32, or
None
if the ‘SessionId’ field is not needed.- out_activation_state:
return location for a
Mbim.ActivationState
, orNone
if the ‘ActivationState’ field is not needed.- out_voice_call_state:
return location for a
Mbim.VoiceCallState
, orNone
if the ‘VoiceCallState’ field is not needed.- out_ip_type:
return location for a
Mbim.ContextIpType
, orNone
if the ‘IpType’ field is not needed.- out_context_type:
return location for a
Mbim.Uuid
, orNone
if the ‘ContextType’ field is not needed. Do not free the returned value, it is owned by self.- out_nw_error:
return location for a #guint32, or
None
if the ‘NwError’ field is not needed.
- Return type:
(
bool
, out_session_id:int
, out_activation_state:Mbim.ActivationState
, out_voice_call_state:Mbim.VoiceCallState
, out_ip_type:Mbim.ContextIpType
, out_context_type:Mbim.Uuid
, out_nw_error:int
)
Parses and returns parameters of the ‘Connect’ notification command in the ‘Basic Connect’ service.
New in version 1.0.
- connect_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_session_id:
return location for a #guint32, or
None
if the ‘SessionId’ field is not needed.- out_activation_state:
return location for a
Mbim.ActivationState
, orNone
if the ‘ActivationState’ field is not needed.- out_voice_call_state:
return location for a
Mbim.VoiceCallState
, orNone
if the ‘VoiceCallState’ field is not needed.- out_ip_type:
return location for a
Mbim.ContextIpType
, orNone
if the ‘IpType’ field is not needed.- out_context_type:
return location for a
Mbim.Uuid
, orNone
if the ‘ContextType’ field is not needed. Do not free the returned value, it is owned by self.- out_nw_error:
return location for a #guint32, or
None
if the ‘NwError’ field is not needed.
- Return type:
(
bool
, out_session_id:int
, out_activation_state:Mbim.ActivationState
, out_voice_call_state:Mbim.VoiceCallState
, out_ip_type:Mbim.ContextIpType
, out_context_type:Mbim.Uuid
, out_nw_error:int
)
Parses and returns parameters of the ‘Connect’ response command in the ‘Basic Connect’ service.
New in version 1.0.
- device_caps_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_device_type:
return location for a
Mbim.DeviceType
, orNone
if the ‘DeviceType’ field is not needed.- out_cellular_class:
return location for a
Mbim.CellularClass
, orNone
if the ‘CellularClass’ field is not needed.- out_voice_class:
return location for a
Mbim.VoiceClass
, orNone
if the ‘VoiceClass’ field is not needed.- out_sim_class:
return location for a
Mbim.SimClass
, orNone
if the ‘SimClass’ field is not needed.- out_data_class:
return location for a
Mbim.DataClass
, orNone
if the ‘DataClass’ field is not needed.- out_sms_caps:
return location for a
Mbim.SmsCaps
, orNone
if the ‘SmsCaps’ field is not needed.- out_control_caps:
return location for a
Mbim.CtrlCaps
, orNone
if the ‘ControlCaps’ field is not needed.- out_max_sessions:
return location for a #guint32, or
None
if the ‘MaxSessions’ field is not needed.- out_custom_data_class:
return location for a newly allocated string, or
None
if the ‘CustomDataClass’ field is not needed. Free the returned value withGLib.free
().- out_device_id:
return location for a newly allocated string, or
None
if the ‘DeviceId’ field is not needed. Free the returned value withGLib.free
().- out_firmware_info:
return location for a newly allocated string, or
None
if the ‘FirmwareInfo’ field is not needed. Free the returned value withGLib.free
().- out_hardware_info:
return location for a newly allocated string, or
None
if the ‘HardwareInfo’ field is not needed. Free the returned value withGLib.free
().
- Return type:
(
bool
, out_device_type:Mbim.DeviceType
, out_cellular_class:Mbim.CellularClass
, out_voice_class:Mbim.VoiceClass
, out_sim_class:Mbim.SimClass
, out_data_class:Mbim.DataClass
, out_sms_caps:Mbim.SmsCaps
, out_control_caps:Mbim.CtrlCaps
, out_max_sessions:int
, out_custom_data_class:str
, out_device_id:str
, out_firmware_info:str
, out_hardware_info:str
)
Parses and returns parameters of the ‘Device Caps’ response command in the ‘Basic Connect’ service.
New in version 1.0.
- device_service_subscribe_list_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_events_count:
return location for a #guint32, or
None
if the ‘EventsCount’ field is not needed.- out_events:
return location for a newly allocated array of
Mbim.EventEntry
items, orNone
if the ‘Events’ field is not needed. Free the returned value withMbim.EventEntry.array_free
().
- Return type:
(
bool
, out_events_count:int
, out_events: [Mbim.EventEntry
])
Parses and returns parameters of the ‘Device Service Subscribe List’ response command in the ‘Basic Connect’ service.
New in version 1.8.
- device_service_subscriber_list_response_parse(events_count, events)¶
- Parameters:
events_count (
int
) – return location for a #guint32, orNone
if the ‘EventsCount’ field is not needed.events (
Mbim.EventEntry
) – return location for a newly allocated array ofMbim.EventEntrys
, orNone
if the ‘Events’ field is not needed. Free the returned value withMbim.EventEntry.array_free
().
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- Return type:
Create a new request for the ‘Events’ response command in the ‘Basic Connect’ service.
New in version 1.0.
Deprecated since version 1.8: Use
Mbim.Message.device_service_subscribe_list_response_parse
() instead.
- device_services_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_device_services_count:
return location for a #guint32, or
None
if the ‘DeviceServicesCount’ field is not needed.- out_max_dss_sessions:
return location for a #guint32, or
None
if the ‘MaxDssSessions’ field is not needed.- out_device_services:
return location for a newly allocated array of
Mbim.DeviceServiceElement
items, orNone
if the ‘DeviceServices’ field is not needed. Free the returned value withMbim.DeviceServiceElement.array_free
().
- Return type:
(
bool
, out_device_services_count:int
, out_max_dss_sessions:int
, out_device_services: [Mbim.DeviceServiceElement
])
Parses and returns parameters of the ‘Device Services’ response command in the ‘Basic Connect’ service.
New in version 1.0.
- dss_connect_response_parse()¶
-
Parses and returns parameters of the ‘Connect’ response command in the ‘DSS’ service.
New in version 1.4.
- dup()¶
- Returns:
a newly created
Mbim.Message
, which should be freed withMbim.Message.unref
().- Return type:
Create a
Mbim.Message
with the same contents as self.New in version 1.0.
- emergency_mode_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_state:
return location for a
Mbim.EmergencyModeState
, orNone
if the ‘State’ field is not needed.
- Return type:
(
bool
, out_state:Mbim.EmergencyModeState
)
Parses and returns parameters of the ‘Emergency Mode’ notification command in the ‘Basic Connect’ service.
New in version 1.8.
- emergency_mode_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_state:
return location for a
Mbim.EmergencyModeState
, orNone
if the ‘State’ field is not needed.
- Return type:
(
bool
, out_state:Mbim.EmergencyModeState
)
Parses and returns parameters of the ‘Emergency Mode’ response command in the ‘Basic Connect’ service.
New in version 1.4.
- error_get_error()¶
- Returns:
a newly allocated
GLib.Error
, which should be freed withGLib.Error.free
().- Return type:
Get the error in a
Mbim.MessageType.HOST_ERROR
orMbim.MessageType.FUNCTION_ERROR
message.New in version 1.0.
- error_get_error_status_code()¶
- Returns:
- Return type:
Get the error code in a
Mbim.MessageType.HOST_ERROR
orMbim.MessageType.FUNCTION_ERROR
message.New in version 1.0.
- get_message_length()¶
- Returns:
the length of the message.
- Return type:
Gets the whole message length.
New in version 1.0.
- get_message_type()¶
- Returns:
- Return type:
Gets the message type.
New in version 1.0.
- get_printable(line_prefix, headers_only)¶
- Parameters:
- Returns:
a newly allocated string, which should be freed with
GLib.free
().- Return type:
Gets a printable string with the contents of the whole MBIM message.
This method will not fail if the parsing of the message contents fails, a fallback text with the error will be included in the generated printable information instead.
New in version 1.0.
- get_printable_full(mbimex_version_major, mbimex_version_minor, line_prefix, headers_only)¶
- Parameters:
- Raises:
- Returns:
a newly allocated string which should be freed with
GLib.free
(), orNone
if error is set.- Return type:
Gets a printable string with the contents of the whole MBIM message.
Unlike
Mbim.Message.get_printable
(), this method allows specifying the MBIMEx version agreed between host and device, so that the correct processing and parsing is done on messages in the newer MBIMEx versions.If mbimex_version_major < 2, this method behaves exactly as
Mbim.Message.get_printable
().If the specified mbimex_version_major is unsupported, an error will be returned.
This method will not fail if the parsing of the message contents fails, a fallback text with the error will be included in the generated printable information instead.
New in version 1.28.
- get_raw()¶
- Raises:
- Returns:
The raw data buffer, or
None
if error is set.- length:
return location for the size of the output buffer.
- Return type:
Gets the whole raw data buffer of the
Mbim.Message
.New in version 1.0.
- get_transaction_id()¶
- Returns:
the transaction ID.
- Return type:
Gets the transaction ID of the message.
New in version 1.0.
- google_carrier_lock_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_carrier_lock_status:
return location for a
Mbim.CarrierLockStatus
, orNone
if the ‘CarrierLockStatus’ field is not needed.- out_carrier_lock_modem_state:
return location for a
Mbim.CarrierLockModemState
, orNone
if the ‘CarrierLockModemState’ field is not needed.- out_carrier_lock_cause:
return location for a
Mbim.CarrierLockCause
, orNone
if the ‘CarrierLockCause’ field is not needed.
- Return type:
(
bool
, out_carrier_lock_status:Mbim.CarrierLockStatus
, out_carrier_lock_modem_state:Mbim.CarrierLockModemState
, out_carrier_lock_cause:Mbim.CarrierLockCause
)
Parses and returns parameters of the ‘Carrier Lock’ notification command in the ‘Google’ service.
New in version 1.30.
- google_carrier_lock_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_carrier_lock_status:
return location for a
Mbim.CarrierLockStatus
, orNone
if the ‘CarrierLockStatus’ field is not needed.- out_carrier_lock_modem_state:
return location for a
Mbim.CarrierLockModemState
, orNone
if the ‘CarrierLockModemState’ field is not needed.- out_carrier_lock_cause:
return location for a
Mbim.CarrierLockCause
, orNone
if the ‘CarrierLockCause’ field is not needed.
- Return type:
(
bool
, out_carrier_lock_status:Mbim.CarrierLockStatus
, out_carrier_lock_modem_state:Mbim.CarrierLockModemState
, out_carrier_lock_cause:Mbim.CarrierLockCause
)
Parses and returns parameters of the ‘Carrier Lock’ response command in the ‘Google’ service.
New in version 1.30.
- home_provider_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_provider:
return location for a newly allocated
Mbim.Provider
, orNone
if the ‘Provider’ field is not needed. Free the returned value withMbim.Provider.free
().
- Return type:
(
bool
, out_provider:Mbim.Provider
)
Parses and returns parameters of the ‘Home Provider’ response command in the ‘Basic Connect’ service.
New in version 1.2.
- indicate_status_get_cid()¶
- Returns:
a CID.
- Return type:
Get the command id of a
Mbim.MessageType.INDICATE_STATUS
message.New in version 1.0.
- indicate_status_get_raw_information_buffer()¶
- Returns:
The raw data buffer, or
None
if empty.- out_length:
return location for the size of the output buffer.
- Return type:
Gets the information buffer of the
Mbim.MessageType.INDICATE_STATUS
message.New in version 1.0.
- indicate_status_get_service()¶
- Returns:
a
Mbim.Service
.- Return type:
Get the service of a
Mbim.MessageType.INDICATE_STATUS
message.New in version 1.0.
- indicate_status_get_service_id()¶
-
Get the service UUID of a
Mbim.MessageType.INDICATE_STATUS
message.New in version 1.0.
- intel_mutual_authentication_fcc_lock_response_parse()¶
-
Parses and returns parameters of the ‘FCC Lock’ response command in the ‘Intel Mutual Authentication’ service.
New in version 1.30.
- intel_thermal_rf_rfim_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_rfim_frequency_values_count:
return location for a #guint32, or
None
if the ‘RfimFrequencyValuesCount’ field is not needed.- out_rfim_frequency_values:
return location for a newly allocated array of
Mbim.IntelRfimFrequencyValue
items, orNone
if the ‘RfimFrequencyValues’ field is not needed. Free the returned value withMbim.IntelRfimFrequencyValue.array_free
().
- Return type:
(
bool
, out_rfim_frequency_values_count:int
, out_rfim_frequency_values: [Mbim.IntelRfimFrequencyValue
])
Parses and returns parameters of the ‘RFIM’ notification command in the ‘Intel Thermal RF’ service.
New in version 1.28.
- intel_thermal_rf_rfim_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_rfim_frequency_values_count:
return location for a #guint32, or
None
if the ‘RfimFrequencyValuesCount’ field is not needed.- out_rfim_frequency_values:
return location for a newly allocated array of
Mbim.IntelRfimFrequencyValue
items, orNone
if the ‘RfimFrequencyValues’ field is not needed. Free the returned value withMbim.IntelRfimFrequencyValue.array_free
().
- Return type:
(
bool
, out_rfim_frequency_values_count:int
, out_rfim_frequency_values: [Mbim.IntelRfimFrequencyValue
])
Parses and returns parameters of the ‘RFIM’ response command in the ‘Intel Thermal RF’ service.
New in version 1.28.
- intel_tools_trace_config_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_trace_cmd:
return location for a
Mbim.TraceCommand
, orNone
if the ‘TraceCmd’ field is not needed.- out_result:
return location for a #guint32, or
None
if the ‘Result’ field is not needed.
- Return type:
(
bool
, out_trace_cmd:Mbim.TraceCommand
, out_result:int
)
Parses and returns parameters of the ‘Trace Config’ response command in the ‘Intel Tools’ service.
New in version 1.30.
- ip_configuration_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_session_id:
return location for a #guint32, or
None
if the ‘SessionId’ field is not needed.- out_ipv4_configuration_available:
return location for a
Mbim.IPConfigurationAvailableFlag
, orNone
if the ‘IPv4ConfigurationAvailable’ field is not needed.- out_ipv6_configuration_available:
return location for a
Mbim.IPConfigurationAvailableFlag
, orNone
if the ‘IPv6ConfigurationAvailable’ field is not needed.- out_ipv4_address_count:
return location for a #guint32, or
None
if the ‘IPv4AddressCount’ field is not needed.- out_ipv4_address:
return location for a newly allocated array of
Mbim.IPv4Element
items, orNone
if the ‘IPv4Address’ field is not needed. Free the returned value withMbim.IPv4Element.array_free
().- out_ipv6_address_count:
return location for a #guint32, or
None
if the ‘IPv6AddressCount’ field is not needed.- out_ipv6_address:
return location for a newly allocated array of
Mbim.IPv6Element
items, orNone
if the ‘IPv6Address’ field is not needed. Free the returned value withMbim.IPv6Element.array_free
().- out_ipv4_gateway:
return location for a
Mbim.IPv4
, orNone
if the ‘IPv4Gateway’ field is not needed. Do not free the returned value, it is owned by self.- out_ipv6_gateway:
return location for a
Mbim.IPv6
, orNone
if the ‘IPv6Gateway’ field is not needed. Do not free the returned value, it is owned by self.- out_ipv4_dns_server_count:
return location for a #guint32, or
None
if the ‘IPv4DnsServerCount’ field is not needed.- out_ipv4_dns_server:
return location for a newly allocated array of
Mbim.IPv4
items, orNone
if the ‘IPv4DnsServer’ field is not needed. Free the returned value withGLib.free
().- out_ipv6_dns_server_count:
return location for a #guint32, or
None
if the ‘IPv6DnsServerCount’ field is not needed.- out_ipv6_dns_server:
return location for a newly allocated array of
Mbim.IPv6
items, orNone
if the ‘IPv6DnsServer’ field is not needed. Free the returned value withGLib.free
().- out_ipv4_mtu:
return location for a #guint32, or
None
if the ‘IPv4Mtu’ field is not needed.- out_ipv6_mtu:
return location for a #guint32, or
None
if the ‘IPv6Mtu’ field is not needed.
- Return type:
(
bool
, out_session_id:int
, out_ipv4_configuration_available:Mbim.IPConfigurationAvailableFlag
, out_ipv6_configuration_available:Mbim.IPConfigurationAvailableFlag
, out_ipv4_address_count:int
, out_ipv4_address: [Mbim.IPv4Element
], out_ipv6_address_count:int
, out_ipv6_address: [Mbim.IPv6Element
], out_ipv4_gateway:Mbim.IPv4
, out_ipv6_gateway:Mbim.IPv6
, out_ipv4_dns_server_count:int
, out_ipv4_dns_server: [Mbim.IPv4
], out_ipv6_dns_server_count:int
, out_ipv6_dns_server: [Mbim.IPv6
], out_ipv4_mtu:int
, out_ipv6_mtu:int
)
Parses and returns parameters of the ‘IP Configuration’ notification command in the ‘Basic Connect’ service.
New in version 1.0.
- ip_configuration_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_session_id:
return location for a #guint32, or
None
if the ‘SessionId’ field is not needed.- out_ipv4_configuration_available:
return location for a
Mbim.IPConfigurationAvailableFlag
, orNone
if the ‘IPv4ConfigurationAvailable’ field is not needed.- out_ipv6_configuration_available:
return location for a
Mbim.IPConfigurationAvailableFlag
, orNone
if the ‘IPv6ConfigurationAvailable’ field is not needed.- out_ipv4_address_count:
return location for a #guint32, or
None
if the ‘IPv4AddressCount’ field is not needed.- out_ipv4_address:
return location for a newly allocated array of
Mbim.IPv4Element
items, orNone
if the ‘IPv4Address’ field is not needed. Free the returned value withMbim.IPv4Element.array_free
().- out_ipv6_address_count:
return location for a #guint32, or
None
if the ‘IPv6AddressCount’ field is not needed.- out_ipv6_address:
return location for a newly allocated array of
Mbim.IPv6Element
items, orNone
if the ‘IPv6Address’ field is not needed. Free the returned value withMbim.IPv6Element.array_free
().- out_ipv4_gateway:
return location for a
Mbim.IPv4
, orNone
if the ‘IPv4Gateway’ field is not needed. Do not free the returned value, it is owned by self.- out_ipv6_gateway:
return location for a
Mbim.IPv6
, orNone
if the ‘IPv6Gateway’ field is not needed. Do not free the returned value, it is owned by self.- out_ipv4_dns_server_count:
return location for a #guint32, or
None
if the ‘IPv4DnsServerCount’ field is not needed.- out_ipv4_dns_server:
return location for a newly allocated array of
Mbim.IPv4
items, orNone
if the ‘IPv4DnsServer’ field is not needed. Free the returned value withGLib.free
().- out_ipv6_dns_server_count:
return location for a #guint32, or
None
if the ‘IPv6DnsServerCount’ field is not needed.- out_ipv6_dns_server:
return location for a newly allocated array of
Mbim.IPv6
items, orNone
if the ‘IPv6DnsServer’ field is not needed. Free the returned value withGLib.free
().- out_ipv4_mtu:
return location for a #guint32, or
None
if the ‘IPv4Mtu’ field is not needed.- out_ipv6_mtu:
return location for a #guint32, or
None
if the ‘IPv6Mtu’ field is not needed.
- Return type:
(
bool
, out_session_id:int
, out_ipv4_configuration_available:Mbim.IPConfigurationAvailableFlag
, out_ipv6_configuration_available:Mbim.IPConfigurationAvailableFlag
, out_ipv4_address_count:int
, out_ipv4_address: [Mbim.IPv4Element
], out_ipv6_address_count:int
, out_ipv6_address: [Mbim.IPv6Element
], out_ipv4_gateway:Mbim.IPv4
, out_ipv6_gateway:Mbim.IPv6
, out_ipv4_dns_server_count:int
, out_ipv4_dns_server: [Mbim.IPv4
], out_ipv6_dns_server_count:int
, out_ipv6_dns_server: [Mbim.IPv6
], out_ipv4_mtu:int
, out_ipv6_mtu:int
)
Parses and returns parameters of the ‘IP Configuration’ response command in the ‘Basic Connect’ service.
New in version 1.0.
- ip_packet_filters_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_session_id:
return location for a #guint32, or
None
if the ‘SessionId’ field is not needed.- out_packet_filters_count:
return location for a #guint32, or
None
if the ‘PacketFiltersCount’ field is not needed.- out_packet_filters:
return location for a newly allocated array of
Mbim.PacketFilter
items, orNone
if the ‘PacketFilters’ field is not needed. Free the returned value withMbim.PacketFilter.array_free
().
- Return type:
(
bool
, out_session_id:int
, out_packet_filters_count:int
, out_packet_filters: [Mbim.PacketFilter
])
Parses and returns parameters of the ‘IP Packet Filters’ response command in the ‘Basic Connect’ service.
New in version 1.4.
- ms_basic_connect_extensions_base_stations_info_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_system_type:
return location for a
Mbim.DataClass
, orNone
if the ‘SystemType’ field is not needed.- out_gsm_serving_cell:
return location for a newly allocated
Mbim.CellInfoServingGsm
, orNone
if the ‘GsmServingCell’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withMbim.CellInfoServingGsm.free
().- out_umts_serving_cell:
return location for a newly allocated
Mbim.CellInfoServingUmts
, orNone
if the ‘UmtsServingCell’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withMbim.CellInfoServingUmts.free
().- out_tdscdma_serving_cell:
return location for a newly allocated
Mbim.CellInfoServingTdscdma
, orNone
if the ‘TdscdmaServingCell’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withMbim.CellInfoServingTdscdma.free
().- out_lte_serving_cell:
return location for a newly allocated
Mbim.CellInfoServingLte
, orNone
if the ‘LteServingCell’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withMbim.CellInfoServingLte.free
().- out_gsm_neighboring_cells_count:
return location for a #guint32, or
None
if the field is not needed.- out_gsm_neighboring_cells:
return location for a newly allocated array of
Mbim.CellInfoNeighboringGsm
items, orNone
if the ‘GsmNeighboringCells’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withMbim.CellInfoNeighboringGsm.array_free
().- out_umts_neighboring_cells_count:
return location for a #guint32, or
None
if the field is not needed.- out_umts_neighboring_cells:
return location for a newly allocated array of
Mbim.CellInfoNeighboringUmts
items, orNone
if the ‘UmtsNeighboringCells’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withMbim.CellInfoNeighboringUmts.array_free
().- out_tdscdma_neighboring_cells_count:
return location for a #guint32, or
None
if the field is not needed.- out_tdscdma_neighboring_cells:
return location for a newly allocated array of
Mbim.CellInfoNeighboringTdscdma
items, orNone
if the ‘TdscdmaNeighboringCells’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withMbim.CellInfoNeighboringTdscdma.array_free
().- out_lte_neighboring_cells_count:
return location for a #guint32, or
None
if the field is not needed.- out_lte_neighboring_cells:
return location for a newly allocated array of
Mbim.CellInfoNeighboringLte
items, orNone
if the ‘LteNeighboringCells’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withMbim.CellInfoNeighboringLte.array_free
().- out_cdma_cells_count:
return location for a #guint32, or
None
if the field is not needed.- out_cdma_cells:
return location for a newly allocated array of
Mbim.CellInfoCdma
items, orNone
if the ‘CdmaCells’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withMbim.CellInfoCdma.array_free
().
- Return type:
(
bool
, out_system_type:Mbim.DataClass
, out_gsm_serving_cell:Mbim.CellInfoServingGsm
orNone
, out_umts_serving_cell:Mbim.CellInfoServingUmts
orNone
, out_tdscdma_serving_cell:Mbim.CellInfoServingTdscdma
orNone
, out_lte_serving_cell:Mbim.CellInfoServingLte
orNone
, out_gsm_neighboring_cells_count:int
, out_gsm_neighboring_cells: [Mbim.CellInfoNeighboringGsm
], out_umts_neighboring_cells_count:int
, out_umts_neighboring_cells: [Mbim.CellInfoNeighboringUmts
], out_tdscdma_neighboring_cells_count:int
, out_tdscdma_neighboring_cells: [Mbim.CellInfoNeighboringTdscdma
], out_lte_neighboring_cells_count:int
, out_lte_neighboring_cells: [Mbim.CellInfoNeighboringLte
], out_cdma_cells_count:int
, out_cdma_cells: [Mbim.CellInfoCdma
])
Parses and returns parameters of the ‘Base Stations Info’ response command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.28.
- ms_basic_connect_extensions_device_caps_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_device_type:
return location for a
Mbim.DeviceType
, orNone
if the ‘DeviceType’ field is not needed.- out_cellular_class:
return location for a
Mbim.CellularClass
, orNone
if the ‘CellularClass’ field is not needed.- out_voice_class:
return location for a
Mbim.VoiceClass
, orNone
if the ‘VoiceClass’ field is not needed.- out_sms_class:
return location for a
Mbim.SimClass
, orNone
if the ‘SmsClass’ field is not needed.- out_data_class:
return location for a
Mbim.DataClass
, orNone
if the ‘DataClass’ field is not needed.- out_sms_caps:
return location for a
Mbim.SmsCaps
, orNone
if the ‘SmsCaps’ field is not needed.- out_control_caps:
return location for a
Mbim.CtrlCaps
, orNone
if the ‘ControlCaps’ field is not needed.- out_max_sessions:
return location for a #guint32, or
None
if the ‘MaxSessions’ field is not needed.- out_custom_data_class:
return location for a newly allocated string, or
None
if the ‘CustomDataClass’ field is not needed. Free the returned value withGLib.free
().- out_device_id:
return location for a newly allocated string, or
None
if the ‘DeviceId’ field is not needed. Free the returned value withGLib.free
().- out_firmware_info:
return location for a newly allocated string, or
None
if the ‘FirmwareInfo’ field is not needed. Free the returned value withGLib.free
().- out_hardware_info:
return location for a newly allocated string, or
None
if the ‘HardwareInfo’ field is not needed. Free the returned value withGLib.free
().- out_executor_index:
return location for a #guint32, or
None
if the ‘ExecutorIndex’ field is not needed.
- Return type:
(
bool
, out_device_type:Mbim.DeviceType
, out_cellular_class:Mbim.CellularClass
, out_voice_class:Mbim.VoiceClass
, out_sms_class:Mbim.SimClass
, out_data_class:Mbim.DataClass
, out_sms_caps:Mbim.SmsCaps
, out_control_caps:Mbim.CtrlCaps
, out_max_sessions:int
, out_custom_data_class:str
, out_device_id:str
, out_firmware_info:str
, out_hardware_info:str
, out_executor_index:int
)
Parses and returns parameters of the ‘Device Caps’ response command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.26.
- ms_basic_connect_extensions_device_reset_response_parse()¶
-
Parses and returns parameters of the ‘Device Reset’ response command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.30.
- ms_basic_connect_extensions_device_slot_mappings_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_map_count:
return location for a #guint32, or
None
if the ‘MapCount’ field is not needed.- out_slot_map:
return location for a newly allocated array of
Mbim.Slot
items, orNone
if the ‘SlotMap’ field is not needed. Free the returned value withMbim.Slot.array_free
().
- Return type:
Parses and returns parameters of the ‘Device Slot Mappings’ response command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.26.
- ms_basic_connect_extensions_location_info_status_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_location_area_code:
return location for a #guint32, or
None
if the ‘LocationAreaCode’ field is not needed.- out_tracking_area_code:
return location for a #guint32, or
None
if the ‘TrackingAreaCode’ field is not needed.- out_cell_id:
return location for a #guint32, or
None
if the ‘CellID’ field is not needed.
- Return type:
(
bool
, out_location_area_code:int
, out_tracking_area_code:int
, out_cell_id:int
)
Parses and returns parameters of the ‘Location Info Status’ notification command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.28.
- ms_basic_connect_extensions_location_info_status_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_location_area_code:
return location for a #guint32, or
None
if the ‘LocationAreaCode’ field is not needed.- out_tracking_area_code:
return location for a #guint32, or
None
if the ‘TrackingAreaCode’ field is not needed.- out_cell_id:
return location for a #guint32, or
None
if the ‘CellID’ field is not needed.
- Return type:
(
bool
, out_location_area_code:int
, out_tracking_area_code:int
, out_cell_id:int
)
Parses and returns parameters of the ‘Location Info Status’ response command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.28.
- ms_basic_connect_extensions_lte_attach_configuration_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_configuration_count:
return location for a #guint32, or
None
if the ‘ConfigurationCount’ field is not needed.- out_configurations:
return location for a newly allocated array of
Mbim.LteAttachConfiguration
items, orNone
if the ‘Configurations’ field is not needed. Free the returned value withMbim.LteAttachConfiguration.array_free
().
- Return type:
(
bool
, out_configuration_count:int
, out_configurations: [Mbim.LteAttachConfiguration
])
Parses and returns parameters of the ‘Lte Attach Configuration’ notification command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.18.
- ms_basic_connect_extensions_lte_attach_configuration_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_configuration_count:
return location for a #guint32, or
None
if the ‘ConfigurationCount’ field is not needed.- out_configurations:
return location for a newly allocated array of
Mbim.LteAttachConfiguration
items, orNone
if the ‘Configurations’ field is not needed. Free the returned value withMbim.LteAttachConfiguration.array_free
().
- Return type:
(
bool
, out_configuration_count:int
, out_configurations: [Mbim.LteAttachConfiguration
])
Parses and returns parameters of the ‘Lte Attach Configuration’ response command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.18.
- ms_basic_connect_extensions_lte_attach_info_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_lte_attach_state:
return location for a
Mbim.LteAttachState
, orNone
if the ‘LteAttachState’ field is not needed.- out_ip_type:
return location for a
Mbim.ContextIpType
, orNone
if the ‘IpType’ field is not needed.- out_access_string:
return location for a newly allocated string, or
None
if the ‘AccessString’ field is not needed. Free the returned value withGLib.free
().- out_user_name:
return location for a newly allocated string, or
None
if the ‘UserName’ field is not needed. Free the returned value withGLib.free
().- out_password:
return location for a newly allocated string, or
None
if the ‘Password’ field is not needed. Free the returned value withGLib.free
().- out_compression:
return location for a
Mbim.Compression
, orNone
if the ‘Compression’ field is not needed.- out_auth_protocol:
return location for a
Mbim.AuthProtocol
, orNone
if the ‘AuthProtocol’ field is not needed.
- Return type:
(
bool
, out_lte_attach_state:Mbim.LteAttachState
, out_ip_type:Mbim.ContextIpType
, out_access_string:str
, out_user_name:str
, out_password:str
, out_compression:Mbim.Compression
, out_auth_protocol:Mbim.AuthProtocol
)
Parses and returns parameters of the ‘Lte Attach Info’ notification command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.26.
- ms_basic_connect_extensions_lte_attach_info_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_lte_attach_state:
return location for a
Mbim.LteAttachState
, orNone
if the ‘LteAttachState’ field is not needed.- out_ip_type:
return location for a
Mbim.ContextIpType
, orNone
if the ‘IpType’ field is not needed.- out_access_string:
return location for a newly allocated string, or
None
if the ‘AccessString’ field is not needed. Free the returned value withGLib.free
().- out_user_name:
return location for a newly allocated string, or
None
if the ‘UserName’ field is not needed. Free the returned value withGLib.free
().- out_password:
return location for a newly allocated string, or
None
if the ‘Password’ field is not needed. Free the returned value withGLib.free
().- out_compression:
return location for a
Mbim.Compression
, orNone
if the ‘Compression’ field is not needed.- out_auth_protocol:
return location for a
Mbim.AuthProtocol
, orNone
if the ‘AuthProtocol’ field is not needed.
- Return type:
(
bool
, out_lte_attach_state:Mbim.LteAttachState
, out_ip_type:Mbim.ContextIpType
, out_access_string:str
, out_user_name:str
, out_password:str
, out_compression:Mbim.Compression
, out_auth_protocol:Mbim.AuthProtocol
)
Parses and returns parameters of the ‘Lte Attach Info’ response command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.26.
- ms_basic_connect_extensions_lte_attach_status_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_lte_attach_status:
return location for a newly allocated #MbimLteAttachStatus, or
None
if the ‘LteAttachStatus’ field is not needed. Free the returned value withMbim.lte_attach_status_free
().
- Return type:
(
bool
, out_lte_attach_status:Mbim.DeprecatedLteAttachStatus
)
Parses and returns parameters of the ‘Lte Attach Status’ notification command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.18.
Deprecated since version 1.26: Use
Mbim.Message.ms_basic_connect_extensions_lte_attach_info_notification_parse
() instead.
- ms_basic_connect_extensions_lte_attach_status_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_lte_attach_status:
return location for a newly allocated #MbimLteAttachStatus, or
None
if the ‘LteAttachStatus’ field is not needed. Free the returned value withMbim.lte_attach_status_free
().
- Return type:
(
bool
, out_lte_attach_status:Mbim.DeprecatedLteAttachStatus
)
Parses and returns parameters of the ‘Lte Attach Status’ response command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.18.
Deprecated since version 1.26: Use
Mbim.Message.ms_basic_connect_extensions_lte_attach_info_response_parse
() instead.
- ms_basic_connect_extensions_pco_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_pco_value:
return location for a newly allocated
Mbim.PcoValue
, orNone
if the ‘PcoValue’ field is not needed. Free the returned value withMbim.PcoValue.free
().
- Return type:
(
bool
, out_pco_value:Mbim.PcoValue
)
Parses and returns parameters of the ‘PCO’ notification command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.18.
- ms_basic_connect_extensions_pco_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_pco_value:
return location for a newly allocated
Mbim.PcoValue
, orNone
if the ‘PcoValue’ field is not needed. Free the returned value withMbim.PcoValue.free
().
- Return type:
(
bool
, out_pco_value:Mbim.PcoValue
)
Parses and returns parameters of the ‘PCO’ response command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.18.
- ms_basic_connect_extensions_provisioned_contexts_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_provisioned_contexts_count:
return location for a #guint32, or
None
if the ‘ProvisionedContextsCount’ field is not needed.- out_provisioned_contexts:
return location for a newly allocated array of
Mbim.ProvisionedContextElementV2
items, orNone
if the ‘ProvisionedContexts’ field is not needed. Free the returned value withMbim.ProvisionedContextElementV2.array_free
().
- Return type:
(
bool
, out_provisioned_contexts_count:int
, out_provisioned_contexts: [Mbim.ProvisionedContextElementV2
])
Parses and returns parameters of the ‘Provisioned Contexts’ notification command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.28.
- ms_basic_connect_extensions_provisioned_contexts_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_provisioned_contexts_count:
return location for a #guint32, or
None
if the ‘ProvisionedContextsCount’ field is not needed.- out_provisioned_contexts:
return location for a newly allocated array of
Mbim.ProvisionedContextElementV2
items, orNone
if the ‘ProvisionedContexts’ field is not needed. Free the returned value withMbim.ProvisionedContextElementV2.array_free
().
- Return type:
(
bool
, out_provisioned_contexts_count:int
, out_provisioned_contexts: [Mbim.ProvisionedContextElementV2
])
Parses and returns parameters of the ‘Provisioned Contexts’ response command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.28.
- ms_basic_connect_extensions_slot_info_status_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_slot_index:
return location for a #guint32, or
None
if the ‘SlotIndex’ field is not needed.- out_state:
return location for a
Mbim.UiccSlotState
, orNone
if the ‘State’ field is not needed.
- Return type:
(
bool
, out_slot_index:int
, out_state:Mbim.UiccSlotState
)
Parses and returns parameters of the ‘Slot Info Status’ notification command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.26.
- ms_basic_connect_extensions_slot_info_status_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_slot_index:
return location for a #guint32, or
None
if the ‘SlotIndex’ field is not needed.- out_state:
return location for a
Mbim.UiccSlotState
, orNone
if the ‘State’ field is not needed.
- Return type:
(
bool
, out_slot_index:int
, out_state:Mbim.UiccSlotState
)
Parses and returns parameters of the ‘Slot Info Status’ response command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.26.
- ms_basic_connect_extensions_sys_caps_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_number_of_executors:
return location for a #guint32, or
None
if the ‘NumberOfExecutors’ field is not needed.- out_number_of_slots:
return location for a #guint32, or
None
if the ‘NumberOfSlots’ field is not needed.- out_concurrency:
return location for a #guint32, or
None
if the ‘Concurrency’ field is not needed.- out_modem_id:
return location for a #guint64, or
None
if the ‘ModemId’ field is not needed.
- Return type:
(
bool
, out_number_of_executors:int
, out_number_of_slots:int
, out_concurrency:int
, out_modem_id:int
)
Parses and returns parameters of the ‘Sys Caps’ response command in the ‘Ms Basic Connect Extensions’ service.
New in version 1.26.
- ms_basic_connect_extensions_v2_version_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- Return type:
(
bool
, out_mbim_version:int
, out_mbim_extended_version:int
)
Parses and returns parameters of the ‘Version’ response command in the ‘Ms Basic Connect Extensions V2’ service.
New in version 1.28.
- ms_basic_connect_extensions_v3_base_stations_info_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_system_type:
return location for a
Mbim.DataClassV3
, orNone
if the ‘SystemType’ field is not needed.- out_system_sub_type:
return location for a
Mbim.DataSubclass
, orNone
if the ‘SystemSubType’ field is not needed.- out_gsm_serving_cell:
return location for a newly allocated
Mbim.CellInfoServingGsm
, orNone
if the ‘GsmServingCell’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withMbim.CellInfoServingGsm.free
().- out_umts_serving_cell:
return location for a newly allocated
Mbim.CellInfoServingUmts
, orNone
if the ‘UmtsServingCell’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withMbim.CellInfoServingUmts.free
().- out_tdscdma_serving_cell:
return location for a newly allocated
Mbim.CellInfoServingTdscdma
, orNone
if the ‘TdscdmaServingCell’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withMbim.CellInfoServingTdscdma.free
().- out_lte_serving_cell:
return location for a newly allocated
Mbim.CellInfoServingLte
, orNone
if the ‘LteServingCell’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withMbim.CellInfoServingLte.free
().- out_gsm_neighboring_cells_count:
return location for a #guint32, or
None
if the field is not needed.- out_gsm_neighboring_cells:
return location for a newly allocated array of
Mbim.CellInfoNeighboringGsm
items, orNone
if the ‘GsmNeighboringCells’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withMbim.CellInfoNeighboringGsm.array_free
().- out_umts_neighboring_cells_count:
return location for a #guint32, or
None
if the field is not needed.- out_umts_neighboring_cells:
return location for a newly allocated array of
Mbim.CellInfoNeighboringUmts
items, orNone
if the ‘UmtsNeighboringCells’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withMbim.CellInfoNeighboringUmts.array_free
().- out_tdscdma_neighboring_cells_count:
return location for a #guint32, or
None
if the field is not needed.- out_tdscdma_neighboring_cells:
return location for a newly allocated array of
Mbim.CellInfoNeighboringTdscdma
items, orNone
if the ‘TdscdmaNeighboringCells’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withMbim.CellInfoNeighboringTdscdma.array_free
().- out_lte_neighboring_cells_count:
return location for a #guint32, or
None
if the field is not needed.- out_lte_neighboring_cells:
return location for a newly allocated array of
Mbim.CellInfoNeighboringLte
items, orNone
if the ‘LteNeighboringCells’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withMbim.CellInfoNeighboringLte.array_free
().- out_cdma_cells_count:
return location for a #guint32, or
None
if the field is not needed.- out_cdma_cells:
return location for a newly allocated array of
Mbim.CellInfoCdma
items, orNone
if the ‘CdmaCells’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withMbim.CellInfoCdma.array_free
().- out_nr_serving_cells_count:
return location for a #guint32, or
None
if the field is not needed.- out_nr_serving_cells:
return location for a newly allocated array of
Mbim.CellInfoServingNr
items, orNone
if the ‘NrServingCells’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withMbim.CellInfoServingNr.array_free
().- out_nr_neighbor_cells_count:
return location for a #guint32, or
None
if the field is not needed.- out_nr_neighbor_cells:
return location for a newly allocated array of
Mbim.CellInfoNeighboringNr
items, orNone
if the ‘NrNeighborCells’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withMbim.CellInfoNeighboringNr.array_free
().
- Return type:
(
bool
, out_system_type:Mbim.DataClassV3
, out_system_sub_type:Mbim.DataSubclass
, out_gsm_serving_cell:Mbim.CellInfoServingGsm
orNone
, out_umts_serving_cell:Mbim.CellInfoServingUmts
orNone
, out_tdscdma_serving_cell:Mbim.CellInfoServingTdscdma
orNone
, out_lte_serving_cell:Mbim.CellInfoServingLte
orNone
, out_gsm_neighboring_cells_count:int
, out_gsm_neighboring_cells: [Mbim.CellInfoNeighboringGsm
], out_umts_neighboring_cells_count:int
, out_umts_neighboring_cells: [Mbim.CellInfoNeighboringUmts
], out_tdscdma_neighboring_cells_count:int
, out_tdscdma_neighboring_cells: [Mbim.CellInfoNeighboringTdscdma
], out_lte_neighboring_cells_count:int
, out_lte_neighboring_cells: [Mbim.CellInfoNeighboringLte
], out_cdma_cells_count:int
, out_cdma_cells: [Mbim.CellInfoCdma
], out_nr_serving_cells_count:int
, out_nr_serving_cells: [Mbim.CellInfoServingNr
], out_nr_neighbor_cells_count:int
, out_nr_neighbor_cells: [Mbim.CellInfoNeighboringNr
])
Parses and returns parameters of the ‘Base Stations Info’ response command in the ‘Ms Basic Connect Extensions V3’ service.
New in version 1.28.
- ms_basic_connect_extensions_v3_device_caps_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_device_type:
return location for a
Mbim.DeviceType
, orNone
if the ‘DeviceType’ field is not needed.- out_cellular_class:
return location for a
Mbim.CellularClass
, orNone
if the ‘CellularClass’ field is not needed.- out_voice_class:
return location for a
Mbim.VoiceClass
, orNone
if the ‘VoiceClass’ field is not needed.- out_sim_class:
return location for a
Mbim.SimClass
, orNone
if the ‘SimClass’ field is not needed.- out_data_class:
return location for a
Mbim.DataClassV3
, orNone
if the ‘DataClass’ field is not needed.- out_sms_caps:
return location for a
Mbim.SmsCaps
, orNone
if the ‘SmsCaps’ field is not needed.- out_control_caps:
return location for a
Mbim.CtrlCaps
, orNone
if the ‘ControlCaps’ field is not needed.- out_data_subclass:
return location for a #guint64, or
None
if the ‘DataSubclass’ field is not needed.- out_max_sessions:
return location for a #guint32, or
None
if the ‘MaxSessions’ field is not needed.- out_executor_index:
return location for a #guint32, or
None
if the ‘ExecutorIndex’ field is not needed.- out_wcdma_band_class:
return location for a #guint32, or
None
if the ‘WcdmaBandClass’ field is not needed.- out_lte_band_class_count:
return location for a #guint32, or
None
if the field is not needed.- out_lte_band_class:
return location for a newly allocated array of #guint16 items, or
None
if the ‘LteBandClass’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withGLib.free
().- out_nr_band_class_count:
return location for a #guint32, or
None
if the field is not needed.- out_nr_band_class:
return location for a newly allocated array of #guint16 items, or
None
if the ‘NrBandClass’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withGLib.free
().- out_custom_data_class:
return location for a newly allocated string, or
None
if the ‘CustomDataClass’ field is not needed. Free the returned value withGLib.free
().- out_device_id:
return location for a newly allocated string, or
None
if the ‘DeviceId’ field is not needed. Free the returned value withGLib.free
().- out_firmware_info:
return location for a newly allocated string, or
None
if the ‘FirmwareInfo’ field is not needed. Free the returned value withGLib.free
().- out_hardware_info:
return location for a newly allocated string, or
None
if the ‘HardwareInfo’ field is not needed. Free the returned value withGLib.free
().
- Return type:
(
bool
, out_device_type:Mbim.DeviceType
, out_cellular_class:Mbim.CellularClass
, out_voice_class:Mbim.VoiceClass
, out_sim_class:Mbim.SimClass
, out_data_class:Mbim.DataClassV3
, out_sms_caps:Mbim.SmsCaps
, out_control_caps:Mbim.CtrlCaps
, out_data_subclass:Mbim.DataSubclass
, out_max_sessions:int
, out_executor_index:int
, out_wcdma_band_class:int
, out_lte_band_class_count:int
, out_lte_band_class:int
, out_nr_band_class_count:int
, out_nr_band_class:int
, out_custom_data_class:str
, out_device_id:str
, out_firmware_info:str
, out_hardware_info:str
)
Parses and returns parameters of the ‘Device Caps’ response command in the ‘Ms Basic Connect Extensions V3’ service.
New in version 1.28.
- ms_basic_connect_extensions_v3_lte_attach_info_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_lte_attach_state:
return location for a
Mbim.LteAttachState
, orNone
if the ‘LteAttachState’ field is not needed.- out_nw_error:
return location for a
Mbim.NwError
, orNone
if the ‘NwError’ field is not needed.- out_ip_type:
return location for a
Mbim.ContextIpType
, orNone
if the ‘IpType’ field is not needed.- out_access_string:
return location for a newly allocated string, or
None
if the ‘AccessString’ field is not needed. Free the returned value withGLib.free
().- out_user_name:
return location for a newly allocated string, or
None
if the ‘UserName’ field is not needed. Free the returned value withGLib.free
().- out_password:
return location for a newly allocated string, or
None
if the ‘Password’ field is not needed. Free the returned value withGLib.free
().- out_compression:
return location for a
Mbim.Compression
, orNone
if the ‘Compression’ field is not needed.- out_auth_protocol:
return location for a
Mbim.AuthProtocol
, orNone
if the ‘AuthProtocol’ field is not needed.
- Return type:
(
bool
, out_lte_attach_state:Mbim.LteAttachState
, out_nw_error:Mbim.NwError
, out_ip_type:Mbim.ContextIpType
, out_access_string:str
, out_user_name:str
, out_password:str
, out_compression:Mbim.Compression
, out_auth_protocol:Mbim.AuthProtocol
)
Parses and returns parameters of the ‘Lte Attach Info’ notification command in the ‘Ms Basic Connect Extensions V3’ service.
New in version 1.28.
- ms_basic_connect_extensions_v3_lte_attach_info_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_lte_attach_state:
return location for a
Mbim.LteAttachState
, orNone
if the ‘LteAttachState’ field is not needed.- out_nw_error:
return location for a
Mbim.NwError
, orNone
if the ‘NwError’ field is not needed.- out_ip_type:
return location for a
Mbim.ContextIpType
, orNone
if the ‘IpType’ field is not needed.- out_access_string:
return location for a newly allocated string, or
None
if the ‘AccessString’ field is not needed. Free the returned value withGLib.free
().- out_user_name:
return location for a newly allocated string, or
None
if the ‘UserName’ field is not needed. Free the returned value withGLib.free
().- out_password:
return location for a newly allocated string, or
None
if the ‘Password’ field is not needed. Free the returned value withGLib.free
().- out_compression:
return location for a
Mbim.Compression
, orNone
if the ‘Compression’ field is not needed.- out_auth_protocol:
return location for a
Mbim.AuthProtocol
, orNone
if the ‘AuthProtocol’ field is not needed.
- Return type:
(
bool
, out_lte_attach_state:Mbim.LteAttachState
, out_nw_error:Mbim.NwError
, out_ip_type:Mbim.ContextIpType
, out_access_string:str
, out_user_name:str
, out_password:str
, out_compression:Mbim.Compression
, out_auth_protocol:Mbim.AuthProtocol
)
Parses and returns parameters of the ‘Lte Attach Info’ response command in the ‘Ms Basic Connect Extensions V3’ service.
New in version 1.28.
- ms_basic_connect_extensions_v3_modem_configuration_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_modem_configuration_status:
return location for a
Mbim.ModemConfigurationStatus
, orNone
if the ‘ModemConfigurationStatus’ field is not needed.- out_configuration_name:
return location for a newly allocated string, or
None
if the ‘ConfigurationName’ field is not needed. Free the returned value withGLib.free
().- out_unnamed_ies:
return location for a newly allocated list of
Mbim.Tlv
items, orNone
if the ‘UnnamedIes’ field is not needed. Free the returned value with g_list_free_full() usingMbim.Tlv.unref
() asGLib.DestroyNotify
.
- Return type:
(
bool
, out_modem_configuration_status:Mbim.ModemConfigurationStatus
, out_configuration_name:str
, out_unnamed_ies: [Mbim.Tlv
])
Parses and returns parameters of the ‘Modem Configuration’ notification command in the ‘Ms Basic Connect Extensions V3’ service.
New in version 1.28.
- ms_basic_connect_extensions_v3_modem_configuration_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_configuration_status:
return location for a
Mbim.ModemConfigurationStatus
, orNone
if the ‘ConfigurationStatus’ field is not needed.- out_configuration_name:
return location for a newly allocated string, or
None
if the ‘ConfigurationName’ field is not needed. Free the returned value withGLib.free
().- out_unnamed_ies:
return location for a newly allocated list of
Mbim.Tlv
items, orNone
if the ‘UnnamedIes’ field is not needed. Free the returned value with g_list_free_full() usingMbim.Tlv.unref
() asGLib.DestroyNotify
.
- Return type:
(
bool
, out_configuration_status:Mbim.ModemConfigurationStatus
, out_configuration_name:str
, out_unnamed_ies: [Mbim.Tlv
])
Parses and returns parameters of the ‘Modem Configuration’ response command in the ‘Ms Basic Connect Extensions V3’ service.
New in version 1.28.
- ms_basic_connect_extensions_v3_registration_parameters_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_mico_mode:
return location for a
Mbim.MicoMode
, orNone
if the ‘MicoMode’ field is not needed.- out_drx_cycle:
return location for a
Mbim.DrxCycle
, orNone
if the ‘DrxCycle’ field is not needed.- out_ladn_info:
return location for a
Mbim.LadnInfo
, orNone
if the ‘LadnInfo’ field is not needed.- out_default_pdu_activation_hint:
return location for a
Mbim.DefaultPduActivationHint
, orNone
if the ‘DefaultPduActivationHint’ field is not needed.- out_re_register_if_nedeed:
return location for a
bool
, orNone
if the ‘ReRegisterIfNedeed’ field is not needed.- out_unnamed_ies:
return location for a newly allocated list of
Mbim.Tlv
items, orNone
if the ‘UnnamedIes’ field is not needed. Free the returned value with g_list_free_full() usingMbim.Tlv.unref
() asGLib.DestroyNotify
.
- Return type:
(
bool
, out_mico_mode:Mbim.MicoMode
, out_drx_cycle:Mbim.DrxCycle
, out_ladn_info:Mbim.LadnInfo
, out_default_pdu_activation_hint:Mbim.DefaultPduActivationHint
, out_re_register_if_nedeed:bool
, out_unnamed_ies: [Mbim.Tlv
])
Parses and returns parameters of the ‘Registration Parameters’ response command in the ‘Ms Basic Connect Extensions V3’ service.
New in version 1.28.
- ms_basic_connect_extensions_v3_wake_reason_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_wake_type:
return location for a
Mbim.WakeType
, orNone
if the ‘WakeType’ field is not needed.- out_session_id:
return location for a #guint32, or
None
if the ‘SessionId’ field is not needed.- out_wake_tlv:
return location for a newly allocated
Mbim.Tlv
, orNone
if the ‘WakeTlv’ field is not needed. Free the returned value withMbim.Tlv.unref
().
- Return type:
(
bool
, out_wake_type:Mbim.WakeType
, out_session_id:int
, out_wake_tlv:Mbim.Tlv
)
Parses and returns parameters of the ‘Wake Reason’ response command in the ‘Ms Basic Connect Extensions V3’ service.
New in version 1.28.
- ms_basic_connect_v2_packet_service_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_nw_error:
return location for a #guint32, or
None
if the ‘NwError’ field is not needed.- out_packet_service_state:
return location for a
Mbim.PacketServiceState
, orNone
if the ‘PacketServiceState’ field is not needed.- out_current_data_class:
return location for a
Mbim.DataClass
, orNone
if the ‘CurrentDataClass’ field is not needed.- out_uplink_speed:
return location for a #guint64, or
None
if the ‘UplinkSpeed’ field is not needed.- out_downlink_speed:
return location for a #guint64, or
None
if the ‘DownlinkSpeed’ field is not needed.- out_frequency_range:
return location for a
Mbim.FrequencyRange
, orNone
if the ‘FrequencyRange’ field is not needed.
- Return type:
(
bool
, out_nw_error:int
, out_packet_service_state:Mbim.PacketServiceState
, out_current_data_class:Mbim.DataClass
, out_uplink_speed:int
, out_downlink_speed:int
, out_frequency_range:Mbim.FrequencyRange
)
Parses and returns parameters of the ‘Packet Service’ notification command in the ‘Ms Basic Connect V2’ service.
New in version 1.28.
- ms_basic_connect_v2_packet_service_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_nw_error:
return location for a #guint32, or
None
if the ‘NwError’ field is not needed.- out_packet_service_state:
return location for a
Mbim.PacketServiceState
, orNone
if the ‘PacketServiceState’ field is not needed.- out_current_data_class:
return location for a
Mbim.DataClass
, orNone
if the ‘CurrentDataClass’ field is not needed.- out_uplink_speed:
return location for a #guint64, or
None
if the ‘UplinkSpeed’ field is not needed.- out_downlink_speed:
return location for a #guint64, or
None
if the ‘DownlinkSpeed’ field is not needed.- out_frequency_range:
return location for a
Mbim.FrequencyRange
, orNone
if the ‘FrequencyRange’ field is not needed.
- Return type:
(
bool
, out_nw_error:int
, out_packet_service_state:Mbim.PacketServiceState
, out_current_data_class:Mbim.DataClass
, out_uplink_speed:int
, out_downlink_speed:int
, out_frequency_range:Mbim.FrequencyRange
)
Parses and returns parameters of the ‘Packet Service’ response command in the ‘Ms Basic Connect V2’ service.
New in version 1.28.
- ms_basic_connect_v2_register_state_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_nw_error:
return location for a
Mbim.NwError
, orNone
if the ‘NwError’ field is not needed.- out_register_state:
return location for a
Mbim.RegisterState
, orNone
if the ‘RegisterState’ field is not needed.- out_register_mode:
return location for a
Mbim.RegisterMode
, orNone
if the ‘RegisterMode’ field is not needed.- out_available_data_classes:
return location for a
Mbim.DataClass
, orNone
if the ‘AvailableDataClasses’ field is not needed.- out_current_cellular_class:
return location for a
Mbim.CellularClass
, orNone
if the ‘CurrentCellularClass’ field is not needed.- out_provider_id:
return location for a newly allocated string, or
None
if the ‘ProviderId’ field is not needed. Free the returned value withGLib.free
().- out_provider_name:
return location for a newly allocated string, or
None
if the ‘ProviderName’ field is not needed. Free the returned value withGLib.free
().- out_roaming_text:
return location for a newly allocated string, or
None
if the ‘RoamingText’ field is not needed. Free the returned value withGLib.free
().- out_registration_flag:
return location for a
Mbim.RegistrationFlag
, orNone
if the ‘RegistrationFlag’ field is not needed.- out_preferred_data_classes:
return location for a
Mbim.DataClass
, orNone
if the ‘PreferredDataClasses’ field is not needed.
- Return type:
(
bool
, out_nw_error:Mbim.NwError
, out_register_state:Mbim.RegisterState
, out_register_mode:Mbim.RegisterMode
, out_available_data_classes:Mbim.DataClass
, out_current_cellular_class:Mbim.CellularClass
, out_provider_id:str
, out_provider_name:str
, out_roaming_text:str
, out_registration_flag:Mbim.RegistrationFlag
, out_preferred_data_classes:Mbim.DataClass
)
Parses and returns parameters of the ‘Register State’ notification command in the ‘Ms Basic Connect V2’ service.
New in version 1.28.
- ms_basic_connect_v2_register_state_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_nw_error:
return location for a
Mbim.NwError
, orNone
if the ‘NwError’ field is not needed.- out_register_state:
return location for a
Mbim.RegisterState
, orNone
if the ‘RegisterState’ field is not needed.- out_register_mode:
return location for a
Mbim.RegisterMode
, orNone
if the ‘RegisterMode’ field is not needed.- out_available_data_classes:
return location for a
Mbim.DataClass
, orNone
if the ‘AvailableDataClasses’ field is not needed.- out_current_cellular_class:
return location for a
Mbim.CellularClass
, orNone
if the ‘CurrentCellularClass’ field is not needed.- out_provider_id:
return location for a newly allocated string, or
None
if the ‘ProviderId’ field is not needed. Free the returned value withGLib.free
().- out_provider_name:
return location for a newly allocated string, or
None
if the ‘ProviderName’ field is not needed. Free the returned value withGLib.free
().- out_roaming_text:
return location for a newly allocated string, or
None
if the ‘RoamingText’ field is not needed. Free the returned value withGLib.free
().- out_registration_flag:
return location for a
Mbim.RegistrationFlag
, orNone
if the ‘RegistrationFlag’ field is not needed.- out_preferred_data_classes:
return location for a
Mbim.DataClass
, orNone
if the ‘PreferredDataClasses’ field is not needed.
- Return type:
(
bool
, out_nw_error:Mbim.NwError
, out_register_state:Mbim.RegisterState
, out_register_mode:Mbim.RegisterMode
, out_available_data_classes:Mbim.DataClass
, out_current_cellular_class:Mbim.CellularClass
, out_provider_id:str
, out_provider_name:str
, out_roaming_text:str
, out_registration_flag:Mbim.RegistrationFlag
, out_preferred_data_classes:Mbim.DataClass
)
Parses and returns parameters of the ‘Register State’ response command in the ‘Ms Basic Connect V2’ service.
New in version 1.28.
- ms_basic_connect_v2_signal_state_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_rssi:
return location for a #guint32, or
None
if the ‘Rssi’ field is not needed.- out_error_rate:
return location for a #guint32, or
None
if the ‘ErrorRate’ field is not needed.- out_signal_strength_interval:
return location for a #guint32, or
None
if the ‘SignalStrengthInterval’ field is not needed.- out_rssi_threshold:
return location for a #guint32, or
None
if the ‘RssiThreshold’ field is not needed.- out_error_rate_threshold:
return location for a #guint32, or
None
if the ‘ErrorRateThreshold’ field is not needed.- out_rsrp_snr_count:
return location for a #guint32, or
None
if the field is not needed.- out_rsrp_snr:
return location for a newly allocated array of
Mbim.RsrpSnrInfo
items, orNone
if the ‘RsrpSnr’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withMbim.RsrpSnrInfo.array_free
().
- Return type:
(
bool
, out_rssi:int
, out_error_rate:int
, out_signal_strength_interval:int
, out_rssi_threshold:int
, out_error_rate_threshold:int
, out_rsrp_snr_count:int
, out_rsrp_snr: [Mbim.RsrpSnrInfo
])
Parses and returns parameters of the ‘Signal State’ notification command in the ‘Ms Basic Connect V2’ service.
New in version 1.28.
- ms_basic_connect_v2_signal_state_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_rssi:
return location for a #guint32, or
None
if the ‘Rssi’ field is not needed.- out_error_rate:
return location for a #guint32, or
None
if the ‘ErrorRate’ field is not needed.- out_signal_strength_interval:
return location for a #guint32, or
None
if the ‘SignalStrengthInterval’ field is not needed.- out_rssi_threshold:
return location for a #guint32, or
None
if the ‘RssiThreshold’ field is not needed.- out_error_rate_threshold:
return location for a #guint32, or
None
if the ‘ErrorRateThreshold’ field is not needed.- out_rsrp_snr_count:
return location for a #guint32, or
None
if the field is not needed.- out_rsrp_snr:
return location for a newly allocated array of
Mbim.RsrpSnrInfo
items, orNone
if the ‘RsrpSnr’ field is not needed. The availability of this field is not always guaranteed, and thereforeNone
may be given as a valid output. Free the returned value withMbim.RsrpSnrInfo.array_free
().
- Return type:
(
bool
, out_rssi:int
, out_error_rate:int
, out_signal_strength_interval:int
, out_rssi_threshold:int
, out_error_rate_threshold:int
, out_rsrp_snr_count:int
, out_rsrp_snr: [Mbim.RsrpSnrInfo
])
Parses and returns parameters of the ‘Signal State’ response command in the ‘Ms Basic Connect V2’ service.
New in version 1.28.
- ms_basic_connect_v3_connect_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_session_id:
return location for a #guint32, or
None
if the ‘SessionId’ field is not needed.- out_activation_state:
return location for a
Mbim.ActivationState
, orNone
if the ‘ActivationState’ field is not needed.- out_voice_call_state:
return location for a
Mbim.VoiceCallState
, orNone
if the ‘VoiceCallState’ field is not needed.- out_ip_type:
return location for a
Mbim.ContextIpType
, orNone
if the ‘IpType’ field is not needed.- out_context_type:
return location for a
Mbim.Uuid
, orNone
if the ‘ContextType’ field is not needed. Do not free the returned value, it is owned by self.- out_nw_error:
return location for a #guint32, or
None
if the ‘NwError’ field is not needed.- out_media_preference:
return location for a
Mbim.AccessMediaType
, orNone
if the ‘MediaPreference’ field is not needed.- out_access_string:
return location for a newly allocated string, or
None
if the ‘AccessString’ field is not needed. Free the returned value withGLib.free
().- out_unnamed_ies:
return location for a newly allocated list of
Mbim.Tlv
items, orNone
if the ‘UnnamedIes’ field is not needed. Free the returned value with g_list_free_full() usingMbim.Tlv.unref
() asGLib.DestroyNotify
.
- Return type:
(
bool
, out_session_id:int
, out_activation_state:Mbim.ActivationState
, out_voice_call_state:Mbim.VoiceCallState
, out_ip_type:Mbim.ContextIpType
, out_context_type:Mbim.Uuid
, out_nw_error:int
, out_media_preference:Mbim.AccessMediaType
, out_access_string:str
, out_unnamed_ies: [Mbim.Tlv
])
Parses and returns parameters of the ‘Connect’ notification command in the ‘Ms Basic Connect V3’ service.
New in version 1.28.
- ms_basic_connect_v3_connect_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_session_id:
return location for a #guint32, or
None
if the ‘SessionId’ field is not needed.- out_activation_state:
return location for a
Mbim.ActivationState
, orNone
if the ‘ActivationState’ field is not needed.- out_voice_call_state:
return location for a
Mbim.VoiceCallState
, orNone
if the ‘VoiceCallState’ field is not needed.- out_ip_type:
return location for a
Mbim.ContextIpType
, orNone
if the ‘IpType’ field is not needed.- out_context_type:
return location for a
Mbim.Uuid
, orNone
if the ‘ContextType’ field is not needed. Do not free the returned value, it is owned by self.- out_nw_error:
return location for a #guint32, or
None
if the ‘NwError’ field is not needed.- out_media_preference:
return location for a
Mbim.AccessMediaType
, orNone
if the ‘MediaPreference’ field is not needed.- out_access_string:
return location for a newly allocated string, or
None
if the ‘AccessString’ field is not needed. Free the returned value withGLib.free
().- out_unnamed_ies:
return location for a newly allocated list of
Mbim.Tlv
items, orNone
if the ‘UnnamedIes’ field is not needed. Free the returned value with g_list_free_full() usingMbim.Tlv.unref
() asGLib.DestroyNotify
.
- Return type:
(
bool
, out_session_id:int
, out_activation_state:Mbim.ActivationState
, out_voice_call_state:Mbim.VoiceCallState
, out_ip_type:Mbim.ContextIpType
, out_context_type:Mbim.Uuid
, out_nw_error:int
, out_media_preference:Mbim.AccessMediaType
, out_access_string:str
, out_unnamed_ies: [Mbim.Tlv
])
Parses and returns parameters of the ‘Connect’ response command in the ‘Ms Basic Connect V3’ service.
New in version 1.28.
- ms_basic_connect_v3_ip_packet_filters_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_session_id:
return location for a #guint32, or
None
if the ‘SessionId’ field is not needed.- out_packet_filters_count:
return location for a #guint32, or
None
if the ‘PacketFiltersCount’ field is not needed.- out_packet_filters:
return location for a newly allocated array of
Mbim.PacketFilterV3
items, orNone
if the ‘PacketFilters’ field is not needed. Free the returned value withMbim.PacketFilterV3.array_free
().
- Return type:
(
bool
, out_session_id:int
, out_packet_filters_count:int
, out_packet_filters: [Mbim.PacketFilterV3
])
Parses and returns parameters of the ‘IP Packet Filters’ response command in the ‘Ms Basic Connect V3’ service.
New in version 1.28.
- ms_basic_connect_v3_packet_service_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_nw_error:
return location for a #guint32, or
None
if the ‘NwError’ field is not needed.- out_packet_service_state:
return location for a
Mbim.PacketServiceState
, orNone
if the ‘PacketServiceState’ field is not needed.- out_highest_available_data_class:
return location for a
Mbim.DataClassV3
, orNone
if the ‘HighestAvailableDataClass’ field is not needed.- out_uplink_speed:
return location for a #guint64, or
None
if the ‘UplinkSpeed’ field is not needed.- out_downlink_speed:
return location for a #guint64, or
None
if the ‘DownlinkSpeed’ field is not needed.- out_frequency_range:
return location for a
Mbim.FrequencyRange
, orNone
if the ‘FrequencyRange’ field is not needed.- out_data_subclass:
return location for a
Mbim.DataSubclass
, orNone
if the ‘DataSubclass’ field is not needed.- out_tai:
return location for a newly allocated
Mbim.Tai
, orNone
if the ‘Tai’ field is not needed. Free the returned value withMbim.Tai.free
().
- Return type:
(
bool
, out_nw_error:int
, out_packet_service_state:Mbim.PacketServiceState
, out_highest_available_data_class:Mbim.DataClassV3
, out_uplink_speed:int
, out_downlink_speed:int
, out_frequency_range:Mbim.FrequencyRange
, out_data_subclass:Mbim.DataSubclass
, out_tai:Mbim.Tai
)
Parses and returns parameters of the ‘Packet Service’ notification command in the ‘Ms Basic Connect V3’ service.
New in version 1.28.
- ms_basic_connect_v3_packet_service_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_nw_error:
return location for a #guint32, or
None
if the ‘NwError’ field is not needed.- out_packet_service_state:
return location for a
Mbim.PacketServiceState
, orNone
if the ‘PacketServiceState’ field is not needed.- out_highest_available_data_class:
return location for a
Mbim.DataClassV3
, orNone
if the ‘HighestAvailableDataClass’ field is not needed.- out_uplink_speed:
return location for a #guint64, or
None
if the ‘UplinkSpeed’ field is not needed.- out_downlink_speed:
return location for a #guint64, or
None
if the ‘DownlinkSpeed’ field is not needed.- out_frequency_range:
return location for a
Mbim.FrequencyRange
, orNone
if the ‘FrequencyRange’ field is not needed.- out_data_subclass:
return location for a
Mbim.DataSubclass
, orNone
if the ‘DataSubclass’ field is not needed.- out_tai:
return location for a newly allocated
Mbim.Tai
, orNone
if the ‘Tai’ field is not needed. Free the returned value withMbim.Tai.free
().
- Return type:
(
bool
, out_nw_error:int
, out_packet_service_state:Mbim.PacketServiceState
, out_highest_available_data_class:Mbim.DataClassV3
, out_uplink_speed:int
, out_downlink_speed:int
, out_frequency_range:Mbim.FrequencyRange
, out_data_subclass:Mbim.DataSubclass
, out_tai:Mbim.Tai
)
Parses and returns parameters of the ‘Packet Service’ response command in the ‘Ms Basic Connect V3’ service.
New in version 1.28.
- ms_basic_connect_v3_subscriber_ready_status_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_ready_state:
return location for a
Mbim.SubscriberReadyState
, orNone
if the ‘ReadyState’ field is not needed.- out_flags:
return location for a
Mbim.SubscriberReadyStatusFlag
, orNone
if the ‘Flags’ field is not needed.- out_subscriber_id:
return location for a newly allocated string, or
None
if the ‘SubscriberId’ field is not needed. Free the returned value withGLib.free
().- out_sim_icc_id:
return location for a newly allocated string, or
None
if the ‘SimIccId’ field is not needed. Free the returned value withGLib.free
().- out_ready_info:
return location for a
Mbim.ReadyInfoFlag
, orNone
if the ‘ReadyInfo’ field is not needed.- out_telephone_numbers_count:
return location for a #guint32, or
None
if the ‘TelephoneNumbersCount’ field is not needed.- out_telephone_numbers:
return location for a newly allocated array of strings, or
None
if the ‘TelephoneNumbers’ field is not needed. Free the returned value withGLib.strfreev
().
- Return type:
(
bool
, out_ready_state:Mbim.SubscriberReadyState
, out_flags:Mbim.SubscriberReadyStatusFlag
, out_subscriber_id:str
, out_sim_icc_id:str
, out_ready_info:Mbim.ReadyInfoFlag
, out_telephone_numbers_count:int
, out_telephone_numbers: [str
])
Parses and returns parameters of the ‘Subscriber Ready Status’ notification command in the ‘Ms Basic Connect V3’ service.
New in version 1.28.
- ms_basic_connect_v3_subscriber_ready_status_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_ready_state:
return location for a
Mbim.SubscriberReadyState
, orNone
if the ‘ReadyState’ field is not needed.- out_flags:
return location for a
Mbim.SubscriberReadyStatusFlag
, orNone
if the ‘Flags’ field is not needed.- out_subscriber_id:
return location for a newly allocated string, or
None
if the ‘SubscriberId’ field is not needed. Free the returned value withGLib.free
().- out_sim_icc_id:
return location for a newly allocated string, or
None
if the ‘SimIccId’ field is not needed. Free the returned value withGLib.free
().- out_ready_info:
return location for a
Mbim.ReadyInfoFlag
, orNone
if the ‘ReadyInfo’ field is not needed.- out_telephone_numbers_count:
return location for a #guint32, or
None
if the ‘TelephoneNumbersCount’ field is not needed.- out_telephone_numbers:
return location for a newly allocated array of strings, or
None
if the ‘TelephoneNumbers’ field is not needed. Free the returned value withGLib.strfreev
().
- Return type:
(
bool
, out_ready_state:Mbim.SubscriberReadyState
, out_flags:Mbim.SubscriberReadyStatusFlag
, out_subscriber_id:str
, out_sim_icc_id:str
, out_ready_info:Mbim.ReadyInfoFlag
, out_telephone_numbers_count:int
, out_telephone_numbers: [str
])
Parses and returns parameters of the ‘Subscriber Ready Status’ response command in the ‘Ms Basic Connect V3’ service.
New in version 1.28.
- ms_firmware_id_get_response_parse()¶
-
Parses and returns parameters of the ‘Get’ response command in the ‘MS Firmware ID’ service.
New in version 1.8.
- ms_sar_config_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_mode:
return location for a
Mbim.SarControlMode
, orNone
if the ‘Mode’ field is not needed.- out_backoff_state:
return location for a
Mbim.SarBackoffState
, orNone
if the ‘BackoffState’ field is not needed.- out_wifi_integration:
return location for a
Mbim.SarWifiHardwareState
, orNone
if the ‘WifiIntegration’ field is not needed.- out_config_states_count:
return location for a #guint32, or
None
if the ‘ConfigStatesCount’ field is not needed.- out_config_states:
return location for a newly allocated array of
Mbim.SarConfigState
items, orNone
if the ‘ConfigStates’ field is not needed. Free the returned value withMbim.SarConfigState.array_free
().
- Return type:
(
bool
, out_mode:Mbim.SarControlMode
, out_backoff_state:Mbim.SarBackoffState
, out_wifi_integration:Mbim.SarWifiHardwareState
, out_config_states_count:int
, out_config_states: [Mbim.SarConfigState
])
Parses and returns parameters of the ‘Config’ response command in the ‘MS SAR’ service.
New in version 1.26.
- ms_sar_transmission_status_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_channel_notification:
return location for a
Mbim.TransmissionNotificationStatus
, orNone
if the ‘ChannelNotification’ field is not needed.- out_transmission_status:
return location for a
Mbim.TransmissionState
, orNone
if the ‘TransmissionStatus’ field is not needed.- out_hysteresis_timer:
return location for a #guint32, or
None
if the ‘HysteresisTimer’ field is not needed.
- Return type:
(
bool
, out_channel_notification:Mbim.TransmissionNotificationStatus
, out_transmission_status:Mbim.TransmissionState
, out_hysteresis_timer:int
)
Parses and returns parameters of the ‘Transmission status’ notification command in the ‘MS SAR’ service.
New in version 1.26.
- ms_sar_transmission_status_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_channel_notification:
return location for a
Mbim.TransmissionNotificationStatus
, orNone
if the ‘ChannelNotification’ field is not needed.- out_transmission_status:
return location for a
Mbim.TransmissionState
, orNone
if the ‘TransmissionStatus’ field is not needed.- out_hysteresis_timer:
return location for a #guint32, or
None
if the ‘HysteresisTimer’ field is not needed.
- Return type:
(
bool
, out_channel_notification:Mbim.TransmissionNotificationStatus
, out_transmission_status:Mbim.TransmissionState
, out_hysteresis_timer:int
)
Parses and returns parameters of the ‘Transmission status’ response command in the ‘MS SAR’ service.
New in version 1.26.
- ms_uicc_low_level_access_apdu_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_status:
return location for a #guint32, or
None
if the ‘Status’ field is not needed.- out_response:
return location for an array of #guint8 values. Do not free the returned value, it is owned by self.
- Return type:
Parses and returns parameters of the ‘APDU’ response command in the ‘MS UICC Low Level Access’ service.
New in version 1.26.
- ms_uicc_low_level_access_application_list_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_version:
return location for a #guint32, or
None
if the ‘Version’ field is not needed.- out_application_count:
return location for a #guint32, or
None
if the ‘ApplicationCount’ field is not needed.- out_active_application_index:
return location for a #guint32, or
None
if the ‘ActiveApplicationIndex’ field is not needed.- out_application_list_size_bytes:
return location for a #guint32, or
None
if the ‘ApplicationListSizeBytes’ field is not needed.- out_applications:
return location for a newly allocated array of
Mbim.UiccApplication
items, orNone
if the ‘Applications’ field is not needed. Free the returned value withMbim.UiccApplication.array_free
().
- Return type:
(
bool
, out_version:int
, out_application_count:int
, out_active_application_index:int
, out_application_list_size_bytes:int
, out_applications: [Mbim.UiccApplication
])
Parses and returns parameters of the ‘Application List’ response command in the ‘MS UICC Low Level Access’ service.
New in version 1.28.
- ms_uicc_low_level_access_atr_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_atr:
return location for an array of #guint8 values. Do not free the returned value, it is owned by self.
- Return type:
Parses and returns parameters of the ‘ATR’ response command in the ‘MS UICC Low Level Access’ service.
New in version 1.26.
- ms_uicc_low_level_access_close_channel_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_status:
return location for a #guint32, or
None
if the ‘Status’ field is not needed.
- Return type:
Parses and returns parameters of the ‘Close Channel’ response command in the ‘MS UICC Low Level Access’ service.
New in version 1.26.
- ms_uicc_low_level_access_file_status_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_version:
return location for a #guint32, or
None
if the ‘Version’ field is not needed.- out_status_word1:
return location for a #guint32, or
None
if the ‘StatusWord1’ field is not needed.- out_status_word2:
return location for a #guint32, or
None
if the ‘StatusWord2’ field is not needed.- out_file_accessibility:
return location for a
Mbim.UiccFileAccessibility
, orNone
if the ‘FileAccessibility’ field is not needed.- out_file_type:
return location for a
Mbim.UiccFileType
, orNone
if the ‘FileType’ field is not needed.- out_file_structure:
return location for a
Mbim.UiccFileStructure
, orNone
if the ‘FileStructure’ field is not needed.- out_file_item_count:
return location for a #guint32, or
None
if the ‘FileItemCount’ field is not needed.- out_file_item_size:
return location for a #guint32, or
None
if the ‘FileItemSize’ field is not needed.- out_access_condition_read:
return location for a
Mbim.PinType
, orNone
if the ‘AccessConditionRead’ field is not needed.- out_access_condition_update:
return location for a
Mbim.PinType
, orNone
if the ‘AccessConditionUpdate’ field is not needed.- out_access_condition_activate:
return location for a
Mbim.PinType
, orNone
if the ‘AccessConditionActivate’ field is not needed.- out_access_condition_deactivate:
return location for a
Mbim.PinType
, orNone
if the ‘AccessConditionDeactivate’ field is not needed.
- Return type:
(
bool
, out_version:int
, out_status_word1:int
, out_status_word2:int
, out_file_accessibility:Mbim.UiccFileAccessibility
, out_file_type:Mbim.UiccFileType
, out_file_structure:Mbim.UiccFileStructure
, out_file_item_count:int
, out_file_item_size:int
, out_access_condition_read:Mbim.PinType
, out_access_condition_update:Mbim.PinType
, out_access_condition_activate:Mbim.PinType
, out_access_condition_deactivate:Mbim.PinType
)
Parses and returns parameters of the ‘File Status’ response command in the ‘MS UICC Low Level Access’ service.
New in version 1.28.
- ms_uicc_low_level_access_open_channel_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- Return type:
(
bool
, out_status:int
, out_channel:int
, out_response:bytes
)
Parses and returns parameters of the ‘Open Channel’ response command in the ‘MS UICC Low Level Access’ service.
New in version 1.26.
- ms_uicc_low_level_access_read_binary_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_version:
return location for a #guint32, or
None
if the ‘Version’ field is not needed.- out_status_word1:
return location for a #guint32, or
None
if the ‘StatusWord1’ field is not needed.- out_status_word2:
return location for a #guint32, or
None
if the ‘StatusWord2’ field is not needed.- out_data:
return location for an array of #guint8 values. Do not free the returned value, it is owned by self.
- Return type:
(
bool
, out_version:int
, out_status_word1:int
, out_status_word2:int
, out_data:bytes
)
Parses and returns parameters of the ‘Read Binary’ response command in the ‘MS UICC Low Level Access’ service.
New in version 1.28.
- ms_uicc_low_level_access_read_record_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_version:
return location for a #guint32, or
None
if the ‘Version’ field is not needed.- out_status_word1:
return location for a #guint32, or
None
if the ‘StatusWord1’ field is not needed.- out_status_word2:
return location for a #guint32, or
None
if the ‘StatusWord2’ field is not needed.- out_data:
return location for an array of #guint8 values. Do not free the returned value, it is owned by self.
- Return type:
(
bool
, out_version:int
, out_status_word1:int
, out_status_word2:int
, out_data:bytes
)
Parses and returns parameters of the ‘Read Record’ response command in the ‘MS UICC Low Level Access’ service.
New in version 1.28.
- ms_uicc_low_level_access_reset_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_pass_through_status:
return location for a
Mbim.UiccPassThroughStatus
, orNone
if the ‘PassThroughStatus’ field is not needed.
- Return type:
(
bool
, out_pass_through_status:Mbim.UiccPassThroughStatus
)
Parses and returns parameters of the ‘Reset’ response command in the ‘MS UICC Low Level Access’ service.
New in version 1.26.
- ms_uicc_low_level_access_terminal_capability_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_terminal_capability_count:
return location for a #guint32, or
None
if the ‘TerminalCapabilityCount’ field is not needed.- out_terminal_capability:
return location for a newly allocated array of
Mbim.TerminalCapabilityInfo
items, orNone
if the ‘TerminalCapability’ field is not needed. Free the returned value withMbim.TerminalCapabilityInfo.array_free
().
- Return type:
(
bool
, out_terminal_capability_count:int
, out_terminal_capability: [Mbim.TerminalCapabilityInfo
])
Parses and returns parameters of the ‘Terminal Capability’ response command in the ‘MS UICC Low Level Access’ service.
New in version 1.26.
- ms_voice_extensions_nitz_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_year:
return location for a #guint32, or
None
if the ‘Year’ field is not needed.- out_month:
return location for a #guint32, or
None
if the ‘Month’ field is not needed.- out_day:
return location for a #guint32, or
None
if the ‘Day’ field is not needed.- out_hour:
return location for a #guint32, or
None
if the ‘Hour’ field is not needed.- out_minute:
return location for a #guint32, or
None
if the ‘Minute’ field is not needed.- out_second:
return location for a #guint32, or
None
if the ‘Second’ field is not needed.- out_time_zone_offset_minutes:
return location for a #guint32, or
None
if the ‘TimeZoneOffsetMinutes’ field is not needed.- out_daylight_saving_time_offset_minutes:
return location for a #guint32, or
None
if the ‘DaylightSavingTimeOffsetMinutes’ field is not needed.- out_data_class:
return location for a
Mbim.DataClass
, orNone
if the ‘DataClass’ field is not needed.
- Return type:
(
bool
, out_year:int
, out_month:int
, out_day:int
, out_hour:int
, out_minute:int
, out_second:int
, out_time_zone_offset_minutes:int
, out_daylight_saving_time_offset_minutes:int
, out_data_class:Mbim.DataClass
)
Parses and returns parameters of the ‘NITZ’ notification command in the ‘MS Voice Extensions’ service.
New in version 1.28.
- ms_voice_extensions_nitz_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_year:
return location for a #guint32, or
None
if the ‘Year’ field is not needed.- out_month:
return location for a #guint32, or
None
if the ‘Month’ field is not needed.- out_day:
return location for a #guint32, or
None
if the ‘Day’ field is not needed.- out_hour:
return location for a #guint32, or
None
if the ‘Hour’ field is not needed.- out_minute:
return location for a #guint32, or
None
if the ‘Minute’ field is not needed.- out_second:
return location for a #guint32, or
None
if the ‘Second’ field is not needed.- out_time_zone_offset_minutes:
return location for a #guint32, or
None
if the ‘TimeZoneOffsetMinutes’ field is not needed.- out_daylight_saving_time_offset_minutes:
return location for a #guint32, or
None
if the ‘DaylightSavingTimeOffsetMinutes’ field is not needed.- out_data_class:
return location for a
Mbim.DataClass
, orNone
if the ‘DataClass’ field is not needed.
- Return type:
(
bool
, out_year:int
, out_month:int
, out_day:int
, out_hour:int
, out_minute:int
, out_second:int
, out_time_zone_offset_minutes:int
, out_daylight_saving_time_offset_minutes:int
, out_data_class:Mbim.DataClass
)
Parses and returns parameters of the ‘NITZ’ response command in the ‘MS Voice Extensions’ service.
New in version 1.28.
- multicarrier_providers_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_providers_count:
return location for a #guint32, or
None
if the ‘ProvidersCount’ field is not needed.- out_providers:
return location for a newly allocated array of
Mbim.Provider
items, orNone
if the ‘Providers’ field is not needed. Free the returned value withMbim.Provider.array_free
().
- Return type:
(
bool
, out_providers_count:int
, out_providers: [Mbim.Provider
])
Parses and returns parameters of the ‘Multicarrier Providers’ notification command in the ‘Basic Connect’ service.
New in version 1.8.
- multicarrier_providers_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_providers_count:
return location for a #guint32, or
None
if the ‘ProvidersCount’ field is not needed.- out_providers:
return location for a newly allocated array of
Mbim.Provider
items, orNone
if the ‘Providers’ field is not needed. Free the returned value withMbim.Provider.array_free
().
- Return type:
(
bool
, out_providers_count:int
, out_providers: [Mbim.Provider
])
Parses and returns parameters of the ‘Multicarrier Providers’ response command in the ‘Basic Connect’ service.
New in version 1.4.
- network_idle_hint_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_state:
return location for a
Mbim.NetworkIdleHintState
, orNone
if the ‘State’ field is not needed.
- Return type:
(
bool
, out_state:Mbim.NetworkIdleHintState
)
Parses and returns parameters of the ‘Network Idle Hint’ response command in the ‘Basic Connect’ service.
New in version 1.4.
- open_done_get_result()¶
- Raises:
- Returns:
- Return type:
Gets the result of the ‘Open’ operation in the
Mbim.MessageType.OPEN_DONE
message.New in version 1.0.
- open_done_get_status_code()¶
- Returns:
- Return type:
Get status code from the
Mbim.MessageType.OPEN_DONE
message.New in version 1.0.
- open_get_max_control_transfer()¶
- Returns:
the maximum control transfer.
- Return type:
Get the maximum control transfer set to be used in the
Mbim.Message
of typeMbim.MessageType.OPEN
.New in version 1.0.
- packet_service_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_nw_error:
return location for a #guint32, or
None
if the ‘NwError’ field is not needed.- out_packet_service_state:
return location for a
Mbim.PacketServiceState
, orNone
if the ‘PacketServiceState’ field is not needed.- out_highest_available_data_class:
return location for a
Mbim.DataClass
, orNone
if the ‘HighestAvailableDataClass’ field is not needed.- out_uplink_speed:
return location for a #guint64, or
None
if the ‘UplinkSpeed’ field is not needed.- out_downlink_speed:
return location for a #guint64, or
None
if the ‘DownlinkSpeed’ field is not needed.
- Return type:
(
bool
, out_nw_error:int
, out_packet_service_state:Mbim.PacketServiceState
, out_highest_available_data_class:Mbim.DataClass
, out_uplink_speed:int
, out_downlink_speed:int
)
Parses and returns parameters of the ‘Packet Service’ notification command in the ‘Basic Connect’ service.
New in version 1.0.
- packet_service_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_nw_error:
return location for a #guint32, or
None
if the ‘NwError’ field is not needed.- out_packet_service_state:
return location for a
Mbim.PacketServiceState
, orNone
if the ‘PacketServiceState’ field is not needed.- out_highest_available_data_class:
return location for a
Mbim.DataClass
, orNone
if the ‘HighestAvailableDataClass’ field is not needed.- out_uplink_speed:
return location for a #guint64, or
None
if the ‘UplinkSpeed’ field is not needed.- out_downlink_speed:
return location for a #guint64, or
None
if the ‘DownlinkSpeed’ field is not needed.
- Return type:
(
bool
, out_nw_error:int
, out_packet_service_state:Mbim.PacketServiceState
, out_highest_available_data_class:Mbim.DataClass
, out_uplink_speed:int
, out_downlink_speed:int
)
Parses and returns parameters of the ‘Packet Service’ response command in the ‘Basic Connect’ service.
New in version 1.0.
- packet_statistics_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_in_discards:
return location for a #guint32, or
None
if the ‘InDiscards’ field is not needed.- out_in_errors:
return location for a #guint32, or
None
if the ‘InErrors’ field is not needed.- out_in_octets:
return location for a #guint64, or
None
if the ‘InOctets’ field is not needed.- out_in_packets:
return location for a #guint64, or
None
if the ‘InPackets’ field is not needed.- out_out_octets:
return location for a #guint64, or
None
if the ‘OutOctets’ field is not needed.- out_out_packets:
return location for a #guint64, or
None
if the ‘OutPackets’ field is not needed.- out_out_errors:
return location for a #guint32, or
None
if the ‘OutErrors’ field is not needed.- out_out_discards:
return location for a #guint32, or
None
if the ‘OutDiscards’ field is not needed.
- Return type:
(
bool
, out_in_discards:int
, out_in_errors:int
, out_in_octets:int
, out_in_packets:int
, out_out_octets:int
, out_out_packets:int
, out_out_errors:int
, out_out_discards:int
)
Parses and returns parameters of the ‘Packet Statistics’ response command in the ‘Basic Connect’ service.
New in version 1.4.
- phonebook_configuration_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_state:
return location for a
Mbim.PhonebookState
, orNone
if the ‘State’ field is not needed.- out_number_of_entries:
return location for a #guint32, or
None
if the ‘NumberOfEntries’ field is not needed.- out_used_entries:
return location for a #guint32, or
None
if the ‘UsedEntries’ field is not needed.- out_max_number_length:
return location for a #guint32, or
None
if the ‘MaxNumberLength’ field is not needed.- out_max_name:
return location for a #guint32, or
None
if the ‘MaxName’ field is not needed.
- Return type:
(
bool
, out_state:Mbim.PhonebookState
, out_number_of_entries:int
, out_used_entries:int
, out_max_number_length:int
, out_max_name:int
)
Parses and returns parameters of the ‘Configuration’ notification command in the ‘Phonebook’ service.
New in version 1.4.
- phonebook_configuration_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_state:
return location for a
Mbim.PhonebookState
, orNone
if the ‘State’ field is not needed.- out_number_of_entries:
return location for a #guint32, or
None
if the ‘NumberOfEntries’ field is not needed.- out_used_entries:
return location for a #guint32, or
None
if the ‘UsedEntries’ field is not needed.- out_max_number_length:
return location for a #guint32, or
None
if the ‘MaxNumberLength’ field is not needed.- out_max_name:
return location for a #guint32, or
None
if the ‘MaxName’ field is not needed.
- Return type:
(
bool
, out_state:Mbim.PhonebookState
, out_number_of_entries:int
, out_used_entries:int
, out_max_number_length:int
, out_max_name:int
)
Parses and returns parameters of the ‘Configuration’ response command in the ‘Phonebook’ service.
New in version 1.4.
- phonebook_delete_response_parse()¶
-
Parses and returns parameters of the ‘Delete’ response command in the ‘Phonebook’ service.
New in version 1.4.
- phonebook_read_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_entry_count:
return location for a #guint32, or
None
if the ‘EntryCount’ field is not needed.- out_entries:
return location for a newly allocated array of
Mbim.PhonebookEntry
items, orNone
if the ‘Entries’ field is not needed. Free the returned value withMbim.PhonebookEntry.array_free
().
- Return type:
(
bool
, out_entry_count:int
, out_entries: [Mbim.PhonebookEntry
])
Parses and returns parameters of the ‘Read’ response command in the ‘Phonebook’ service.
New in version 1.4.
- phonebook_write_response_parse()¶
-
Parses and returns parameters of the ‘Write’ response command in the ‘Phonebook’ service.
New in version 1.4.
- pin_list_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_pin_desc_pin1:
return location for a newly allocated
Mbim.PinDesc
, orNone
if the ‘PinDescPin1’ field is not needed. Free the returned value withMbim.PinDesc.free
().- out_pin_desc_pin2:
return location for a newly allocated
Mbim.PinDesc
, orNone
if the ‘PinDescPin2’ field is not needed. Free the returned value withMbim.PinDesc.free
().- out_pin_desc_device_sim_pin:
return location for a newly allocated
Mbim.PinDesc
, orNone
if the ‘PinDescDeviceSimPin’ field is not needed. Free the returned value withMbim.PinDesc.free
().- out_pin_desc_device_first_sim_pin:
return location for a newly allocated
Mbim.PinDesc
, orNone
if the ‘PinDescDeviceFirstSimPin’ field is not needed. Free the returned value withMbim.PinDesc.free
().- out_pin_desc_network_pin:
return location for a newly allocated
Mbim.PinDesc
, orNone
if the ‘PinDescNetworkPin’ field is not needed. Free the returned value withMbim.PinDesc.free
().- out_pin_desc_network_subset_pin:
return location for a newly allocated
Mbim.PinDesc
, orNone
if the ‘PinDescNetworkSubsetPin’ field is not needed. Free the returned value withMbim.PinDesc.free
().- out_pin_desc_service_provider_pin:
return location for a newly allocated
Mbim.PinDesc
, orNone
if the ‘PinDescServiceProviderPin’ field is not needed. Free the returned value withMbim.PinDesc.free
().- out_pin_desc_corporate_pin:
return location for a newly allocated
Mbim.PinDesc
, orNone
if the ‘PinDescCorporatePin’ field is not needed. Free the returned value withMbim.PinDesc.free
().- out_pin_desc_subsidy_lock:
return location for a newly allocated
Mbim.PinDesc
, orNone
if the ‘PinDescSubsidyLock’ field is not needed. Free the returned value withMbim.PinDesc.free
().- out_pin_desc_custom:
return location for a newly allocated
Mbim.PinDesc
, orNone
if the ‘PinDescCustom’ field is not needed. Free the returned value withMbim.PinDesc.free
().
- Return type:
(
bool
, out_pin_desc_pin1:Mbim.PinDesc
, out_pin_desc_pin2:Mbim.PinDesc
, out_pin_desc_device_sim_pin:Mbim.PinDesc
, out_pin_desc_device_first_sim_pin:Mbim.PinDesc
, out_pin_desc_network_pin:Mbim.PinDesc
, out_pin_desc_network_subset_pin:Mbim.PinDesc
, out_pin_desc_service_provider_pin:Mbim.PinDesc
, out_pin_desc_corporate_pin:Mbim.PinDesc
, out_pin_desc_subsidy_lock:Mbim.PinDesc
, out_pin_desc_custom:Mbim.PinDesc
)
Parses and returns parameters of the ‘Pin List’ response command in the ‘Basic Connect’ service.
New in version 1.0.
- pin_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_pin_type:
return location for a
Mbim.PinType
, orNone
if the ‘PinType’ field is not needed.- out_pin_state:
return location for a
Mbim.PinState
, orNone
if the ‘PinState’ field is not needed.- out_remaining_attempts:
return location for a #guint32, or
None
if the ‘RemainingAttempts’ field is not needed.
- Return type:
(
bool
, out_pin_type:Mbim.PinType
, out_pin_state:Mbim.PinState
, out_remaining_attempts:int
)
Parses and returns parameters of the ‘Pin’ response command in the ‘Basic Connect’ service.
New in version 1.0.
- preferred_providers_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_providers_count:
return location for a #guint32, or
None
if the ‘ProvidersCount’ field is not needed.- out_providers:
return location for a newly allocated array of
Mbim.Provider
items, orNone
if the ‘Providers’ field is not needed. Free the returned value withMbim.Provider.array_free
().
- Return type:
(
bool
, out_providers_count:int
, out_providers: [Mbim.Provider
])
Parses and returns parameters of the ‘Preferred Providers’ notification command in the ‘Basic Connect’ service.
New in version 1.8.
- preferred_providers_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_providers_count:
return location for a #guint32, or
None
if the ‘ProvidersCount’ field is not needed.- out_providers:
return location for a newly allocated array of
Mbim.Provider
items, orNone
if the ‘Providers’ field is not needed. Free the returned value withMbim.Provider.array_free
().
- Return type:
(
bool
, out_providers_count:int
, out_providers: [Mbim.Provider
])
Parses and returns parameters of the ‘Preferred Providers’ response command in the ‘Basic Connect’ service.
New in version 1.2.
- provisioned_contexts_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_provisioned_contexts_count:
return location for a #guint32, or
None
if the ‘ProvisionedContextsCount’ field is not needed.- out_provisioned_contexts:
return location for a newly allocated array of
Mbim.ProvisionedContextElement
items, orNone
if the ‘ProvisionedContexts’ field is not needed. Free the returned value withMbim.ProvisionedContextElement.array_free
().
- Return type:
(
bool
, out_provisioned_contexts_count:int
, out_provisioned_contexts: [Mbim.ProvisionedContextElement
])
Parses and returns parameters of the ‘Provisioned Contexts’ notification command in the ‘Basic Connect’ service.
New in version 1.0.
- provisioned_contexts_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_provisioned_contexts_count:
return location for a #guint32, or
None
if the ‘ProvisionedContextsCount’ field is not needed.- out_provisioned_contexts:
return location for a newly allocated array of
Mbim.ProvisionedContextElement
items, orNone
if the ‘ProvisionedContexts’ field is not needed. Free the returned value withMbim.ProvisionedContextElement.array_free
().
- Return type:
(
bool
, out_provisioned_contexts_count:int
, out_provisioned_contexts: [Mbim.ProvisionedContextElement
])
Parses and returns parameters of the ‘Provisioned Contexts’ response command in the ‘Basic Connect’ service.
New in version 1.0.
- proxy_control_configuration_response_parse()¶
-
Parses and returns parameters of the ‘Configuration’ response command in the ‘Proxy Control’ service.
New in version 1.10.
- proxy_control_version_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- Return type:
(
bool
, out_mbim_version:int
, out_mbim_extended_version:int
)
Parses and returns parameters of the ‘Version’ notification command in the ‘Proxy Control’ service.
New in version 1.28.
- qdu_file_open_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- Return type:
(
bool
, out_max_transfer_size:int
, out_max_window_size:int
)
Parses and returns parameters of the ‘File Open’ response command in the ‘QDU’ service.
New in version 1.26.
- qdu_file_write_response_parse()¶
-
Parses and returns parameters of the ‘File Write’ response command in the ‘QDU’ service.
New in version 1.26.
- qdu_quectel_read_version_response_parse()¶
-
Parses and returns parameters of the ‘Quectel Read Version’ response command in the ‘QDU’ service.
New in version 1.28.
- qdu_quectel_reboot_response_parse()¶
-
Parses and returns parameters of the ‘Quectel Reboot’ response command in the ‘QDU’ service.
New in version 1.28.
- qdu_update_session_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_current_session_type:
return location for a
Mbim.QduSessionType
, orNone
if the ‘CurrentSessionType’ field is not needed.- out_current_session_status:
return location for a
Mbim.QduSessionStatus
, orNone
if the ‘CurrentSessionStatus’ field is not needed.- out_last_session_type:
return location for a
Mbim.QduSessionType
, orNone
if the ‘LastSessionType’ field is not needed.- out_last_session_result:
return location for a
Mbim.QduSessionResult
, orNone
if the ‘LastSessionResult’ field is not needed.- out_last_session_error_offset:
return location for a #guint32, or
None
if the ‘LastSessionErrorOffset’ field is not needed.- out_last_session_error_size:
return location for a #guint32, or
None
if the ‘LastSessionErrorSize’ field is not needed.
- Return type:
(
bool
, out_current_session_type:Mbim.QduSessionType
, out_current_session_status:Mbim.QduSessionStatus
, out_last_session_type:Mbim.QduSessionType
, out_last_session_result:Mbim.QduSessionResult
, out_last_session_error_offset:int
, out_last_session_error_size:int
)
Parses and returns parameters of the ‘Update Session’ response command in the ‘QDU’ service.
New in version 1.26.
- qmi_msg_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_qmux:
return location for an array of #guint8 values. Do not free the returned value, it is owned by self.
- Return type:
Parses and returns parameters of the ‘msg’ notification command in the ‘QMI’ service.
New in version 1.18.
- qmi_msg_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_qmux:
return location for an array of #guint8 values. Do not free the returned value, it is owned by self.
- Return type:
Parses and returns parameters of the ‘msg’ response command in the ‘QMI’ service.
New in version 1.14.
- quectel_radio_state_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_radio_state:
return location for a
Mbim.QuectelRadioSwitchState
, orNone
if the ‘RadioState’ field is not needed.
- Return type:
(
bool
, out_radio_state:Mbim.QuectelRadioSwitchState
)
Parses and returns parameters of the ‘Radio State’ response command in the ‘Quectel’ service.
New in version 1.26.2.
- radio_state_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_hw_radio_state:
return location for a
Mbim.RadioSwitchState
, orNone
if the ‘HwRadioState’ field is not needed.- out_sw_radio_state:
return location for a
Mbim.RadioSwitchState
, orNone
if the ‘SwRadioState’ field is not needed.
- Return type:
(
bool
, out_hw_radio_state:Mbim.RadioSwitchState
, out_sw_radio_state:Mbim.RadioSwitchState
)
Parses and returns parameters of the ‘Radio State’ notification command in the ‘Basic Connect’ service.
New in version 1.0.
- radio_state_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_hw_radio_state:
return location for a
Mbim.RadioSwitchState
, orNone
if the ‘HwRadioState’ field is not needed.- out_sw_radio_state:
return location for a
Mbim.RadioSwitchState
, orNone
if the ‘SwRadioState’ field is not needed.
- Return type:
(
bool
, out_hw_radio_state:Mbim.RadioSwitchState
, out_sw_radio_state:Mbim.RadioSwitchState
)
Parses and returns parameters of the ‘Radio State’ response command in the ‘Basic Connect’ service.
New in version 1.0.
- ref()¶
- Returns:
the new reference to self.
- Return type:
Atomically increments the reference count of self by one.
New in version 1.0.
- register_state_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_nw_error:
return location for a
Mbim.NwError
, orNone
if the ‘NwError’ field is not needed.- out_register_state:
return location for a
Mbim.RegisterState
, orNone
if the ‘RegisterState’ field is not needed.- out_register_mode:
return location for a
Mbim.RegisterMode
, orNone
if the ‘RegisterMode’ field is not needed.- out_available_data_classes:
return location for a
Mbim.DataClass
, orNone
if the ‘AvailableDataClasses’ field is not needed.- out_current_cellular_class:
return location for a
Mbim.CellularClass
, orNone
if the ‘CurrentCellularClass’ field is not needed.- out_provider_id:
return location for a newly allocated string, or
None
if the ‘ProviderId’ field is not needed. Free the returned value withGLib.free
().- out_provider_name:
return location for a newly allocated string, or
None
if the ‘ProviderName’ field is not needed. Free the returned value withGLib.free
().- out_roaming_text:
return location for a newly allocated string, or
None
if the ‘RoamingText’ field is not needed. Free the returned value withGLib.free
().- out_registration_flag:
return location for a
Mbim.RegistrationFlag
, orNone
if the ‘RegistrationFlag’ field is not needed.
- Return type:
(
bool
, out_nw_error:Mbim.NwError
, out_register_state:Mbim.RegisterState
, out_register_mode:Mbim.RegisterMode
, out_available_data_classes:Mbim.DataClass
, out_current_cellular_class:Mbim.CellularClass
, out_provider_id:str
, out_provider_name:str
, out_roaming_text:str
, out_registration_flag:Mbim.RegistrationFlag
)
Parses and returns parameters of the ‘Register State’ notification command in the ‘Basic Connect’ service.
New in version 1.0.
- register_state_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_nw_error:
return location for a
Mbim.NwError
, orNone
if the ‘NwError’ field is not needed.- out_register_state:
return location for a
Mbim.RegisterState
, orNone
if the ‘RegisterState’ field is not needed.- out_register_mode:
return location for a
Mbim.RegisterMode
, orNone
if the ‘RegisterMode’ field is not needed.- out_available_data_classes:
return location for a
Mbim.DataClass
, orNone
if the ‘AvailableDataClasses’ field is not needed.- out_current_cellular_class:
return location for a
Mbim.CellularClass
, orNone
if the ‘CurrentCellularClass’ field is not needed.- out_provider_id:
return location for a newly allocated string, or
None
if the ‘ProviderId’ field is not needed. Free the returned value withGLib.free
().- out_provider_name:
return location for a newly allocated string, or
None
if the ‘ProviderName’ field is not needed. Free the returned value withGLib.free
().- out_roaming_text:
return location for a newly allocated string, or
None
if the ‘RoamingText’ field is not needed. Free the returned value withGLib.free
().- out_registration_flag:
return location for a
Mbim.RegistrationFlag
, orNone
if the ‘RegistrationFlag’ field is not needed.
- Return type:
(
bool
, out_nw_error:Mbim.NwError
, out_register_state:Mbim.RegisterState
, out_register_mode:Mbim.RegisterMode
, out_available_data_classes:Mbim.DataClass
, out_current_cellular_class:Mbim.CellularClass
, out_provider_id:str
, out_provider_name:str
, out_roaming_text:str
, out_registration_flag:Mbim.RegistrationFlag
)
Parses and returns parameters of the ‘Register State’ response command in the ‘Basic Connect’ service.
New in version 1.0.
- response_get_result(expected)¶
- Parameters:
expected (
Mbim.MessageType
) – expectedMbim.MessageType
if there isn’t any error in the operation.- Raises:
- Returns:
- Return type:
Gets the result of the operation from the response message, which can be either a
Mbim.MessageType.FUNCTION_ERROR
message or a message of the specified expected type.New in version 1.12.
- service_activation_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_nw_error:
return location for a
Mbim.NwError
, orNone
if the ‘NwError’ field is not needed.- out_buffer:
return location for an array of #guint8 values. Do not free the returned value, it is owned by self.
- Return type:
(
bool
, out_nw_error:Mbim.NwError
, out_buffer:bytes
)
Parses and returns parameters of the ‘Service Activation’ response command in the ‘Basic Connect’ service.
New in version 1.2.
- set_transaction_id(transaction_id)¶
- Parameters:
transaction_id (
int
) – the transaction id.
Sets the transaction ID of the message.
New in version 1.0.
- signal_state_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_rssi:
return location for a #guint32, or
None
if the ‘Rssi’ field is not needed.- out_error_rate:
return location for a #guint32, or
None
if the ‘ErrorRate’ field is not needed.- out_signal_strength_interval:
return location for a #guint32, or
None
if the ‘SignalStrengthInterval’ field is not needed.- out_rssi_threshold:
return location for a #guint32, or
None
if the ‘RssiThreshold’ field is not needed.- out_error_rate_threshold:
return location for a #guint32, or
None
if the ‘ErrorRateThreshold’ field is not needed.
- Return type:
(
bool
, out_rssi:int
, out_error_rate:int
, out_signal_strength_interval:int
, out_rssi_threshold:int
, out_error_rate_threshold:int
)
Parses and returns parameters of the ‘Signal State’ notification command in the ‘Basic Connect’ service.
New in version 1.0.
- signal_state_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_rssi:
return location for a #guint32, or
None
if the ‘Rssi’ field is not needed.- out_error_rate:
return location for a #guint32, or
None
if the ‘ErrorRate’ field is not needed.- out_signal_strength_interval:
return location for a #guint32, or
None
if the ‘SignalStrengthInterval’ field is not needed.- out_rssi_threshold:
return location for a #guint32, or
None
if the ‘RssiThreshold’ field is not needed.- out_error_rate_threshold:
return location for a #guint32, or
None
if the ‘ErrorRateThreshold’ field is not needed.
- Return type:
(
bool
, out_rssi:int
, out_error_rate:int
, out_signal_strength_interval:int
, out_rssi_threshold:int
, out_error_rate_threshold:int
)
Parses and returns parameters of the ‘Signal State’ response command in the ‘Basic Connect’ service.
New in version 1.0.
- sms_configuration_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_sms_storage_state:
return location for a
Mbim.SmsStorageState
, orNone
if the ‘SmsStorageState’ field is not needed.- out_format:
return location for a
Mbim.SmsFormat
, orNone
if the ‘Format’ field is not needed.- out_max_messages:
return location for a #guint32, or
None
if the ‘MaxMessages’ field is not needed.- out_cdma_short_message_size:
return location for a #guint32, or
None
if the ‘CdmaShortMessageSize’ field is not needed.- out_sc_address:
return location for a newly allocated string, or
None
if the ‘ScAddress’ field is not needed. Free the returned value withGLib.free
().
- Return type:
(
bool
, out_sms_storage_state:Mbim.SmsStorageState
, out_format:Mbim.SmsFormat
, out_max_messages:int
, out_cdma_short_message_size:int
, out_sc_address:str
)
Parses and returns parameters of the ‘Configuration’ response command in the ‘SMS’ service.
New in version 1.4.
- sms_delete_response_parse()¶
-
Parses and returns parameters of the ‘Delete’ response command in the ‘SMS’ service.
New in version 1.4.
- sms_message_store_status_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_flag:
return location for a
Mbim.SmsStatusFlag
, orNone
if the ‘Flag’ field is not needed.- out_message_index:
return location for a #guint32, or
None
if the ‘MessageIndex’ field is not needed.
- Return type:
(
bool
, out_flag:Mbim.SmsStatusFlag
, out_message_index:int
)
Parses and returns parameters of the ‘Message Store Status’ notification command in the ‘SMS’ service.
New in version 1.4.
- sms_message_store_status_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_flag:
return location for a
Mbim.SmsStatusFlag
, orNone
if the ‘Flag’ field is not needed.- out_message_index:
return location for a #guint32, or
None
if the ‘MessageIndex’ field is not needed.
- Return type:
(
bool
, out_flag:Mbim.SmsStatusFlag
, out_message_index:int
)
Parses and returns parameters of the ‘Message Store Status’ response command in the ‘SMS’ service.
New in version 1.4.
- sms_read_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_format:
return location for a
Mbim.SmsFormat
, orNone
if the ‘Format’ field is not needed.- out_messages_count:
return location for a #guint32, or
None
if the ‘MessagesCount’ field is not needed.- out_pdu_messages:
return location for a newly allocated array of
Mbim.SmsPduReadRecord
items, orNone
if the ‘PduMessages’ field is not needed. Free the returned value withMbim.SmsPduReadRecord.array_free
().- out_cdma_messages:
return location for a newly allocated array of
Mbim.SmsCdmaReadRecord
items, orNone
if the ‘CdmaMessages’ field is not needed. Free the returned value withMbim.SmsCdmaReadRecord.array_free
().
- Return type:
(
bool
, out_format:Mbim.SmsFormat
, out_messages_count:int
, out_pdu_messages: [Mbim.SmsPduReadRecord
], out_cdma_messages: [Mbim.SmsCdmaReadRecord
])
Parses and returns parameters of the ‘Read’ notification command in the ‘SMS’ service.
New in version 1.4.
- sms_read_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_format:
return location for a
Mbim.SmsFormat
, orNone
if the ‘Format’ field is not needed.- out_messages_count:
return location for a #guint32, or
None
if the ‘MessagesCount’ field is not needed.- out_pdu_messages:
return location for a newly allocated array of
Mbim.SmsPduReadRecord
items, orNone
if the ‘PduMessages’ field is not needed. Free the returned value withMbim.SmsPduReadRecord.array_free
().- out_cdma_messages:
return location for a newly allocated array of
Mbim.SmsCdmaReadRecord
items, orNone
if the ‘CdmaMessages’ field is not needed. Free the returned value withMbim.SmsCdmaReadRecord.array_free
().
- Return type:
(
bool
, out_format:Mbim.SmsFormat
, out_messages_count:int
, out_pdu_messages: [Mbim.SmsPduReadRecord
], out_cdma_messages: [Mbim.SmsCdmaReadRecord
])
Parses and returns parameters of the ‘Read’ response command in the ‘SMS’ service.
New in version 1.4.
- sms_send_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_message_reference:
return location for a #guint32, or
None
if the ‘MessageReference’ field is not needed.
- Return type:
Parses and returns parameters of the ‘Send’ response command in the ‘SMS’ service.
New in version 1.4.
- stk_envelope_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_envelope_support:
return location for an array of 32 #guint8 values. Do not free the returned value, it is owned by self.
- Return type:
Parses and returns parameters of the ‘Envelope’ response command in the ‘STK’ service.
New in version 1.4.
- stk_pac_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_pac_type:
return location for a
Mbim.StkPacType
, orNone
if the ‘PacType’ field is not needed.- out_data_buffer:
return location for an array of #guint8 values. Do not free the returned value, it is owned by self.
- Return type:
(
bool
, out_pac_type:Mbim.StkPacType
, out_data_buffer:bytes
)
Parses and returns parameters of the ‘Pac’ notification command in the ‘STK’ service.
New in version 1.4.
- stk_pac_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_pac_support:
return location for an array of 256 #guint8 values. Do not free the returned value, it is owned by self.
- Return type:
Parses and returns parameters of the ‘Pac’ response command in the ‘STK’ service.
New in version 1.4.
- stk_terminal_response_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_result_data:
return location for an array of #guint8 values. Do not free the returned value, it is owned by self.
- out_status_words:
return location for a #guint32, or
None
if the ‘StatusWords’ field is not needed.
- Return type:
Parses and returns parameters of the ‘Terminal Response’ response command in the ‘STK’ service.
New in version 1.4.
- subscriber_ready_status_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_ready_state:
return location for a
Mbim.SubscriberReadyState
, orNone
if the ‘ReadyState’ field is not needed.- out_subscriber_id:
return location for a newly allocated string, or
None
if the ‘SubscriberId’ field is not needed. Free the returned value withGLib.free
().- out_sim_icc_id:
return location for a newly allocated string, or
None
if the ‘SimIccId’ field is not needed. Free the returned value withGLib.free
().- out_ready_info:
return location for a
Mbim.ReadyInfoFlag
, orNone
if the ‘ReadyInfo’ field is not needed.- out_telephone_numbers_count:
return location for a #guint32, or
None
if the ‘TelephoneNumbersCount’ field is not needed.- out_telephone_numbers:
return location for a newly allocated array of strings, or
None
if the ‘TelephoneNumbers’ field is not needed. Free the returned value withGLib.strfreev
().
- Return type:
(
bool
, out_ready_state:Mbim.SubscriberReadyState
, out_subscriber_id:str
, out_sim_icc_id:str
, out_ready_info:Mbim.ReadyInfoFlag
, out_telephone_numbers_count:int
, out_telephone_numbers: [str
])
Parses and returns parameters of the ‘Subscriber Ready Status’ notification command in the ‘Basic Connect’ service.
New in version 1.8.
- subscriber_ready_status_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_ready_state:
return location for a
Mbim.SubscriberReadyState
, orNone
if the ‘ReadyState’ field is not needed.- out_subscriber_id:
return location for a newly allocated string, or
None
if the ‘SubscriberId’ field is not needed. Free the returned value withGLib.free
().- out_sim_icc_id:
return location for a newly allocated string, or
None
if the ‘SimIccId’ field is not needed. Free the returned value withGLib.free
().- out_ready_info:
return location for a
Mbim.ReadyInfoFlag
, orNone
if the ‘ReadyInfo’ field is not needed.- out_telephone_numbers_count:
return location for a #guint32, or
None
if the ‘TelephoneNumbersCount’ field is not needed.- out_telephone_numbers:
return location for a newly allocated array of strings, or
None
if the ‘TelephoneNumbers’ field is not needed. Free the returned value withGLib.strfreev
().
- Return type:
(
bool
, out_ready_state:Mbim.SubscriberReadyState
, out_subscriber_id:str
, out_sim_icc_id:str
, out_ready_info:Mbim.ReadyInfoFlag
, out_telephone_numbers_count:int
, out_telephone_numbers: [str
])
Parses and returns parameters of the ‘Subscriber Ready Status’ response command in the ‘Basic Connect’ service.
New in version 1.0.
- unref()¶
Atomically decrements the reference count of self by one. If the reference count drops to 0, self is completely disposed.
New in version 1.0.
- ussd_notification_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_response:
return location for a
Mbim.UssdResponse
, orNone
if the ‘Response’ field is not needed.- out_session_state:
return location for a
Mbim.UssdSessionState
, orNone
if the ‘SessionState’ field is not needed.- out_data_coding_scheme:
return location for a #guint32, or
None
if the ‘DataCodingScheme’ field is not needed.- out_payload:
return location for an array of #guint8 values. Do not free the returned value, it is owned by self.
- Return type:
(
bool
, out_response:Mbim.UssdResponse
, out_session_state:Mbim.UssdSessionState
, out_data_coding_scheme:int
, out_payload:bytes
)
Parses and returns parameters of the ‘’ notification command in the ‘USSD’ service.
New in version 1.4.
- ussd_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_response:
return location for a
Mbim.UssdResponse
, orNone
if the ‘Response’ field is not needed.- out_session_state:
return location for a
Mbim.UssdSessionState
, orNone
if the ‘SessionState’ field is not needed.- out_data_coding_scheme:
return location for a #guint32, or
None
if the ‘DataCodingScheme’ field is not needed.- out_payload:
return location for an array of #guint8 values. Do not free the returned value, it is owned by self.
- Return type:
(
bool
, out_response:Mbim.UssdResponse
, out_session_state:Mbim.UssdSessionState
, out_data_coding_scheme:int
, out_payload:bytes
)
Parses and returns parameters of the ‘’ response command in the ‘USSD’ service.
New in version 1.4.
- validate()¶
- Raises:
- Returns:
- Return type:
Validates the contents of the headers in the MBIM message.
This operation may be used to ensure that the message contains all bytes it is expected to contain and that it is of a valid type.
This operation also ensures the message is complete and not a partial MBIM fragment.
This operation does not validate that the specific contents of a given message type are available, that is done by the methods retrieving those specific contents.
New in version 1.28.
- visible_providers_response_parse()¶
- Raises:
- Returns:
True
if the message was correctly parsed,False
if error is set.- out_providers_count:
return location for a #guint32, or
None
if the ‘ProvidersCount’ field is not needed.- out_providers:
return location for a newly allocated array of
Mbim.Provider
items, orNone
if the ‘Providers’ field is not needed. Free the returned value withMbim.Provider.array_free
().
- Return type:
(
bool
, out_providers_count:int
, out_providers: [Mbim.Provider
])
Parses and returns parameters of the ‘Visible Providers’ response command in the ‘Basic Connect’ service.
New in version 1.2.