Gjsify LogoGjsify Logo

An opaque type representing a MBIM message.

record

Hierarchy

  • Message

Index

Constructors

Properties

Methods

Constructors

  • new Message(data: number, data_length: number): Mbim.Message

Properties

name: string

Methods

  • atds_location_response_parse(): [boolean, number, number, number]
  • Parses and returns parameters of the 'Location' response command in the 'ATDS' service.

    Returns [boolean, number, number, number]

  • atds_operators_response_parse(): [boolean, number, AtdsProvider[]]
  • atds_signal_response_parse(): [boolean, number, number, number, number, number, number, number]
  • Parses and returns parameters of the 'Signal' response command in the 'ATDS' service.

    Returns [boolean, number, number, number, number, number, number, number]

  • auth_aka_response_parse(): [boolean, Uint8Array, number, Uint8Array, Uint8Array, Uint8Array]
  • Parses and returns parameters of the 'Aka' response command in the 'Auth' service.

    Returns [boolean, Uint8Array, number, Uint8Array, Uint8Array, Uint8Array]

  • auth_akap_response_parse(): [boolean, Uint8Array, number, Uint8Array, Uint8Array, Uint8Array]
  • Parses and returns parameters of the 'Akap' response command in the 'Auth' service.

    Returns [boolean, Uint8Array, number, Uint8Array, Uint8Array, Uint8Array]

  • auth_sim_response_parse(): [boolean, number, number, number, number, number, number, number]
  • Parses and returns parameters of the 'Sim' response command in the 'Auth' service.

    Returns [boolean, number, number, number, number, number, number, number]

  • close_done_get_result(): boolean
  • command_append(buffer: number, buffer_size: number): void
  • Appends the contents of buffer to self.

    Parameters

    • buffer: number

      raw buffer to append to the message.

    • buffer_size: number

      length of the data in buffer.

    Returns void

  • command_done_get_cid(): number
  • command_done_get_raw_information_buffer(): [number, number]
  • command_done_get_result(): boolean
  • Gets the result of the 'Command' operation in the %MBIM_MESSAGE_TYPE_COMMAND_DONE message.

    Returns boolean

  • command_done_get_service_id(): Uuid
  • command_get_cid(): number
  • command_get_raw_information_buffer(): [number, number]
  • command_get_service_id(): Uuid
  • device_service_subscribe_list_response_parse(): [boolean, number, EventEntry[]]
  • Parses and returns parameters of the 'Device Service Subscribe List' response command in the 'Basic Connect' service.

    Returns [boolean, number, EventEntry[]]

  • device_service_subscriber_list_response_parse(events_count: number, events: EventEntry): boolean
  • Create a new request for the 'Events' response command in the 'Basic Connect' service.

    Parameters

    • events_count: number

      return location for a #guint32, or %NULL if the 'EventsCount' field is not needed.

    • events: EventEntry

      return location for a newly allocated array of #MbimEventEntrys, or %NULL if the 'Events' field is not needed. Free the returned value with mbim_event_entry_array_free().

    Returns boolean

  • dss_connect_response_parse(): boolean
  • get_message_length(): number
  • get_printable(line_prefix: string, headers_only: boolean): string
  • 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.

    Parameters

    • line_prefix: string

      prefix string to use in each new generated line.

    • headers_only: boolean

      %TRUE if only basic headers should be printed.

    Returns string

  • get_printable_full(mbimex_version_major: number, mbimex_version_minor: number, line_prefix: string, headers_only: boolean): string
  • 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.

    Parameters

    • mbimex_version_major: number

      major version of the agreed MBIMEx support.

    • mbimex_version_minor: number

      minor version of the agreed MBIMEx support.

    • line_prefix: string

      prefix string to use in each new generated line.

    • headers_only: boolean

      %TRUE if only basic headers should be printed.

    Returns string

  • get_raw(): [number, number]
  • get_transaction_id(): number
  • indicate_status_get_cid(): number
  • indicate_status_get_raw_information_buffer(): [number, number]
  • indicate_status_get_service_id(): Uuid
  • ip_packet_filters_response_parse(): [boolean, number, number, PacketFilter[]]
  • ms_basic_connect_extensions_device_slot_mappings_response_parse(): [boolean, number, Mbim.Slot[]]
  • Parses and returns parameters of the 'Device Slot Mappings' response command in the 'Ms Basic Connect Extensions' service.

    Returns [boolean, number, Mbim.Slot[]]

  • ms_basic_connect_extensions_location_info_status_notification_parse(): [boolean, number, number, number]
  • Parses and returns parameters of the 'Location Info Status' notification command in the 'Ms Basic Connect Extensions' service.

    Returns [boolean, number, number, number]

  • ms_basic_connect_extensions_location_info_status_response_parse(): [boolean, number, number, number]
  • Parses and returns parameters of the 'Location Info Status' response command in the 'Ms Basic Connect Extensions' service.

    Returns [boolean, number, number, number]

  • ms_basic_connect_extensions_lte_attach_configuration_notification_parse(): [boolean, number, LteAttachConfiguration[]]
  • ms_basic_connect_extensions_lte_attach_configuration_response_parse(): [boolean, number, LteAttachConfiguration[]]
  • ms_basic_connect_extensions_pco_notification_parse(): [boolean, PcoValue]
  • ms_basic_connect_extensions_pco_response_parse(): [boolean, PcoValue]
  • ms_basic_connect_extensions_slot_info_status_notification_parse(): [boolean, number, UiccSlotState]
  • ms_basic_connect_extensions_slot_info_status_response_parse(): [boolean, number, UiccSlotState]
  • ms_basic_connect_extensions_sys_caps_response_parse(): [boolean, number, number, number, number]
  • Parses and returns parameters of the 'Sys Caps' response command in the 'Ms Basic Connect Extensions' service.

    Returns [boolean, number, number, number, number]

  • ms_basic_connect_extensions_v2_version_response_parse(): [boolean, number, number]
  • Parses and returns parameters of the 'Version' response command in the 'Ms Basic Connect Extensions V2' service.

    Returns [boolean, number, number]

  • ms_basic_connect_extensions_v3_wake_reason_response_parse(): [boolean, WakeType, number, Tlv]
  • ms_basic_connect_v2_signal_state_notification_parse(): [boolean, number, number, number, number, number, number, RsrpSnrInfo[]]
  • Parses and returns parameters of the 'Signal State' notification command in the 'Ms Basic Connect V2' service.

    Returns [boolean, number, number, number, number, number, number, RsrpSnrInfo[]]

  • ms_basic_connect_v2_signal_state_response_parse(): [boolean, number, number, number, number, number, number, RsrpSnrInfo[]]
  • Parses and returns parameters of the 'Signal State' response command in the 'Ms Basic Connect V2' service.

    Returns [boolean, number, number, number, number, number, number, RsrpSnrInfo[]]

  • ms_basic_connect_v3_ip_packet_filters_response_parse(): [boolean, number, number, PacketFilterV3[]]
  • ms_firmware_id_get_response_parse(): [boolean, Uuid]
  • ms_uicc_low_level_access_apdu_response_parse(): [boolean, number, Uint8Array]
  • Parses and returns parameters of the 'APDU' response command in the 'MS UICC Low Level Access' service.

    Returns [boolean, number, Uint8Array]

  • ms_uicc_low_level_access_atr_response_parse(): [boolean, string]
  • Parses and returns parameters of the 'ATR' response command in the 'MS UICC Low Level Access' service.

    Returns [boolean, string]

  • ms_uicc_low_level_access_close_channel_response_parse(): [boolean, number]
  • Parses and returns parameters of the 'Close Channel' response command in the 'MS UICC Low Level Access' service.

    Returns [boolean, number]

  • ms_uicc_low_level_access_open_channel_response_parse(): [boolean, number, number, Uint8Array]
  • Parses and returns parameters of the 'Open Channel' response command in the 'MS UICC Low Level Access' service.

    Returns [boolean, number, number, Uint8Array]

  • multicarrier_providers_notification_parse(): [boolean, number, Mbim.Provider[]]
  • multicarrier_providers_response_parse(): [boolean, number, Mbim.Provider[]]
  • open_done_get_result(): boolean
  • open_get_max_control_transfer(): number
  • Get the maximum control transfer set to be used in the #MbimMessage of type %MBIM_MESSAGE_TYPE_OPEN.

    Returns number

  • packet_statistics_response_parse(): [boolean, number, number, number, number, number, number, number, number]
  • Parses and returns parameters of the 'Packet Statistics' response command in the 'Basic Connect' service.

    Returns [boolean, number, number, number, number, number, number, number, number]

  • phonebook_configuration_notification_parse(): [boolean, PhonebookState, number, number, number, number]
  • phonebook_configuration_response_parse(): [boolean, PhonebookState, number, number, number, number]
  • phonebook_delete_response_parse(): boolean
  • Parses and returns parameters of the 'Delete' response command in the 'Phonebook' service.

    Returns boolean

  • phonebook_write_response_parse(): boolean
  • Parses and returns parameters of the 'Write' response command in the 'Phonebook' service.

    Returns boolean

  • preferred_providers_notification_parse(): [boolean, number, Mbim.Provider[]]
  • preferred_providers_response_parse(): [boolean, number, Mbim.Provider[]]
  • proxy_control_configuration_response_parse(): boolean
  • Parses and returns parameters of the 'Configuration' response command in the 'Proxy Control' service.

    Returns boolean

  • proxy_control_version_notification_parse(): [boolean, number, number]
  • Parses and returns parameters of the 'Version' notification command in the 'Proxy Control' service.

    Returns [boolean, number, number]

  • qdu_file_open_response_parse(): [boolean, number, number]
  • Parses and returns parameters of the 'File Open' response command in the 'QDU' service.

    Returns [boolean, number, number]

  • qdu_file_write_response_parse(): boolean
  • Parses and returns parameters of the 'File Write' response command in the 'QDU' service.

    Returns boolean

  • qdu_quectel_read_version_response_parse(): [boolean, number, string]
  • Parses and returns parameters of the 'Quectel Read Version' response command in the 'QDU' service.

    Returns [boolean, number, string]

  • qdu_quectel_reboot_response_parse(): boolean
  • Parses and returns parameters of the 'Quectel Reboot' response command in the 'QDU' service.

    Returns boolean

  • qmi_msg_notification_parse(): [boolean, Uint8Array]
  • Parses and returns parameters of the 'msg' notification command in the 'QMI' service.

    Returns [boolean, Uint8Array]

  • qmi_msg_response_parse(): [boolean, Uint8Array]
  • Parses and returns parameters of the 'msg' response command in the 'QMI' service.

    Returns [boolean, Uint8Array]

  • Gets the result of the operation from the response message, which can be either a %MBIM_MESSAGE_TYPE_FUNCTION_ERROR message or a message of the specified expected type.

    Parameters

    • expected: Mbim.MessageType

      expected #MbimMessageType if there isn't any error in the operation.

    Returns boolean

  • service_activation_response_parse(): [boolean, NwError, Uint8Array]
  • Parses and returns parameters of the 'Service Activation' response command in the 'Basic Connect' service.

    Returns [boolean, NwError, Uint8Array]

  • set_transaction_id(transaction_id: number): void
  • Sets the transaction ID of the message.

    Parameters

    • transaction_id: number

      the transaction id.

    Returns void

  • signal_state_notification_parse(): [boolean, number, number, number, number, number]
  • Parses and returns parameters of the 'Signal State' notification command in the 'Basic Connect' service.

    Returns [boolean, number, number, number, number, number]

  • signal_state_response_parse(): [boolean, number, number, number, number, number]
  • Parses and returns parameters of the 'Signal State' response command in the 'Basic Connect' service.

    Returns [boolean, number, number, number, number, number]

  • sms_delete_response_parse(): boolean
  • sms_message_store_status_notification_parse(): [boolean, SmsStatusFlag, number]
  • sms_message_store_status_response_parse(): [boolean, SmsStatusFlag, number]
  • sms_send_response_parse(): [boolean, number]
  • Parses and returns parameters of the 'Send' response command in the 'SMS' service.

    Returns [boolean, number]

  • stk_envelope_response_parse(): [boolean, Uint8Array]
  • Parses and returns parameters of the 'Envelope' response command in the 'STK' service.

    Returns [boolean, Uint8Array]

  • stk_pac_notification_parse(): [boolean, StkPacType, Uint8Array]
  • stk_pac_response_parse(): [boolean, Uint8Array]
  • Parses and returns parameters of the 'Pac' response command in the 'STK' service.

    Returns [boolean, Uint8Array]

  • stk_terminal_response_response_parse(): [boolean, Uint8Array, number]
  • Parses and returns parameters of the 'Terminal Response' response command in the 'STK' service.

    Returns [boolean, Uint8Array, number]

  • unref(): void
  • Atomically decrements the reference count of self by one. If the reference count drops to 0, self is completely disposed.

    Returns void

  • visible_providers_response_parse(): [boolean, number, Mbim.Provider[]]
  • auth_aka_query_new(rand: Uint8Array, autn: Uint8Array): Mbim.Message
  • Create a new request for the 'Aka' query command in the 'Auth' service.

    Parameters

    • rand: Uint8Array

      the 'Rand' field, given as an array of 16 #guint8 values.

    • autn: Uint8Array

      the 'Autn' field, given as an array of 16 #guint8 values.

    Returns Mbim.Message

  • auth_akap_query_new(rand: Uint8Array, autn: Uint8Array, network_name: string): Mbim.Message
  • Create a new request for the 'Akap' query command in the 'Auth' service.

    Parameters

    • rand: Uint8Array

      the 'Rand' field, given as an array of 16 #guint8 values.

    • autn: Uint8Array

      the 'Autn' field, given as an array of 16 #guint8 values.

    • network_name: string

      the 'NetworkName' field, given as a string.

    Returns Mbim.Message

  • auth_sim_query_new(rand1: Uint8Array, rand2: Uint8Array, rand3: Uint8Array, n: number): Mbim.Message
  • Create a new request for the 'Sim' query command in the 'Auth' service.

    Parameters

    • rand1: Uint8Array

      the 'Rand1' field, given as an array of 16 #guint8 values.

    • rand2: Uint8Array

      the 'Rand2' field, given as an array of 16 #guint8 values.

    • rand3: Uint8Array

      the 'Rand3' field, given as an array of 16 #guint8 values.

    • n: number

      the 'N' field, given as a #guint32.

    Returns Mbim.Message

  • Create a new #MbimMessage of type %MBIM_MESSAGE_TYPE_CLOSE_DONE with the specified parameters.

    Parameters

    • transaction_id: number

      transaction ID.

    • error_status_code: StatusError

      a #MbimStatusError.

    Returns Mbim.Message

  • Create a new #MbimMessage of type %MBIM_MESSAGE_TYPE_CLOSE with the specified parameters.

    Parameters

    • transaction_id: number

      transaction ID.

    Returns Mbim.Message

  • Create a new #MbimMessage of type %MBIM_MESSAGE_TYPE_COMMAND with the specified parameters and an empty information buffer.

    Parameters

    • transaction_id: number

      transaction ID.

    • service: Mbim.Service

      a #MbimService.

    • cid: number

      the command ID.

    • command_type: MessageCommandType

      the command type.

    Returns Mbim.Message

  • Create a new request for the 'Connect' query command in the 'Basic Connect' service.

    Parameters

    • session_id: number

      the 'SessionId' field, given as a #guint32.

    • activation_state: ActivationState

      the 'ActivationState' field, given as a #MbimActivationState.

    • voice_call_state: Mbim.VoiceCallState

      the 'VoiceCallState' field, given as a #MbimVoiceCallState.

    • ip_type: ContextIpType

      the 'IpType' field, given as a #MbimContextIpType.

    • context_type: Uuid

      the 'ContextType' field, given as a #MbimUuid.

    • nw_error: number

      the 'NwError' field, given as a #guint32.

    Returns Mbim.Message

  • Create a new request for the 'Connect' set command in the 'Basic Connect' service.

    Parameters

    • session_id: number

      the 'SessionId' field, given as a #guint32.

    • activation_command: ActivationCommand

      the 'ActivationCommand' field, given as a #MbimActivationCommand.

    • access_string: string

      the 'AccessString' field, given as a string.

    • user_name: string

      the 'UserName' field, given as a string.

    • password: string

      the 'Password' field, given as a string.

    • compression: Mbim.Compression

      the 'Compression' field, given as a #MbimCompression.

    • auth_protocol: AuthProtocol

      the 'AuthProtocol' field, given as a #MbimAuthProtocol.

    • ip_type: ContextIpType

      the 'IpType' field, given as a #MbimContextIpType.

    • context_type: Uuid

      the 'ContextType' field, given as a #MbimUuid.

    Returns Mbim.Message

  • Create a new request for the 'Device Service Subscribe List' set command in the 'Basic Connect' service.

    Parameters

    • events_count: number

      the 'EventsCount' field, given as a #guint32.

    • events: EventEntry[]

      the 'Events' field, given as an array of #MbimEventEntry items.

    Returns Mbim.Message

  • Create a new request for the 'Device Service Subscribe List' set command in the 'Basic Connect' service.

    Parameters

    • events_count: number

      the 'EventsCount' field, given as a #guint32.

    • events: EventEntry

      the 'Events' field, given as an array of #MbimEventEntrys.

    Returns Mbim.Message

  • Create a new request for the 'Connect' set command in the 'DSS' service.

    Parameters

    • device_service_id: Uuid

      the 'DeviceServiceId' field, given as a #MbimUuid.

    • dss_session_id: number

      the 'DssSessionId' field, given as a #guint32.

    • dss_link_state: DssLinkState

      the 'DssLinkState' field, given as a #MbimDssLinkState.

    Returns Mbim.Message

  • intel_firmware_update_modem_reboot_set_new(): Mbim.Message
  • Create a new request for the 'IP Configuration' query command in the 'Basic Connect' service.

    Parameters

    • session_id: number

      the 'SessionId' field, given as a #guint32.

    • ipv4_configuration_available: IPConfigurationAvailableFlag

      the 'IPv4ConfigurationAvailable' field, given as a #MbimIPConfigurationAvailableFlag.

    • ipv6_configuration_available: IPConfigurationAvailableFlag

      the 'IPv6ConfigurationAvailable' field, given as a #MbimIPConfigurationAvailableFlag.

    • ipv4_address_count: number

      the 'IPv4AddressCount' field, given as a #guint32.

    • ipv4_address: IPv4Element[]

      the 'IPv4Address' field, given as an array of #MbimIPv4Element items.

    • ipv6_address_count: number

      the 'IPv6AddressCount' field, given as a #guint32.

    • ipv6_address: IPv6Element[]

      the 'IPv6Address' field, given as an array of #MbimIPv6Element items.

    • ipv4_gateway: IPv4

      the 'IPv4Gateway' field, given as a #MbimIPv4.

    • ipv6_gateway: IPv6

      the 'IPv6Gateway' field, given as a #MbimIPv6.

    • ipv4_dns_server_count: number

      the 'IPv4DnsServerCount' field, given as a #guint32.

    • ipv4_dns_server: IPv4[]

      the 'IPv4DnsServer' field, given as an array of #MbimIPv4 items.

    • ipv6_dns_server_count: number

      the 'IPv6DnsServerCount' field, given as a #guint32.

    • ipv6_dns_server: IPv6[]

      the 'IPv6DnsServer' field, given as an array of #MbimIPv6 items.

    • ipv4_mtu: number

      the 'IPv4Mtu' field, given as a #guint32.

    • ipv6_mtu: number

      the 'IPv6Mtu' field, given as a #guint32.

    Returns Mbim.Message

  • ip_packet_filters_query_new(session_id: number, packet_filters_count: number, packet_filters: PacketFilter[]): Mbim.Message
  • Create a new request for the 'IP Packet Filters' query command in the 'Basic Connect' service.

    Parameters

    • session_id: number

      the 'SessionId' field, given as a #guint32.

    • packet_filters_count: number

      the 'PacketFiltersCount' field, given as a #guint32.

    • packet_filters: PacketFilter[]

      the 'PacketFilters' field, given as an array of #MbimPacketFilter items.

    Returns Mbim.Message

  • ip_packet_filters_set_new(session_id: number, packet_filters_count: number, packet_filters: PacketFilter[]): Mbim.Message
  • Create a new request for the 'IP Packet Filters' set command in the 'Basic Connect' service.

    Parameters

    • session_id: number

      the 'SessionId' field, given as a #guint32.

    • packet_filters_count: number

      the 'PacketFiltersCount' field, given as a #guint32.

    • packet_filters: PacketFilter[]

      the 'PacketFilters' field, given as an array of #MbimPacketFilter items.

    Returns Mbim.Message

  • ms_basic_connect_extensions_base_stations_info_query_new(max_gsm_count: number, max_umts_count: number, max_tdscdma_count: number, max_lte_count: number, max_cdma_count: number): Mbim.Message
  • Create a new request for the 'Base Stations Info' query command in the 'Ms Basic Connect Extensions' service.

    Parameters

    • max_gsm_count: number

      the 'MaxGsmCount' field, given as a #guint32.

    • max_umts_count: number

      the 'MaxUmtsCount' field, given as a #guint32.

    • max_tdscdma_count: number

      the 'MaxTdscdmaCount' field, given as a #guint32.

    • max_lte_count: number

      the 'MaxLteCount' field, given as a #guint32.

    • max_cdma_count: number

      the 'MaxCdmaCount' field, given as a #guint32.

    Returns Mbim.Message

  • ms_basic_connect_extensions_device_caps_query_new(): Mbim.Message
  • ms_basic_connect_extensions_device_slot_mappings_query_new(): Mbim.Message
  • ms_basic_connect_extensions_device_slot_mappings_set_new(map_count: number, slot_map: Mbim.Slot[]): Mbim.Message
  • Create a new request for the 'Device Slot Mappings' set command in the 'Ms Basic Connect Extensions' service.

    Parameters

    • map_count: number

      the 'MapCount' field, given as a #guint32.

    • slot_map: Mbim.Slot[]

      the 'SlotMap' field, given as an array of #MbimSlot items.

    Returns Mbim.Message

  • ms_basic_connect_extensions_location_info_status_query_new(): Mbim.Message
  • ms_basic_connect_extensions_lte_attach_configuration_query_new(): Mbim.Message
  • Create a new request for the 'Lte Attach Configuration' set command in the 'Ms Basic Connect Extensions' service.

    Parameters

    • operation: LteAttachContextOperation

      the 'Operation' field, given as a #MbimLteAttachContextOperation.

    • configuration_count: number

      the 'ConfigurationCount' field, given as a #guint32.

    • configurations: LteAttachConfiguration[]

      the 'Configurations' field, given as an array of #MbimLteAttachConfiguration items.

    Returns Mbim.Message

  • ms_basic_connect_extensions_lte_attach_info_query_new(): Mbim.Message
  • ms_basic_connect_extensions_lte_attach_status_query_new(): Mbim.Message
  • ms_basic_connect_extensions_provisioned_contexts_query_new(): Mbim.Message
  • Create a new request for the 'Provisioned Contexts' set command in the 'Ms Basic Connect Extensions' service.

    Parameters

    • operation: ContextOperation

      the 'Operation' field, given as a #MbimContextOperation.

    • context_type: Uuid

      the 'ContextType' field, given as a #MbimUuid.

    • ip_type: ContextIpType

      the 'IpType' field, given as a #MbimContextIpType.

    • state: ContextState

      the 'State' field, given as a #MbimContextState.

    • roaming: ContextRoamingControl

      the 'Roaming' field, given as a #MbimContextRoamingControl.

    • media_type: ContextMediaType

      the 'MediaType' field, given as a #MbimContextMediaType.

    • source: ContextSource

      the 'Source' field, given as a #MbimContextSource.

    • access_string: string

      the 'AccessString' field, given as a string.

    • user_name: string

      the 'UserName' field, given as a string.

    • password: string

      the 'Password' field, given as a string.

    • compression: Mbim.Compression

      the 'Compression' field, given as a #MbimCompression.

    • auth_protocol: AuthProtocol

      the 'AuthProtocol' field, given as a #MbimAuthProtocol.

    Returns Mbim.Message

  • ms_basic_connect_extensions_slot_info_status_query_new(slot_index: number): Mbim.Message
  • Create a new request for the 'Slot Info Status' query command in the 'Ms Basic Connect Extensions' service.

    Parameters

    • slot_index: number

      the 'SlotIndex' field, given as a #guint32.

    Returns Mbim.Message

  • ms_basic_connect_extensions_sys_caps_query_new(): Mbim.Message
  • ms_basic_connect_extensions_v2_version_query_new(mbim_version: number, mbim_extended_version: number): Mbim.Message
  • Create a new request for the 'Version' query command in the 'Ms Basic Connect Extensions V2' service.

    Parameters

    • mbim_version: number

      the 'MbimVersion' field, given as a #guint16.

    • mbim_extended_version: number

      the 'MbimExtendedVersion' field, given as a #guint16.

    Returns Mbim.Message

  • ms_basic_connect_extensions_v3_base_stations_info_query_new(max_gsm_count: number, max_umts_count: number, max_tdscdma_count: number, max_lte_count: number, max_cdma_count: number, max_nr_count: number): Mbim.Message
  • Create a new request for the 'Base Stations Info' query command in the 'Ms Basic Connect Extensions V3' service.

    Parameters

    • max_gsm_count: number

      the 'MaxGsmCount' field, given as a #guint32.

    • max_umts_count: number

      the 'MaxUmtsCount' field, given as a #guint32.

    • max_tdscdma_count: number

      the 'MaxTdscdmaCount' field, given as a #guint32.

    • max_lte_count: number

      the 'MaxLteCount' field, given as a #guint32.

    • max_cdma_count: number

      the 'MaxCdmaCount' field, given as a #guint32.

    • max_nr_count: number

      the 'MaxNrCount' field, given as a #guint32.

    Returns Mbim.Message

  • ms_basic_connect_extensions_v3_modem_configuration_query_new(): Mbim.Message
  • ms_basic_connect_extensions_v3_registration_parameters_query_new(): Mbim.Message
  • Create a new request for the 'Registration Parameters' set command in the 'Ms Basic Connect Extensions V3' service.

    Parameters

    • mico_mode: MicoMode

      the 'MicoMode' field, given as a #MbimMicoMode.

    • drx_cycle: DrxCycle

      the 'DrxCycle' field, given as a #MbimDrxCycle.

    • ladn_info: LadnInfo

      the 'LadnInfo' field, given as a #MbimLadnInfo.

    • default_pdu_activation_hint: DefaultPduActivationHint

      the 'DefaultPduActivationHint' field, given as a #MbimDefaultPduActivationHint.

    • re_register_if_nedeed: boolean

      the 'ReRegisterIfNedeed' field, given as a #gboolean.

    • unnamed_ies: Tlv[]

      the 'UnnamedIes' field, given as a list of # items.

    Returns Mbim.Message

  • ms_basic_connect_extensions_v3_wake_reason_query_new(): Mbim.Message
  • ms_basic_connect_v3_connect_query_new(session_id: number): Mbim.Message
  • Create a new request for the 'Connect' query command in the 'Ms Basic Connect V3' service.

    Parameters

    • session_id: number

      the 'SessionId' field, given as a #guint32.

    Returns Mbim.Message

  • Create a new request for the 'Connect' set command in the 'Ms Basic Connect V3' service.

    Parameters

    • session_id: number

      the 'SessionId' field, given as a #guint32.

    • activation_command: ActivationCommand

      the 'ActivationCommand' field, given as a #MbimActivationCommand.

    • compression: Mbim.Compression

      the 'Compression' field, given as a #MbimCompression.

    • auth_protocol: AuthProtocol

      the 'AuthProtocol' field, given as a #MbimAuthProtocol.

    • ip_type: ContextIpType

      the 'IpType' field, given as a #MbimContextIpType.

    • context_type: Uuid

      the 'ContextType' field, given as a #MbimUuid.

    • media_preference: AccessMediaType

      the 'MediaPreference' field, given as a #MbimAccessMediaType.

    • access_string: string

      the 'AccessString' field, given as a string.

    • user_name: string

      the 'UserName' field, given as a string.

    • password: string

      the 'Password' field, given as a string.

    • unnamed_ies: Tlv[]

      the 'UnnamedIes' field, given as a list of # items.

    Returns Mbim.Message

  • ms_basic_connect_v3_ip_packet_filters_query_new(session_id: number, packet_filters_count: number, packet_filters: PacketFilterV3[]): Mbim.Message
  • Create a new request for the 'IP Packet Filters' query command in the 'Ms Basic Connect V3' service.

    Parameters

    • session_id: number

      the 'SessionId' field, given as a #guint32.

    • packet_filters_count: number

      the 'PacketFiltersCount' field, given as a #guint32.

    • packet_filters: PacketFilterV3[]

      the 'PacketFilters' field, given as an array of #MbimPacketFilterV3 items.

    Returns Mbim.Message

  • ms_basic_connect_v3_ip_packet_filters_set_new(session_id: number, packet_filters_count: number, packet_filters: PacketFilterV3[]): Mbim.Message
  • Create a new request for the 'IP Packet Filters' set command in the 'Ms Basic Connect V3' service.

    Parameters

    • session_id: number

      the 'SessionId' field, given as a #guint32.

    • packet_filters_count: number

      the 'PacketFiltersCount' field, given as a #guint32.

    • packet_filters: PacketFilterV3[]

      the 'PacketFilters' field, given as an array of #MbimPacketFilterV3 items.

    Returns Mbim.Message

  • Create a new request for the 'Config' set command in the 'MS SAR' service.

    Parameters

    • mode: SarControlMode

      the 'Mode' field, given as a #MbimSarControlMode.

    • backoff_state: SarBackoffState

      the 'BackoffState' field, given as a #MbimSarBackoffState.

    • config_states_count: number

      the 'ConfigStatesCount' field, given as a #guint32.

    • config_states: SarConfigState[]

      the 'ConfigStates' field, given as an array of #MbimSarConfigState items.

    Returns Mbim.Message

  • Create a new request for the 'Transmission status' set command in the 'MS SAR' service.

    Parameters

    • channel_notification: TransmissionNotificationStatus

      the 'ChannelNotification' field, given as a #MbimTransmissionNotificationStatus.

    • hysteresis_timer: number

      the 'HysteresisTimer' field, given as a #guint32.

    Returns Mbim.Message

  • Create a new request for the 'APDU' set command in the 'MS UICC Low Level Access' service.

    Parameters

    • channel: number

      the 'Channel' field, given as a #guint32.

    • secure_messaging: UiccSecureMessaging

      the 'SecureMessaging' field, given as a #MbimUiccSecureMessaging.

    • class_byte_type: UiccClassByteType

      the 'ClassByteType' field, given as a #MbimUiccClassByteType.

    • command: Uint8Array

      the 'Command' field, given as an array of #guint8 values.

    Returns Mbim.Message

  • ms_uicc_low_level_access_close_channel_set_new(channel: number, channel_group: number): Mbim.Message
  • Create a new request for the 'Close Channel' set command in the 'MS UICC Low Level Access' service.

    Parameters

    • channel: number

      the 'Channel' field, given as a #guint32.

    • channel_group: number

      the 'ChannelGroup' field, given as a #guint32.

    Returns Mbim.Message

  • ms_uicc_low_level_access_open_channel_set_new(app_id: Uint8Array, select_p2_arg: number, channel_group: number): Mbim.Message
  • Create a new request for the 'Open Channel' set command in the 'MS UICC Low Level Access' service.

    Parameters

    • app_id: Uint8Array

      the 'AppId' field, given as an array of #guint8 values.

    • select_p2_arg: number

      the 'SelectP2Arg' field, given as a #guint32.

    • channel_group: number

      the 'ChannelGroup' field, given as a #guint32.

    Returns Mbim.Message

  • ms_uicc_low_level_access_reset_query_new(): Mbim.Message
  • ms_uicc_low_level_access_terminal_capability_query_new(): Mbim.Message
  • Create a new request for the 'Terminal Capability' set command in the 'MS UICC Low Level Access' service.

    Parameters

    • terminal_capability_count: number

      the 'TerminalCapabilityCount' field, given as a #guint32.

    • terminal_capability: TerminalCapabilityInfo[]

      the 'TerminalCapability' field, given as an array of #MbimTerminalCapabilityInfo items.

    Returns Mbim.Message

  • Create a new request for the 'Multicarrier Providers' set command in the 'Basic Connect' service.

    Parameters

    • providers_count: number

      the 'ProvidersCount' field, given as a #guint32.

    • providers: Mbim.Provider[]

      the 'Providers' field, given as an array of #MbimProvider items.

    Returns Mbim.Message

  • Create a new #MbimMessage of type %MBIM_MESSAGE_TYPE_OPEN_DONE with the specified parameters.

    Parameters

    • transaction_id: number

      transaction ID.

    • error_status_code: StatusError

      a #MbimStatusError.

    Returns Mbim.Message

  • open_new(transaction_id: number, max_control_transfer: number): Mbim.Message
  • Create a new #MbimMessage of type %MBIM_MESSAGE_TYPE_OPEN with the specified parameters.

    Parameters

    • transaction_id: number

      transaction ID.

    • max_control_transfer: number

      maximum control transfer.

    Returns Mbim.Message

  • Create a new request for the 'Delete' set command in the 'Phonebook' service.

    Parameters

    • filter_flag: PhonebookFlag

      the 'FilterFlag' field, given as a #MbimPhonebookFlag.

    • filter_message_index: number

      the 'FilterMessageIndex' field, given as a #guint32.

    Returns Mbim.Message

  • Create a new request for the 'Read' query command in the 'Phonebook' service.

    Parameters

    • filter_flag: PhonebookFlag

      the 'FilterFlag' field, given as a #MbimPhonebookFlag.

    • filter_message_index: number

      the 'FilterMessageIndex' field, given as a #guint32.

    Returns Mbim.Message

  • Create a new request for the 'Write' set command in the 'Phonebook' service.

    Parameters

    • save_flag: PhonebookWriteFlag

      the 'SaveFlag' field, given as a #MbimPhonebookWriteFlag.

    • save_index: number

      the 'SaveIndex' field, given as a #guint32.

    • number: string

      the 'Number' field, given as a string.

    • name: string

      the 'Name' field, given as a string.

    Returns Mbim.Message

  • Create a new request for the 'Pin' set command in the 'Basic Connect' service.

    Parameters

    • pin_type: PinType

      the 'PinType' field, given as a #MbimPinType.

    • pin_operation: PinOperation

      the 'PinOperation' field, given as a #MbimPinOperation.

    • pin: string

      the 'Pin' field, given as a string.

    • new_pin: string

      the 'NewPin' field, given as a string.

    Returns Mbim.Message

  • Create a new request for the 'Preferred Providers' set command in the 'Basic Connect' service.

    Parameters

    • providers_count: number

      the 'ProvidersCount' field, given as a #guint32.

    • providers: Mbim.Provider[]

      the 'Providers' field, given as an array of #MbimProvider items.

    Returns Mbim.Message

  • provisioned_contexts_set_new(context_id: number, context_type: Uuid, access_string: string, user_name: string, password: string, compression: Mbim.Compression, auth_protocol: AuthProtocol, provider_id: string): Mbim.Message
  • Create a new request for the 'Provisioned Contexts' set command in the 'Basic Connect' service.

    Parameters

    • context_id: number

      the 'ContextId' field, given as a #guint32.

    • context_type: Uuid

      the 'ContextType' field, given as a #MbimUuid.

    • access_string: string

      the 'AccessString' field, given as a string.

    • user_name: string

      the 'UserName' field, given as a string.

    • password: string

      the 'Password' field, given as a string.

    • compression: Mbim.Compression

      the 'Compression' field, given as a #MbimCompression.

    • auth_protocol: AuthProtocol

      the 'AuthProtocol' field, given as a #MbimAuthProtocol.

    • provider_id: string

      the 'ProviderId' field, given as a string.

    Returns Mbim.Message

  • proxy_control_configuration_set_new(device_path: string, timeout: number): Mbim.Message
  • Create a new request for the 'Configuration' set command in the 'Proxy Control' service.

    Parameters

    • device_path: string

      the 'DevicePath' field, given as a string.

    • timeout: number

      the 'Timeout' field, given as a #guint32.

    Returns Mbim.Message

  • Create a new request for the 'File Open' set command in the 'QDU' service.

    Parameters

    • file_type: QduFileType

      the 'FileType' field, given as a #MbimQduFileType.

    • file_size: number

      the 'FileSize' field, given as a #guint32.

    Returns Mbim.Message

  • qdu_file_write_set_new(data_buffer: Uint8Array): Mbim.Message
  • Create a new request for the 'File Write' set command in the 'QDU' service.

    Parameters

    • data_buffer: Uint8Array

      the 'DataBuffer' field, given as an array of #guint8 values.

    Returns Mbim.Message

  • Create a new request for the 'msg' set command in the 'QMI' service.

    Parameters

    • qmi_msg: Uint8Array

      the 'QmiMsg' field, given as an array of #guint8 values.

    Returns Mbim.Message

  • Create a new request for the 'Register State' set command in the 'Basic Connect' service.

    Parameters

    • provider_id: string

      the 'ProviderId' field, given as a string.

    • register_action: RegisterAction

      the 'RegisterAction' field, given as a #MbimRegisterAction.

    • data_class: Mbim.DataClass

      the 'DataClass' field, given as a #MbimDataClass.

    Returns Mbim.Message

  • service_activation_set_new(buffer: Uint8Array): Mbim.Message
  • Create a new request for the 'Service Activation' set command in the 'Basic Connect' service.

    Parameters

    • buffer: Uint8Array

      the 'Buffer' field, given as an array of #guint8 values.

    Returns Mbim.Message

  • signal_state_set_new(signal_strength_interval: number, rssi_threshold: number, error_rate_threshold: number): Mbim.Message
  • Create a new request for the 'Signal State' set command in the 'Basic Connect' service.

    Parameters

    • signal_strength_interval: number

      the 'SignalStrengthInterval' field, given as a #guint32.

    • rssi_threshold: number

      the 'RssiThreshold' field, given as a #guint32.

    • error_rate_threshold: number

      the 'ErrorRateThreshold' field, given as a #guint32.

    Returns Mbim.Message

  • Create a new request for the 'Configuration' set command in the 'SMS' service.

    Parameters

    • format: SmsFormat

      the 'Format' field, given as a #MbimSmsFormat.

    • sc_address: string

      the 'ScAddress' field, given as a string.

    Returns Mbim.Message

  • Create a new request for the 'Delete' set command in the 'SMS' service.

    Parameters

    • flag: SmsFlag

      the 'Flag' field, given as a #MbimSmsFlag.

    • message_index: number

      the 'MessageIndex' field, given as a #guint32.

    Returns Mbim.Message

  • Create a new request for the 'Read' query command in the 'SMS' service.

    Parameters

    • format: SmsFormat

      the 'Format' field, given as a #MbimSmsFormat.

    • flag: SmsFlag

      the 'Flag' field, given as a #MbimSmsFlag.

    • message_index: number

      the 'MessageIndex' field, given as a #guint32.

    Returns Mbim.Message

  • Create a new request for the 'Envelope' set command in the 'STK' service.

    Parameters

    • data: Uint8Array

      the 'Data' field, given as an array of #guint8 values.

    Returns Mbim.Message

  • stk_pac_set_new(pac_host_control: Uint8Array): Mbim.Message
  • Create a new request for the 'Pac' set command in the 'STK' service.

    Parameters

    • pac_host_control: Uint8Array

      the 'PacHostControl' field, given as an array of 32 #guint8 values.

    Returns Mbim.Message

  • stk_terminal_response_set_new(response: Uint8Array): Mbim.Message
  • Create a new request for the 'Terminal Response' set command in the 'STK' service.

    Parameters

    • response: Uint8Array

      the 'Response' field, given as an array of #guint8 values.

    Returns Mbim.Message

  • Create a new request for the '' set command in the 'USSD' service.

    Parameters

    • action: UssdAction

      the 'Action' field, given as a #MbimUssdAction.

    • data_coding_scheme: number

      the 'DataCodingScheme' field, given as a #guint32.

    • payload: Uint8Array

      the 'Payload' field, given as an array of #guint8 values.

    Returns Mbim.Message

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method