Gjsify LogoGjsify Logo

Index

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

Message: any

Variables

CID_BROADCAST: number

A symbol specifying the broadcast CID.

CID_NONE: number

A symbol specifying a special CID value that references no CID.

CLIENT_CID: string

Symbol defining the #QmiClient:client-cid property.

CLIENT_DEVICE: string

Symbol defining the #QmiClient:client-device property.

CLIENT_SERVICE: string

Symbol defining the #QmiClient:client-service property.

CLIENT_VALID: string

Symbol defining the #QmiClient:client-valid property.

CLIENT_VERSION_MAJOR: string

Symbol defining the #QmiClient:client-version-major property.

CLIENT_VERSION_MINOR: string

Symbol defining the #QmiClient:client-version-minor property.

DBUS_ERROR_PREFIX: string

Symbol defining the common string prefix used for all libqmi errors in DBus.

DEVICE_FILE: string

Symbol defining the #QmiDevice:device-file property.

DEVICE_MUX_ID_MAX: number

Symbol defining the maximum supported mux id.

DEVICE_MUX_ID_MIN: number

Symbol defining the minimum supported mux id.

DEVICE_MUX_ID_UNBOUND: number

Symbol defining the mux id for an unbound interface. This value is also used to indicate an invalid mux id.

DEVICE_NODE: string
DEVICE_NO_FILE_CHECK: string

Symbol defining the #QmiDevice:device-no-file-check property.

DEVICE_PROXY_PATH: string

Symbol defining the #QmiDevice:device-proxy-path property.

DEVICE_SIGNAL_INDICATION: string

Symbol defining the #QmiDevice::indication signal.

DEVICE_SIGNAL_REMOVED: string

Symbol defining the #QmiDevice::device-removed signal.

DEVICE_WWAN_IFACE: string

Symbol defining the #QmiDevice:device-wwan-iface property.

MESSAGE_QMUX_MARKER: number

First byte of every QMI message.

MESSAGE_VENDOR_GENERIC: number

Generic vendor id (0x0000).

PROXY_N_CLIENTS: string

Symbol defining the #QmiProxy:qmi-proxy-n-clients property.

PROXY_SOCKET_PATH: string

Symbol defining the default abstract socket name where the #QmiProxy will listen.

WDS_RATE_UNAVAILABLE: number

The TX/RX rate information is unavailable or cannot be measured.

Functions

  • Gets the nickname string for the #QmiCoreError specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiDataEndpointType specified at val.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiDeviceAddLinkFlags in mask.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiDeviceOpenFlags in mask.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiDeviceReleaseClientFlags in mask.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiDmsBandCapability in mask.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiDmsHpDeviceMode specified at val.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiDmsLteBandCapability in mask.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiDmsMacType specified at val.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiDmsOfflineReason in mask.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiDmsOperatingMode specified at val.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiDmsPowerState in mask.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiDmsSimCapability specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiDmsTimeSource specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiDmsUimFacility specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiDmsUimPinId specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiDmsUimPinStatus specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiDmsUimState specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiDsdApnType specified at val.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiDsdApnTypePreference in mask.

    Parameters

    Returns string

  • endianGetString(val: Endian): string
  • Gets the nickname string for the #QmiEndian specified at val.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiLocDeleteCellDatabase in mask.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiLocDeleteClockInfo in mask.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiLocDeleteGnssData in mask.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiLocDeleteSvInfo in mask.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiLocEngineState specified at val.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiLocEventRegistrationFlag in mask.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiLocHealthStatus specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiLocLockType specified at val.

    Parameters

    Returns string

  • locNmeaTypeBuildStringFromMask(mask: LocNmeaType): string
  • Builds a string containing a comma-separated list of nicknames for each #QmiLocNmeaType in mask.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiLocOperationMode specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiLocReliability specified at val.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiLocSatelliteValidInformation in mask.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiLocSensorDataUsage in mask.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiLocServerAddressType in mask.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiLocServerType specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiLocSessionStatus specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiLocSystem specified at val.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiLocTechnologyUsed in mask.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiLocTimeSource specified at val.

    Parameters

    Returns string

  • messageAddRawTlv(self: any, type: number, raw: number, length: number): boolean
  • Creates a new type TLV with the value given in raw, and adds it to the #QmiMessage.

    Parameters

    • self: any

      a #QmiMessage.

    • type: number

      specific ID of the TLV to add.

    • raw: number

      raw data buffer with the value of the TLV.

    • length: number

      length of the raw data buffer.

    Returns boolean

  • messageForeachRawTlv(self: any): void
  • Calls the given function for each TLV found within the #QmiMessage.

    Parameters

    • self: any

      a #QmiMessage.

    Returns void

  • messageGetClientId(self: any): number
  • Gets the client ID of the message.

    Parameters

    • self: any

      a #QmiMessage.

    Returns number

  • messageGetData(self: any): [number, number]
  • Gets the data buffer of the #QmiMessage without the QMUX header.

    Parameters

    • self: any

      a #QmiMessage.

    Returns [number, number]

  • messageGetLength(self: any): number
  • Gets the length of the raw data corresponding to the given #QmiMessage.

    Parameters

    • self: any

      a #QmiMessage.

    Returns number

  • messageGetMessageId(self: any): number
  • Gets the ID of the message.

    Parameters

    • self: any

      a #QmiMessage.

    Returns number

  • messageGetPrintableFull(self: any, context: MessageContext, linePrefix: string): string
  • Gets a printable string with the contents of the whole QMI message.

    If known, the printable string will contain translated TLV values as well as the raw data buffer contents.

    The translation of the contents may be specific to the context provided, e.g. for vendor-specific messages.

    If no context given, the behavior is the same as qmi_message_get_printable().

    Parameters

    • self: any

      a #QmiMessage.

    • context: MessageContext

      a #QmiMessageContext.

    • linePrefix: string

      prefix string to use in each new generated line.

    Returns string

  • messageGetRaw(self: any): [number, number]
  • Gets the raw data buffer of the #QmiMessage.

    Parameters

    • self: any

      a #QmiMessage.

    Returns [number, number]

  • messageGetRawTlv(self: any, type: number): [number, number]
  • Get the raw data buffer of a specific TLV within the #QmiMessage.

    Parameters

    • self: any

      a #QmiMessage.

    • type: number

      specific ID of the TLV to get.

    Returns [number, number]

  • Gets the service corresponding to the given #QmiMessage.

    Parameters

    • self: any

      a #QmiMessage.

    Returns Qmi.Service

  • messageGetTlvPrintable(self: any, linePrefix: string, type: number, raw: number, rawLength: number): string
  • Gets a printable string with the contents of the TLV.

    This method is the most generic one and doesn't try to translate the TLV contents.

    Parameters

    • self: any

      a #QmiMessage.

    • linePrefix: string

      prefix string to use in each new generated line.

    • type: number

      type of the TLV.

    • raw: number

      raw data buffer with the value of the TLV.

    • rawLength: number

      length of the raw data buffer.

    Returns string

  • messageGetTransactionId(self: any): number
  • Gets the transaction ID of the message.

    Parameters

    • self: any

      a #QmiMessage.

    Returns number

  • messageIsIndication(self: any): boolean
  • Checks whether the given #QmiMessage is an indication.

    Parameters

    • self: any

      a #QmiMessage.

    Returns boolean

  • messageIsRequest(self: any): boolean
  • Checks whether the given #QmiMessage is a request.

    Parameters

    • self: any

      a #QmiMessage.

    Returns boolean

  • messageIsResponse(self: any): boolean
  • Checks whether the given #QmiMessage is a response.

    Parameters

    • self: any

      a #QmiMessage.

    Returns boolean

  • messageNew(service: Qmi.Service, clientId: number, transactionId: number, messageId: number): Qmi.Message
  • Create a new #QmiMessage with the specified parameters.

    Note that transaction_id must be less than #G_MAXUINT8 if service is #QMI_SERVICE_CTL.

    Parameters

    • service: Qmi.Service

      a #QmiService

    • clientId: number

      client ID of the originating control point.

    • transactionId: number

      transaction ID.

    • messageId: number

      message ID.

    Returns Qmi.Message

  • messageNewFromData(service: Qmi.Service, clientId: number, qmiData: Uint8Array): [Qmi.Message, Uint8Array]
  • Create a new #QmiMessage for the given service and client_id and including the given QMI data buffer.

    Whenever a complete QMI message is read, its data gets removed from the qmi_data buffer.

    This method should be used instead of qmi_message_new_from_raw() if the input data doesn't have QMUX headers.

    Parameters

    • service: Qmi.Service

      a #QmiService

    • clientId: number

      client ID of the originating control point.

    • qmiData: Uint8Array

      data buffer containing only the QMI part of the message.

    Returns [Qmi.Message, Uint8Array]

  • messageNewFromRaw(raw: Uint8Array): [Qmi.Message, Uint8Array]
  • Create a new #QmiMessage from the given raw data buffer.

    Whenever a complete QMI message is read, its raw data gets removed from the raw buffer.

    Parameters

    • raw: Uint8Array

      raw data buffer.

    Returns [Qmi.Message, Uint8Array]

  • Atomically increments the reference count of self by one.

    Parameters

    • self: any

      a #QmiMessage.

    Returns Qmi.Message

  • Create a new response #QmiMessage for the specified request.

    Parameters

    • request: any

      a request #QmiMessage.

    • error: Qmi.ProtocolError

      a #QmiProtocolError to set in the result TLV.

    Returns Qmi.Message

  • messageSetTransactionId(self: any, transactionId: number): void
  • Overwrites the transaction ID of the message.

    Parameters

    • self: any

      a #QmiMessage.

    • transactionId: number

      transaction id.

    Returns void

  • messageTlvReadFixedSizeString(self: any, tlvOffset: number, offset: number, stringLength: number): [boolean, number, string]
  • Reads a string from the TLV.

    The string written in out will need to be NUL-terminated by the caller.

    offset needs to point to a valid gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, offset will be updated to point past the read item.

    Since 1.24.6 the read string is guaranteed to be valid UTF-8.

    The fixed sized field may be suffixed with e.g. 0xFF if the contents are shorter than string_length. Since 1.26, this method will return the valid UTF-8 characters in the start of the string, instead of returning an error when doing the full UTF-8 string validation.

    Parameters

    • self: any

      a #QmiMessage.

    • tlvOffset: number

      offset that was returned by qmi_message_tlv_read_init().

    • offset: number

      address of a the offset within the TLV value.

    • stringLength: number

      amount of bytes to read.

    Returns [boolean, number, string]

  • messageTlvReadGdouble(self: any, tlvOffset: number, offset: number, endian: Endian): [boolean, number, number]
  • Reads a 64-bit floating-point number from the TLV.

    offset needs to point to a valid gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, offset will be updated to point past the read item.

    Parameters

    • self: any

      a #QmiMessage.

    • tlvOffset: number

      offset that was returned by qmi_message_tlv_read_init().

    • offset: number

      address of a the offset within the TLV value.

    • endian: Endian

      source endianness, which will be swapped to host byte order if necessary.

    Returns [boolean, number, number]

  • messageTlvReadGfloatEndian(self: any, tlvOffset: number, offset: number, endian: Endian): [boolean, number, number]
  • Reads a 32-bit floating-point number from the TLV.

    offset needs to point to a valid gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, offset will be updated to point past the read item.

    Parameters

    • self: any

      a #QmiMessage.

    • tlvOffset: number

      offset that was returned by qmi_message_tlv_read_init().

    • offset: number

      address of a the offset within the TLV value.

    • endian: Endian

      source endianness, which will be swapped to host byte order if necessary.

    Returns [boolean, number, number]

  • messageTlvReadGint16(self: any, tlvOffset: number, offset: number, endian: Endian): [boolean, number, number]
  • Reads a signed 16-bit integer from the TLV, in host byte order.

    offset needs to point to a valid gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, offset will be updated to point past the read item.

    Parameters

    • self: any

      a #QmiMessage.

    • tlvOffset: number

      offset that was returned by qmi_message_tlv_read_init().

    • offset: number

      address of a the offset within the TLV value.

    • endian: Endian

      source endianness, which will be swapped to host byte order if necessary.

    Returns [boolean, number, number]

  • messageTlvReadGint32(self: any, tlvOffset: number, offset: number, endian: Endian): [boolean, number, number]
  • Reads a signed 32-bit integer from the TLV, in host byte order.

    offset needs to point to a valid gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, offset will be updated to point past the read item.

    Parameters

    • self: any

      a #QmiMessage.

    • tlvOffset: number

      offset that was returned by qmi_message_tlv_read_init().

    • offset: number

      address of a the offset within the TLV value.

    • endian: Endian

      source endianness, which will be swapped to host byte order if necessary.

    Returns [boolean, number, number]

  • messageTlvReadGint64(self: any, tlvOffset: number, offset: number, endian: Endian): [boolean, number, number]
  • Reads a signed 64-bit integer from the TLV, in host byte order.

    offset needs to point to a valid gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, offset will be updated to point past the read item.

    Parameters

    • self: any

      a #QmiMessage.

    • tlvOffset: number

      offset that was returned by qmi_message_tlv_read_init().

    • offset: number

      address of a the offset within the TLV value.

    • endian: Endian

      source endianness, which will be swapped to host byte order if necessary.

    Returns [boolean, number, number]

  • messageTlvReadGint8(self: any, tlvOffset: number, offset: number): [boolean, number, number]
  • Reads a signed byte from the TLV.

    offset needs to point to a valid gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, offset will be updated to point past the read item.

    Parameters

    • self: any

      a #QmiMessage.

    • tlvOffset: number

      offset that was returned by qmi_message_tlv_read_init().

    • offset: number

      address of a the offset within the TLV value.

    Returns [boolean, number, number]

  • messageTlvReadGuint16(self: any, tlvOffset: number, offset: number, endian: Endian): [boolean, number, number]
  • Reads an unsigned 16-bit integer from the TLV, in host byte order.

    offset needs to point to a valid gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, offset will be updated to point past the read item.

    Parameters

    • self: any

      a #QmiMessage.

    • tlvOffset: number

      offset that was returned by qmi_message_tlv_read_init().

    • offset: number

      address of a the offset within the TLV value.

    • endian: Endian

      source endianness, which will be swapped to host byte order if necessary.

    Returns [boolean, number, number]

  • messageTlvReadGuint32(self: any, tlvOffset: number, offset: number, endian: Endian): [boolean, number, number]
  • Reads an unsigned 32-bit integer from the TLV, in host byte order.

    offset needs to point to a valid gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, offset will be updated to point past the read item.

    Parameters

    • self: any

      a #QmiMessage.

    • tlvOffset: number

      offset that was returned by qmi_message_tlv_read_init().

    • offset: number

      address of a the offset within the TLV value.

    • endian: Endian

      source endianness, which will be swapped to host byte order if necessary.

    Returns [boolean, number, number]

  • messageTlvReadGuint64(self: any, tlvOffset: number, offset: number, endian: Endian): [boolean, number, number]
  • Reads an unsigned 64-bit integer from the TLV, in host byte order.

    offset needs to point to a valid gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, offset will be updated to point past the read item.

    Parameters

    • self: any

      a #QmiMessage.

    • tlvOffset: number

      offset that was returned by qmi_message_tlv_read_init().

    • offset: number

      address of a the offset within the TLV value.

    • endian: Endian

      source endianness, which will be swapped to host byte order if necessary.

    Returns [boolean, number, number]

  • messageTlvReadGuint8(self: any, tlvOffset: number, offset: number): [boolean, number, number]
  • Reads an unsigned byte from the TLV.

    offset needs to point to a valid gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, offset will be updated to point past the read item.

    Parameters

    • self: any

      a #QmiMessage.

    • tlvOffset: number

      offset that was returned by qmi_message_tlv_read_init().

    • offset: number

      address of the offset within the TLV value.

    Returns [boolean, number, number]

  • messageTlvReadInit(self: any, type: number): [number, number]
  • Starts reading a given TLV from the #QmiMessage.

    Parameters

    • self: any

      a #QmiMessage.

    • type: number

      specific ID of the TLV to read.

    Returns [number, number]

  • messageTlvReadRemainingSize(self: any, tlvOffset: number, offset: number): number
  • Parameters

    • self: any
    • tlvOffset: number
    • offset: number

    Returns number

  • messageTlvReadSizedGuint(self: any, tlvOffset: number, offset: number, nBytes: number, endian: Endian): [boolean, number, number]
  • Reads a b_bytes-sized integer from the TLV, in host byte order.

    offset needs to point to a valid gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, offset will be updated to point past the read item.

    Parameters

    • self: any

      a #QmiMessage.

    • tlvOffset: number

      offset that was returned by qmi_message_tlv_read_init().

    • offset: number

      address of a the offset within the TLV value.

    • nBytes: number

      number of bytes to read.

    • endian: Endian

      source endianness, which will be swapped to host byte order if necessary.

    Returns [boolean, number, number]

  • messageTlvReadString(self: any, tlvOffset: number, offset: number, nSizePrefixBytes: number, maxSize: number): [boolean, number, string]
  • Reads a string from the TLV.

    offset needs to point to a valid gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, offset will be updated to point past the read item.

    Since 1.24.6 the read string is guaranteed to be valid UTF-8. Also, in order to overcome known firmware errors on string fields, this method will also attempt to parse the string as GSM-7 or UCS-2 if the initial UTF-8 validation fails.

    Parameters

    • self: any

      a #QmiMessage.

    • tlvOffset: number

      offset that was returned by qmi_message_tlv_read_init().

    • offset: number

      address of a the offset within the TLV value.

    • nSizePrefixBytes: number

      number of bytes used in the size prefix.

    • maxSize: number

      maximum number of bytes to read, or 0 to read all available bytes.

    Returns [boolean, number, string]

  • messageTlvWriteComplete(self: any, tlvOffset: number): boolean
  • Completes building a TLV in the #QmiMessage.

    In case of error the TLV will be reseted; i.e. there is no need to explicitly call qmi_message_tlv_write_reset().

    Parameters

    • self: any

      a #QmiMessage.

    • tlvOffset: number

      offset that was returned by qmi_message_tlv_write_init().

    Returns boolean

  • messageTlvWriteGint16(self: any, endian: Endian, in_: number): boolean
  • Appends a signed 16-bit integer to the TLV being built. The number to be written is expected to be given in host endianness, and this method takes care of converting the value written to the byte order specified by endian.

    Parameters

    • self: any

      a #QmiMessage.

    • endian: Endian

      target endianness, swapped from host byte order if necessary.

    • in_: number

      a #gint16 in host byte order.

    Returns boolean

  • messageTlvWriteGint32(self: any, endian: Endian, in_: number): boolean
  • Appends a signed 32-bit integer to the TLV being built. The number to be written is expected to be given in host endianness, and this method takes care of converting the value written to the byte order specified by endian.

    Parameters

    • self: any

      a #QmiMessage.

    • endian: Endian

      target endianness, swapped from host byte order if necessary.

    • in_: number

      a #gint32 in host byte order.

    Returns boolean

  • messageTlvWriteGint64(self: any, endian: Endian, in_: number): boolean
  • Appends a signed 32-bit integer to the TLV being built. The number to be written is expected to be given in host endianness, and this method takes care of converting the value written to the byte order specified by endian.

    Parameters

    • self: any

      a #QmiMessage.

    • endian: Endian

      target endianness, swapped from host byte order if necessary.

    • in_: number

      a #gint64 in host byte order.

    Returns boolean

  • messageTlvWriteGint8(self: any, in_: number): boolean
  • Appends a signed byte variable to the TLV being built.

    Parameters

    • self: any

      a #QmiMessage.

    • in_: number

      a #gint8.

    Returns boolean

  • messageTlvWriteGuint16(self: any, endian: Endian, in_: number): boolean
  • Appends an unsigned 16-bit integer to the TLV being built. The number to be written is expected to be given in host endianness, and this method takes care of converting the value written to the byte order specified by endian.

    Parameters

    • self: any

      a #QmiMessage.

    • endian: Endian

      target endianness, swapped from host byte order if necessary.

    • in_: number

      a #guint16 in host byte order.

    Returns boolean

  • messageTlvWriteGuint32(self: any, endian: Endian, in_: number): boolean
  • Appends an unsigned 32-bit integer to the TLV being built. The number to be written is expected to be given in host endianness, and this method takes care of converting the value written to the byte order specified by endian.

    Parameters

    • self: any

      a #QmiMessage.

    • endian: Endian

      target endianness, swapped from host byte order if necessary.

    • in_: number

      a #guint32 in host byte order.

    Returns boolean

  • messageTlvWriteGuint64(self: any, endian: Endian, in_: number): boolean
  • Appends an unsigned 64-bit integer to the TLV being built. The number to be written is expected to be given in host endianness, and this method takes care of converting the value written to the byte order specified by endian.

    Parameters

    • self: any

      a #QmiMessage.

    • endian: Endian

      target endianness, swapped from host byte order if necessary.

    • in_: number

      a #guint64 in host byte order.

    Returns boolean

  • messageTlvWriteGuint8(self: any, in_: number): boolean
  • Appends an unsigned byte to the TLV being built.

    Parameters

    • self: any

      a #QmiMessage.

    • in_: number

      a #guint8.

    Returns boolean

  • messageTlvWriteInit(self: any, type: number): number
  • Starts building a new TLV in the #QmiMessage.

    In order to finish adding the TLV, qmi_message_tlv_write_complete() needs to be called.

    If any error happens adding fields on the TLV, the previous state can be recovered using qmi_message_tlv_write_reset().

    Parameters

    • self: any

      a #QmiMessage.

    • type: number

      specific ID of the TLV to add.

    Returns number

  • messageTlvWriteReset(self: any, tlvOffset: number): void
  • Removes the TLV being currently added.

    Parameters

    • self: any

      a #QmiMessage.

    • tlvOffset: number

      offset that was returned by qmi_message_tlv_write_init().

    Returns void

  • messageTlvWriteSizedGuint(self: any, nBytes: number, endian: Endian, in_: number): boolean
  • Appends a n_bytes-sized unsigned integer to the TLV being built. The number to be written is expected to be given in host endianness, and this method takes care of converting the value written to the byte order specified by endian.

    The value of n_bytes can be any between 1 and 8.

    Parameters

    • self: any

      a #QmiMessage.

    • nBytes: number

      number of bytes to write.

    • endian: Endian

      target endianness, swapped from host byte order if necessary.

    • in_: number

      a #guint64 in host byte order.

    Returns boolean

  • messageTlvWriteString(self: any, nSizePrefixBytes: number, in_: string, inLength: number): boolean
  • Appends a string to the TLV being built.

    Fixed-sized strings should give n_size_prefix_bytes equal to 0.

    Parameters

    • self: any

      a #QmiMessage.

    • nSizePrefixBytes: number

      number of bytes to use in the size prefix.

    • in_: string

      string to write.

    • inLength: number

      length of in, or -1 if in is NUL-terminated.

    Returns boolean

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

    Parameters

    • self: any

      a #QmiMessage.

    Returns void

  • Gets the nickname string for the #QmiNasActiveBand specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiNasAttachState specified at val.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiNasBandPreference in mask.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiNasBoolean specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiNasCdmaPilotType specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiNasDayOfWeek specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiNasDLBandwidth specified at val.

    Parameters

    Returns string

  • nasDrxGetString(val: NasDrx): string
  • Gets the nickname string for the #QmiNasDrx specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiNasEvdoSinrLevel specified at val.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiNasLteBandPreference in mask.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiNasNetworkNameDisplayCondition in mask.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiNasNetworkScanType in mask.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiNasNetworkStatus in mask.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiNasNetworkType specified at val.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiNasPlmnAccessTechnologyIdentifier in mask.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiNasRadioTechnologyPreference in mask.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiNasRatModePreference in mask.

    Parameters

    Returns string

  • Converts the encoded data in array to UTF-8 and returns a newly allocated NUL-terminated string.

    Parameters

    Returns string

  • Converts the encoded data in array to UTF-8 and returns a newly allocated NUL-terminated string.

    Parameters

    • encoding: NasPlmnEncodingScheme

      a #QmiNasPlmnEncodingScheme.

    • array: Uint8Array

      a #GArray with the encoded data.

    Returns string

  • Gets the nickname string for the #QmiNasRejectCause specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiNasRoamingStatus specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiNasScellState specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiNasServiceStatus specified at val.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiNasSignalStrengthRequest in mask.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiNasSwiEmmState specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiNasSwiModemMode specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiNasSwiPsState specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiNasSwiSystemMode specified at val.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiNasTdScdmaBandPreference in mask.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiNasWcdmaRrcState specified at val.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiPbmEventRegistrationFlag in mask.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiPbmPhonebookType in mask.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiPbmSessionType specified at val.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiPdsDataValid in mask.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiPdsNetworkMode specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiPdsOperatingMode specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiPdsOperationMode specified at val.

    Parameters

    Returns string

  • protocolErrorQuark(): Quark
  • qosEventGetString(val: QosEvent): string
  • Gets the nickname string for the #QmiQosEvent specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiQosStatus specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiSarRfState specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiService specified at val.

    Parameters

    Returns string

  • sioPortGetString(val: SioPort): string
  • Gets the nickname string for the #QmiSioPort specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiUimCardError specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiUimCardProtocol specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiUimCardState specified at val.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiUimConfiguration in mask.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiUimEventRegistrationFlag in mask.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiUimFileType specified at val.

    Parameters

    Returns string

  • uimPinIdGetString(val: UimPinId): string
  • Gets the nickname string for the #QmiUimPinId specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiUimPinState specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiUimRefreshMode specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiUimRefreshStage specified at val.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiUimSecurityAttribute in mask.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiUimSessionType specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiUimSlotState specified at val.

    Parameters

    Returns string

  • utilsGetTracesEnabled(): boolean
  • Checks whether QMI message traces are currently enabled.

    Returns boolean

  • utilsSetTracesEnabled(enabled: boolean): void
  • Sets whether QMI message traces are enabled or disabled.

    Parameters

    • enabled: boolean

      %TRUE to enable traces, %FALSE to disable them.

    Returns void

  • voiceAlsGetString(val: VoiceAls): string
  • Gets the nickname string for the #QmiVoiceAls specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiVoiceCallMode specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiVoiceCallType specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiVoiceDomain specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiVoicePrivacy specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiVoiceTtyMode specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiVoiceUserAction specified at val.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiVoiceWcdmaAmrStatus in mask.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiWdsApnTypeMask in mask.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiWdsAuthentication in mask.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiWdsCallEndReason specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiWdsCallType specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiWdsClientType specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiWdsDataCallType specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiWdsDataSystem specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiWdsDeliveryOrder specified at val.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiWdsExtendedDataBearerTechnology3gpp2 in mask.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiWdsExtendedDataBearerTechnology3gpp in mask.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiWdsGetCurrentSettingsRequestedSettings in mask.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiWdsIpFamily specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiWdsIpSupportType specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiWdsNetworkType specified at val.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiWdsPacketStatisticsMaskFlag in mask.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiWdsPdpType specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiWdsProfileFamily specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiWdsProfileType specified at val.

    Parameters

    Returns string

  • wdsRat3gpp2BuildStringFromMask(mask: WdsRat3gpp2): string
  • Builds a string containing a comma-separated list of nicknames for each #QmiWdsRat3gpp2 in mask.

    Parameters

    Returns string

  • wdsRat3gppBuildStringFromMask(mask: WdsRat3gpp): string
  • Builds a string containing a comma-separated list of nicknames for each #QmiWdsRat3gpp in mask.

    Parameters

    • mask: WdsRat3gpp

      bitmask of QmiWdsRat3gpp values.

    Returns string

  • Gets the nickname string for the #QmiWdsSduErrorRatio specified at val.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiWdsSetEventReportTransferStatistics in mask.

    Parameters

    Returns string

  • wdsSoCdma1xBuildStringFromMask(mask: WdsSoCdma1x): string
  • Builds a string containing a comma-separated list of nicknames for each #QmiWdsSoCdma1x in mask.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiWdsSoEvdoRev0 in mask.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiWdsSoEvdoRevA in mask.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiWdsSoEvdoRevB in mask.

    Parameters

    Returns string

  • Builds a string containing a comma-separated list of nicknames for each #QmiWdsTechnologyPreference in mask.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiWdsTrafficClass specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiWmsAckIndicator specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiWmsCdmaCauseCode specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiWmsMessageClass specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiWmsMessageFormat specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiWmsMessageMode specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiWmsMessageType specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiWmsReceiptAction specified at val.

    Parameters

    Returns string

  • Gets the nickname string for the #QmiWmsStorageType specified at val.

    Parameters

    Returns string

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