Gjsify LogoGjsify Logo

Namespace Fwupd

Index

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

DeviceFlags

DeviceFlags: number

PluginFlags

PluginFlags: number

ReleaseFlags

ReleaseFlags: number

Variables

Const DBUS_INTERFACE

DBUS_INTERFACE: string

Const DBUS_PATH

DBUS_PATH: string

Const DBUS_SERVICE

DBUS_SERVICE: string

Const DEVICE_FLAG_ADD_COUNTERPART_GUIDS

DEVICE_FLAG_ADD_COUNTERPART_GUIDS: number

Const DEVICE_FLAG_ANOTHER_WRITE_REQUIRED

DEVICE_FLAG_ANOTHER_WRITE_REQUIRED: number

Const DEVICE_FLAG_BACKUP_BEFORE_INSTALL

DEVICE_FLAG_BACKUP_BEFORE_INSTALL: number

Const DEVICE_FLAG_CAN_VERIFY

DEVICE_FLAG_CAN_VERIFY: number

Const DEVICE_FLAG_CAN_VERIFY_IMAGE

DEVICE_FLAG_CAN_VERIFY_IMAGE: number

Const DEVICE_FLAG_DUAL_IMAGE

DEVICE_FLAG_DUAL_IMAGE: number

Const DEVICE_FLAG_ENSURE_SEMVER

DEVICE_FLAG_ENSURE_SEMVER: number

Const DEVICE_FLAG_HAS_MULTIPLE_BRANCHES

DEVICE_FLAG_HAS_MULTIPLE_BRANCHES: number

Const DEVICE_FLAG_HISTORICAL

DEVICE_FLAG_HISTORICAL: number

Const DEVICE_FLAG_IGNORE_VALIDATION

DEVICE_FLAG_IGNORE_VALIDATION: number

Const DEVICE_FLAG_INSTALL_ALL_RELEASES

DEVICE_FLAG_INSTALL_ALL_RELEASES: number

Const DEVICE_FLAG_INSTALL_PARENT_FIRST

DEVICE_FLAG_INSTALL_PARENT_FIRST: number

Const DEVICE_FLAG_INTERNAL

DEVICE_FLAG_INTERNAL: number

Const DEVICE_FLAG_IS_BOOTLOADER

DEVICE_FLAG_IS_BOOTLOADER: number

Const DEVICE_FLAG_LOCKED

DEVICE_FLAG_LOCKED: number

Const DEVICE_FLAG_MD_SET_ICON

DEVICE_FLAG_MD_SET_ICON: number

Const DEVICE_FLAG_MD_SET_NAME

DEVICE_FLAG_MD_SET_NAME: number

Const DEVICE_FLAG_MD_SET_NAME_CATEGORY

DEVICE_FLAG_MD_SET_NAME_CATEGORY: number

Const DEVICE_FLAG_MD_SET_VERFMT

DEVICE_FLAG_MD_SET_VERFMT: number

Const DEVICE_FLAG_NEEDS_ACTIVATION

DEVICE_FLAG_NEEDS_ACTIVATION: number

Const DEVICE_FLAG_NEEDS_BOOTLOADER

DEVICE_FLAG_NEEDS_BOOTLOADER: number

Const DEVICE_FLAG_NEEDS_REBOOT

DEVICE_FLAG_NEEDS_REBOOT: number

Const DEVICE_FLAG_NEEDS_SHUTDOWN

DEVICE_FLAG_NEEDS_SHUTDOWN: number

Const DEVICE_FLAG_NONE

DEVICE_FLAG_NONE: number

Const DEVICE_FLAG_NOTIFIED

DEVICE_FLAG_NOTIFIED: number

Const DEVICE_FLAG_NO_AUTO_INSTANCE_IDS

DEVICE_FLAG_NO_AUTO_INSTANCE_IDS: number

Const DEVICE_FLAG_NO_GUID_MATCHING

DEVICE_FLAG_NO_GUID_MATCHING: number

Const DEVICE_FLAG_ONLY_OFFLINE

DEVICE_FLAG_ONLY_OFFLINE: number

Const DEVICE_FLAG_ONLY_SUPPORTED

DEVICE_FLAG_ONLY_SUPPORTED: number

Const DEVICE_FLAG_REGISTERED

DEVICE_FLAG_REGISTERED: number

Const DEVICE_FLAG_REPORTED

DEVICE_FLAG_REPORTED: number

Const DEVICE_FLAG_REQUIRE_AC

DEVICE_FLAG_REQUIRE_AC: number

Const DEVICE_FLAG_SELF_RECOVERY

DEVICE_FLAG_SELF_RECOVERY: number

Const DEVICE_FLAG_SKIPS_RESTART

DEVICE_FLAG_SKIPS_RESTART: number

Const DEVICE_FLAG_SUPPORTED

DEVICE_FLAG_SUPPORTED: number

Const DEVICE_FLAG_TRUSTED

DEVICE_FLAG_TRUSTED: number

Const DEVICE_FLAG_UPDATABLE

DEVICE_FLAG_UPDATABLE: number

Const DEVICE_FLAG_UPDATABLE_HIDDEN

DEVICE_FLAG_UPDATABLE_HIDDEN: number

Const DEVICE_FLAG_USABLE_DURING_UPDATE

DEVICE_FLAG_USABLE_DURING_UPDATE: number

Const DEVICE_FLAG_USE_RUNTIME_VERSION

DEVICE_FLAG_USE_RUNTIME_VERSION: number

Const DEVICE_FLAG_VERSION_CHECK_REQUIRED

DEVICE_FLAG_VERSION_CHECK_REQUIRED: number

Const DEVICE_FLAG_WAIT_FOR_REPLUG

DEVICE_FLAG_WAIT_FOR_REPLUG: number

Const DEVICE_FLAG_WILL_DISAPPEAR

DEVICE_FLAG_WILL_DISAPPEAR: number

Const DEVICE_ID_ANY

DEVICE_ID_ANY: string

Const PLUGIN_FLAG_CAPSULES_UNSUPPORTED

PLUGIN_FLAG_CAPSULES_UNSUPPORTED: number

Const PLUGIN_FLAG_CLEAR_UPDATABLE

PLUGIN_FLAG_CLEAR_UPDATABLE: number

Const PLUGIN_FLAG_DISABLED

PLUGIN_FLAG_DISABLED: number

Const PLUGIN_FLAG_EFIVAR_NOT_MOUNTED

PLUGIN_FLAG_EFIVAR_NOT_MOUNTED: number

Const PLUGIN_FLAG_ESP_NOT_FOUND

PLUGIN_FLAG_ESP_NOT_FOUND: number

Const PLUGIN_FLAG_FAILED_OPEN

PLUGIN_FLAG_FAILED_OPEN: number

Const PLUGIN_FLAG_LEGACY_BIOS

PLUGIN_FLAG_LEGACY_BIOS: number

Const PLUGIN_FLAG_NONE

PLUGIN_FLAG_NONE: number

Const PLUGIN_FLAG_NO_HARDWARE

PLUGIN_FLAG_NO_HARDWARE: number

Const PLUGIN_FLAG_UNLOCK_REQUIRED

PLUGIN_FLAG_UNLOCK_REQUIRED: number

Const PLUGIN_FLAG_USER_WARNING

PLUGIN_FLAG_USER_WARNING: number

Const RELEASE_FLAG_BLOCKED_APPROVAL

RELEASE_FLAG_BLOCKED_APPROVAL: number

Const RELEASE_FLAG_BLOCKED_VERSION

RELEASE_FLAG_BLOCKED_VERSION: number

Const RELEASE_FLAG_IS_ALTERNATE_BRANCH

RELEASE_FLAG_IS_ALTERNATE_BRANCH: number

Const RELEASE_FLAG_IS_DOWNGRADE

RELEASE_FLAG_IS_DOWNGRADE: number

Const RELEASE_FLAG_IS_UPGRADE

RELEASE_FLAG_IS_UPGRADE: number

Const RELEASE_FLAG_NONE

RELEASE_FLAG_NONE: number

Const RELEASE_FLAG_TRUSTED_METADATA

RELEASE_FLAG_TRUSTED_METADATA: number

Const RELEASE_FLAG_TRUSTED_PAYLOAD

RELEASE_FLAG_TRUSTED_PAYLOAD: number

Const RESULT_KEY_APPSTREAM_ID

RESULT_KEY_APPSTREAM_ID: string

Const RESULT_KEY_BRANCH

RESULT_KEY_BRANCH: string

Const RESULT_KEY_CATEGORIES

RESULT_KEY_CATEGORIES: string

Const RESULT_KEY_CHECKSUM

RESULT_KEY_CHECKSUM: string

Const RESULT_KEY_CREATED

RESULT_KEY_CREATED: string

Const RESULT_KEY_DESCRIPTION

RESULT_KEY_DESCRIPTION: string

Const RESULT_KEY_DETACH_CAPTION

RESULT_KEY_DETACH_CAPTION: string

Const RESULT_KEY_DETACH_IMAGE

RESULT_KEY_DETACH_IMAGE: string

Const RESULT_KEY_DETAILS_URL

RESULT_KEY_DETAILS_URL: string

Const RESULT_KEY_DEVICE_ID

RESULT_KEY_DEVICE_ID: string

Const RESULT_KEY_FILENAME

RESULT_KEY_FILENAME: string

Const RESULT_KEY_FLAGS

RESULT_KEY_FLAGS: string

Const RESULT_KEY_FLASHES_LEFT

RESULT_KEY_FLASHES_LEFT: string

Const RESULT_KEY_GUID

RESULT_KEY_GUID: string

Const RESULT_KEY_HOMEPAGE

RESULT_KEY_HOMEPAGE: string

Const RESULT_KEY_HSI_LEVEL

RESULT_KEY_HSI_LEVEL: string

Const RESULT_KEY_HSI_RESULT

RESULT_KEY_HSI_RESULT: string

Const RESULT_KEY_ICON

RESULT_KEY_ICON: string

Const RESULT_KEY_INSTALL_DURATION

RESULT_KEY_INSTALL_DURATION: string

Const RESULT_KEY_INSTANCE_IDS

RESULT_KEY_INSTANCE_IDS: string

Const RESULT_KEY_ISSUES

RESULT_KEY_ISSUES: string

Const RESULT_KEY_LICENSE

RESULT_KEY_LICENSE: string

Const RESULT_KEY_LOCATIONS

RESULT_KEY_LOCATIONS: string

Const RESULT_KEY_METADATA

RESULT_KEY_METADATA: string

Const RESULT_KEY_MODIFIED

RESULT_KEY_MODIFIED: string

Const RESULT_KEY_NAME

RESULT_KEY_NAME: string

Const RESULT_KEY_NAME_VARIANT_SUFFIX

RESULT_KEY_NAME_VARIANT_SUFFIX: string

Const RESULT_KEY_PARENT_DEVICE_ID

RESULT_KEY_PARENT_DEVICE_ID: string

Const RESULT_KEY_PLUGIN

RESULT_KEY_PLUGIN: string

Const RESULT_KEY_PROTOCOL

RESULT_KEY_PROTOCOL: string

Const RESULT_KEY_RELEASE

RESULT_KEY_RELEASE: string

Const RESULT_KEY_REMOTE_ID

RESULT_KEY_REMOTE_ID: string

Const RESULT_KEY_SERIAL

RESULT_KEY_SERIAL: string

Const RESULT_KEY_SIZE

RESULT_KEY_SIZE: string

Const RESULT_KEY_SOURCE_URL

RESULT_KEY_SOURCE_URL: string

Const RESULT_KEY_STATUS

RESULT_KEY_STATUS: string

Const RESULT_KEY_SUMMARY

RESULT_KEY_SUMMARY: string

Const RESULT_KEY_TRUST_FLAGS

RESULT_KEY_TRUST_FLAGS: string

Const RESULT_KEY_UPDATE_ERROR

RESULT_KEY_UPDATE_ERROR: string

Const RESULT_KEY_UPDATE_IMAGE

RESULT_KEY_UPDATE_IMAGE: string

Const RESULT_KEY_UPDATE_MESSAGE

RESULT_KEY_UPDATE_MESSAGE: string

Const RESULT_KEY_UPDATE_STATE

RESULT_KEY_UPDATE_STATE: string

Const RESULT_KEY_URGENCY

RESULT_KEY_URGENCY: string

Const RESULT_KEY_URI

RESULT_KEY_URI: string

Const RESULT_KEY_VENDOR

RESULT_KEY_VENDOR: string

Const RESULT_KEY_VENDOR_ID

RESULT_KEY_VENDOR_ID: string

Const RESULT_KEY_VERSION

RESULT_KEY_VERSION: string

Const RESULT_KEY_VERSION_BOOTLOADER

RESULT_KEY_VERSION_BOOTLOADER: string

Const RESULT_KEY_VERSION_BOOTLOADER_RAW

RESULT_KEY_VERSION_BOOTLOADER_RAW: string

Const RESULT_KEY_VERSION_FORMAT

RESULT_KEY_VERSION_FORMAT: string

Const RESULT_KEY_VERSION_LOWEST

RESULT_KEY_VERSION_LOWEST: string

Const RESULT_KEY_VERSION_LOWEST_RAW

RESULT_KEY_VERSION_LOWEST_RAW: string

Const RESULT_KEY_VERSION_RAW

RESULT_KEY_VERSION_RAW: string

Const SECURITY_ATTR_ID_ACPI_DMAR

SECURITY_ATTR_ID_ACPI_DMAR: string

Const SECURITY_ATTR_ID_ENCRYPTED_RAM

SECURITY_ATTR_ID_ENCRYPTED_RAM: string

Const SECURITY_ATTR_ID_FWUPD_ATTESTATION

SECURITY_ATTR_ID_FWUPD_ATTESTATION: string

Const SECURITY_ATTR_ID_FWUPD_PLUGINS

SECURITY_ATTR_ID_FWUPD_PLUGINS: string

Const SECURITY_ATTR_ID_FWUPD_UPDATES

SECURITY_ATTR_ID_FWUPD_UPDATES: string

Const SECURITY_ATTR_ID_INTEL_BOOTGUARD_ACM

SECURITY_ATTR_ID_INTEL_BOOTGUARD_ACM: string

Const SECURITY_ATTR_ID_INTEL_BOOTGUARD_ENABLED

SECURITY_ATTR_ID_INTEL_BOOTGUARD_ENABLED: string

Const SECURITY_ATTR_ID_INTEL_BOOTGUARD_OTP

SECURITY_ATTR_ID_INTEL_BOOTGUARD_OTP: string

Const SECURITY_ATTR_ID_INTEL_BOOTGUARD_POLICY

SECURITY_ATTR_ID_INTEL_BOOTGUARD_POLICY: string

Const SECURITY_ATTR_ID_INTEL_BOOTGUARD_VERIFIED

SECURITY_ATTR_ID_INTEL_BOOTGUARD_VERIFIED: string

Const SECURITY_ATTR_ID_INTEL_CET_ACTIVE

SECURITY_ATTR_ID_INTEL_CET_ACTIVE: string

Const SECURITY_ATTR_ID_INTEL_CET_ENABLED

SECURITY_ATTR_ID_INTEL_CET_ENABLED: string

Const SECURITY_ATTR_ID_INTEL_DCI_ENABLED

SECURITY_ATTR_ID_INTEL_DCI_ENABLED: string

Const SECURITY_ATTR_ID_INTEL_DCI_LOCKED

SECURITY_ATTR_ID_INTEL_DCI_LOCKED: string

Const SECURITY_ATTR_ID_INTEL_SMAP

SECURITY_ATTR_ID_INTEL_SMAP: string

Const SECURITY_ATTR_ID_IOMMU

SECURITY_ATTR_ID_IOMMU: string

Const SECURITY_ATTR_ID_KERNEL_LOCKDOWN

SECURITY_ATTR_ID_KERNEL_LOCKDOWN: string

Const SECURITY_ATTR_ID_KERNEL_SWAP

SECURITY_ATTR_ID_KERNEL_SWAP: string

Const SECURITY_ATTR_ID_KERNEL_TAINTED

SECURITY_ATTR_ID_KERNEL_TAINTED: string

Const SECURITY_ATTR_ID_MEI_MANUFACTURING_MODE

SECURITY_ATTR_ID_MEI_MANUFACTURING_MODE: string

Const SECURITY_ATTR_ID_MEI_OVERRIDE_STRAP

SECURITY_ATTR_ID_MEI_OVERRIDE_STRAP: string

Const SECURITY_ATTR_ID_MEI_VERSION

SECURITY_ATTR_ID_MEI_VERSION: string

Const SECURITY_ATTR_ID_SPI_BIOSWE

SECURITY_ATTR_ID_SPI_BIOSWE: string

Const SECURITY_ATTR_ID_SPI_BLE

SECURITY_ATTR_ID_SPI_BLE: string

Const SECURITY_ATTR_ID_SPI_SMM_BWP

SECURITY_ATTR_ID_SPI_SMM_BWP: string

Const SECURITY_ATTR_ID_SUSPEND_TO_IDLE

SECURITY_ATTR_ID_SUSPEND_TO_IDLE: string

Const SECURITY_ATTR_ID_SUSPEND_TO_RAM

SECURITY_ATTR_ID_SUSPEND_TO_RAM: string

Const SECURITY_ATTR_ID_TPM_RECONSTRUCTION_PCR0

SECURITY_ATTR_ID_TPM_RECONSTRUCTION_PCR0: string

Const SECURITY_ATTR_ID_TPM_VERSION_20

SECURITY_ATTR_ID_TPM_VERSION_20: string

Const SECURITY_ATTR_ID_UEFI_PK

SECURITY_ATTR_ID_UEFI_PK: string

Const SECURITY_ATTR_ID_UEFI_SECUREBOOT

SECURITY_ATTR_ID_UEFI_SECUREBOOT: string

Functions

build_history_report_json

  • build_history_report_json(devices: Fwupd.Device[]): string

  • Builds a JSON report for the list of devices. No filtering is done on the devices array, and it is expected that the caller will filter to something sane, e.g. %FWUPD_DEVICE_FLAG_REPORTED at the bare minimum.

    Parameters

    Returns string

build_machine_id

  • build_machine_id(salt: string): string

  • Gets a salted hash of the /etc/machine-id contents. This can be used to identify a specific machine. It is not possible to recover the original machine-id from the machine-hash.

    Parameters

    • salt: string

      The salt, or %NULL for none

    Returns string

build_user_agent

  • build_user_agent(package_name: string, package_version: string): string

  • Builds a user-agent to use for the download.

    Supplying harmless details to the server means it knows more about each client. This allows the web service to respond in a different way, for instance sending a different metadata file for old versions of fwupd, or returning an error for Solaris machines.

    Before freaking out about theoretical privacy implications, much more data than this is sent to each and every website you visit.

    Rather that using this function you should use fwupd_client_set_user_agent_for_package() which uses the runtime version of the daemon rather than the build-time version.

    Parameters

    • package_name: string

      client program name, e.g. "gnome-software"

    • package_version: string

      client program version, e.g. "3.28.1"

    Returns string

checksum_format_for_display

  • checksum_format_for_display(checksum: string): string

checksum_get_best

  • checksum_get_best(checksums: string[]): string

checksum_get_by_kind

  • checksum_get_by_kind(checksums: string[], kind: ChecksumType): string

checksum_guess_kind

error_from_string

error_quark

error_to_string

feature_flag_from_string

feature_flag_to_string

get_os_release

guid_from_string

  • guid_from_string(guidstr: string, guid: number, flags: GuidFlags): boolean

  • Converts a string GUID into its binary encoding. All string GUIDs are formatted as big endian but on-disk can be encoded in different ways.

    Parameters

    • guidstr: string

      a GUID, e.g. 00112233-4455-6677-8899-aabbccddeeff

    • guid: number

      a #fwupd_guid_t, or NULL to just check the GUID

    • flags: GuidFlags

      some %FwupdGuidFlags, e.g. %FWUPD_GUID_FLAG_MIXED_ENDIAN

    Returns boolean

guid_hash_data

  • guid_hash_data(data: number, datasz: number, flags: GuidFlags): string

  • Returns a GUID for some data. This uses a hash and so even small differences in the data will produce radically different return values.

    The implementation is taken from RFC4122, Section 4.1.3; specifically using a type-5 SHA-1 hash.

    Parameters

    • data: number

      data to hash

    • datasz: number

      length of data

    • flags: GuidFlags

      some %FwupdGuidFlags, e.g. %FWUPD_GUID_FLAG_NAMESPACE_MICROSOFT

    Returns string

guid_hash_string

  • guid_hash_string(str: string): string

  • Returns a GUID for a given string. This uses a hash and so even small differences in the str will produce radically different return values.

    The default implementation is taken from RFC4122, Section 4.1.3; specifically using a type-5 SHA-1 hash with a DNS namespace. The same result can be obtained with this simple python program:

    #!/usr/bin/python import uuid print uuid.uuid5(uuid.NAMESPACE_DNS, 'python.org')

    Parameters

    • str: string

      A source string to use as a key

    Returns string

guid_is_valid

  • guid_is_valid(guid: string): boolean

  • Checks the string is a valid GUID.

    Parameters

    • guid: string

      string to check, e.g. 00112233-4455-6677-8899-aabbccddeeff

    Returns boolean

guid_to_string

  • guid_to_string(guid: number, flags: GuidFlags): string

  • Returns a text GUID of mixed or BE endian for a packed buffer.

    Parameters

    • guid: number

      a #fwupd_guid_t to read

    • flags: GuidFlags

      some %FwupdGuidFlags, e.g. %FWUPD_GUID_FLAG_MIXED_ENDIAN

    Returns string

keyring_kind_from_string

  • keyring_kind_from_string(keyring_kind: string): KeyringKind

keyring_kind_to_string

  • keyring_kind_to_string(keyring_kind: KeyringKind): string

status_from_string

status_to_string

trust_flag_from_string

  • trust_flag_from_string(trust_flag: string): TrustFlags

trust_flag_to_string

  • trust_flag_to_string(trust_flag: TrustFlags): string

update_state_from_string

  • update_state_from_string(update_state: string): UpdateState

update_state_to_string

  • update_state_to_string(update_state: UpdateState): string

version_format_from_string

version_format_to_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

Generated using TypeDoc v0.22.17 Gjsify Theme v0.1.0