Fwupd.BiosSetting
Description: Reference for Fwupd.BiosSetting

### Class

# FwupdBiosSetting

#### Description [src]

    class Fwupd.BiosSetting : GObject.Object
      implements Fwupd.Codec {
      /* No available fields */
    }

A BIOS setting that represents a setting in the firmware.

#### Hierarchy

#### Ancestors

- GObject

#### Implements

- FwupdCodec

#### Constructors

###### fwupd_bios_setting_new

Creates a new bios setting.

since: 1.8.4

#### Instance methods

###### fwupd_bios_setting_add_possible_value

Adds a possible value to the attribute. This indicates one of the values the kernel driver will accept from userspace.

since: 1.8.4

###### fwupd_bios_setting_add_possible_value_full

Adds a possible value to the attribute that is automatically mapped to a raw value.

since: 2.1.6

###### fwupd_bios_setting_get_appstream_id

Gets the vendor-neutral fwupd AppStream identifier for this setting, e.g. `org.fwupd.bios.secure-boot`.

since: 2.1.7

###### fwupd_bios_setting_get_current_value

Gets the string representation of the current_value stored in an attribute from the kernel. This value is cached; so changing it outside of fwupd may may put it out of sync.

since: 1.8.4

###### fwupd_bios_setting_get_description

Gets the attribute description which is provided by some drivers to explain what they change.

since: 1.8.4

###### fwupd_bios_setting_get_filename

Gets the filename within `path` where values are read/written.

since: 2.1.1

###### fwupd_bios_setting_get_icon

Gets the icon name for this setting, e.g. `application-certificate`.

since: 2.1.7

###### fwupd_bios_setting_get_id

Gets the unique attribute identifier for this attribute/driver.

since: 1.8.4

###### fwupd_bios_setting_get_kind

Gets the BIOS setting type used by the kernel interface.

since: 1.8.4

###### fwupd_bios_setting_get_lower_bound

Gets the lower bound for integer attributes or minimum length for string attributes.

since: 1.8.4

###### fwupd_bios_setting_get_name

Gets the attribute name.

since: 1.8.4

###### fwupd_bios_setting_get_path

Gets the path for the driver providing the attribute.

since: 1.8.4

###### fwupd_bios_setting_get_possible_values

Find all possible values for an enumeration attribute.

since: 1.8.4

###### fwupd_bios_setting_get_read_only

Determines if a BIOS setting is read only.

since: 1.8.4

###### fwupd_bios_setting_get_scalar_increment

Gets the scalar increment used for integer attributes.

since: 1.8.4

###### fwupd_bios_setting_get_upper_bound

Gets the upper bound for integer attributes or maximum length for string attributes.

since: 1.8.4

###### fwupd_bios_setting_has_possible_value

Finds out if a specific possible value was added to the attribute.

since: 1.8.4

###### fwupd_bios_setting_map_possible_value

Attempts to map a user provided string into strings that a `FwupdBiosSetting` can support. The following heuristics are used: - Ignore case sensitivity - Map obviously “positive” phrases into a value that turns on the `FwupdBiosSetting` - Map obviously “negative” phrases into a value that turns off the `FwupdBiosSetting`.

since: 1.8.4

###### fwupd_bios_setting_set_appstream_id

Sets the vendor-neutral fwupd AppStream identifier for this setting.

since: 2.1.7

###### fwupd_bios_setting_set_current_value

Sets the string stored in an attribute.

since: 1.8.4

###### fwupd_bios_setting_set_description

Sets the attribute description.

since: 1.8.4

###### fwupd_bios_setting_set_filename

Sets the filename within `path` where values are read/written. If not set, defaults to “current_value”.

since: 2.1.1

###### fwupd_bios_setting_set_icon

Sets the icon name for this setting.

since: 2.1.7

###### fwupd_bios_setting_set_id

Sets the unique attribute identifier for this attribute.

since: 1.8.4

###### fwupd_bios_setting_set_kind

Sets the BIOS setting type used by the kernel interface.

since: 1.8.4

###### fwupd_bios_setting_set_lower_bound

Sets the lower bound used for BIOS integer attributes or max length for string attributes.

since: 1.8.4

###### fwupd_bios_setting_set_name

Sets the attribute name provided by a kernel driver.

since: 1.8.4

###### fwupd_bios_setting_set_path

Sets path to the attribute.

since: 1.8.4

###### fwupd_bios_setting_set_read_only

Configures whether an attribute is read only maximum length for string attributes.

since: 1.8.4

###### fwupd_bios_setting_set_scalar_increment

Sets the scalar increment used for BIOS integer attributes.

since: 1.8.4

###### fwupd_bios_setting_set_upper_bound

Sets the upper bound used for BIOS integer attributes or max length for string attributes.

since: 1.8.4

###### fwupd_bios_setting_setup

Reads the current value, converting to the display value as required.

since: 2.1.6

###### fwupd_bios_setting_write_value

Writes a new value into the setting if it is different from the current value.

since: 1.9.4

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

##### Methods inherited from FwupdCodec (8)

###### fwupd_codec_add_string

Converts an object that implements `FwupdCodec` to a debug string, appending it to `str`.

since: 2.0.0

###### fwupd_codec_from_json

Converts an object that implements `FwupdCodec` from a JSON object.

since: 2.0.0

###### fwupd_codec_from_json_string

Converts an object that implements `FwupdCodec` from a JSON string.

since: 2.0.0

###### fwupd_codec_from_variant

Converts an object that implements `FwupdCodec` from a `GVariant` value.

since: 2.0.0

###### fwupd_codec_to_json

Converts an object that implements `FwupdCodec` to a JSON builder object.

since: 2.0.0

###### fwupd_codec_to_json_string

Converts an object that implements `FwupdCodec` to a JSON string.

since: 2.0.0

###### fwupd_codec_to_string

Converts an object that implements `FwupdCodec` to a debug string.

since: 2.0.0

###### fwupd_codec_to_variant

Converts an object that implements `FwupdCodec` to a `GVariant`.

since: 2.0.0

#### Signals

##### Signals inherited from GObject (1)

###### GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

#### Class structure

    struct FwupdBiosSettingClass {
      GObjectClass parent_class;
      gboolean (* write_value) (
        FwupdBiosSetting* self,
        const gchar* value,
        GError** error
      );
      gchar* (* read_value) (
        FwupdBiosSetting* self,
        GError** error
      );
      void (* _fwupd_reserved3) (
    void
      );
      void (* _fwupd_reserved4) (
    void
      );
      void (* _fwupd_reserved5) (
    void
      );
      void (* _fwupd_reserved6) (
    void
      );
      void (* _fwupd_reserved7) (
    void
      );

    }

No description available.

###### Class members

`parent_class: GObjectClass`

  No description available.

`write_value: gboolean (* write_value) ( FwupdBiosSetting* self, const gchar* value, GError** error )`

  No description available.

`read_value: gchar* (* read_value) ( FwupdBiosSetting* self, GError** error )`

  No description available.

`_fwupd_reserved3: void (* _fwupd_reserved3) ( void )`

  No description available.

`_fwupd_reserved4: void (* _fwupd_reserved4) ( void )`

  No description available.

`_fwupd_reserved5: void (* _fwupd_reserved5) ( void )`

  No description available.

`_fwupd_reserved6: void (* _fwupd_reserved6) ( void )`

  No description available.

`_fwupd_reserved7: void (* _fwupd_reserved7) ( void )`

  No description available.

#### Virtual methods

###### Fwupd.BiosSettingClass.read_value

No description available.

###### Fwupd.BiosSettingClass.write_value

Writes a new value into the setting if it is different from the current value.

since: 1.9.4