FwupdPlugin.Backend
Description: Reference for FwupdPlugin.Backend

### Class

# FwupdPluginBackend

since: 1.0

#### Description [src]

    class FwupdPlugin.Backend : GObject.Object
    {
      /* No available fields */
    }

An device discovery backend, for instance USB, BlueZ or UDev.

See also: `FuDevice`

Available since: 1.0

#### Hierarchy

#### Ancestors

- GObject

#### Instance methods

###### fu_backend_add_string

Add backend-specific device metadata to an existing string.

since: 1.8.4

###### fu_backend_coldplug

Adds devices using the subclassed backend. If `fu_backend_setup()` has not already been called then it is run before this function automatically.

since: 1.6.1

###### fu_backend_device_added

Emits a signal that indicates the device has been added.

since: 1.6.1

###### fu_backend_device_changed

Emits a signal that indicates the device has been changed.

since: 1.6.1

###### fu_backend_device_removed

Emits a signal that indicates the device has been removed.

since: 1.6.1

###### fu_backend_get_context

Gets the context for a backend.

since: 1.6.1

###### fu_backend_get_devices

Gets all the devices added by the backend.

since: 1.6.1

###### fu_backend_get_enabled

Return the boolean value of a key if it’s been configured.

since: 1.6.1

###### fu_backend_get_name

Return the name of the backend, which is normally set by the subclass.

since: 1.6.1

###### fu_backend_invalidate

Normally when calling `fu_backend_setup()` multiple times it is only actually done once. Calling this method causes the next requests to `fu_backend_setup()` to actually probe the hardware.

since: 1.8.0

###### fu_backend_load

Loads the backend from a JSON object.

since: 1.8.5

###### fu_backend_lookup_by_id

Gets a device previously added by the backend.

since: 1.6.1

###### fu_backend_registered

Calls the ->registered() vfunc for the backend. This allows the backend to perform shared backend actions on superclassed devices.

since: 1.7.4

###### fu_backend_save

Saves the backend to a JSON builder.

since: 1.8.5

###### fu_backend_set_enabled

Sets the backend enabled state.

since: 1.6.1

###### fu_backend_setup

Sets up the backend ready for use, which typically calls the subclassed setup function. No devices should be added or removed at this point.

since: 1.6.1

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

Please see GObject for a full list of methods.

#### Properties

###### FwupdPlugin.Backend:can-invalidate

If the backend can be invalidated.

since: 1.8.0

###### FwupdPlugin.Backend:context

The `FuContent` to use.

since: 1.6.1

###### FwupdPlugin.Backend:name

The backend name.

since: 1.6.1

#### Signals

###### FwupdPlugin.Backend::device-added

The ::device-added signal is emitted when a device has been added.

since: 1.6.1

###### FwupdPlugin.Backend::device-changed

The ::device-changed signal is emitted when a device has been changed.

since: 1.6.1

###### FwupdPlugin.Backend::device-removed

The ::device-removed signal is emitted when a device has been removed.

since: 1.6.1

##### 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.

unstable since: 2.0

#### Class structure

    struct FwupdPluginBackendClass {
      GObjectClass parent_class;
      gboolean (* setup) (
        FuBackend* self,
        FuProgress* progress,
        GError** error
      );
      gboolean (* coldplug) (
        FuBackend* self,
        FuProgress* progress,
        GError** error
      );
      void (* registered) (
        FuBackend* self,
        FuDevice* device
      );
      void (* invalidate) (
        FuBackend* self
      );
      void (* to_string) (
        FuBackend* self,
        guint indent,
        GString* str
      );
      gboolean (* load) (
        FuBackend* self,
        JsonObject* json_object,
        const gchar* tag,
        FuBackendLoadFlags flags,
        GError** error
      );
      gboolean (* save) (
        FuBackend* self,
        JsonBuilder* json_builder,
        const gchar* tag,
        FuBackendSaveFlags flags,
        GError** error
      );

    }

No description available.

###### Class members

`parent_class: GObjectClass`
  No description available.
`setup: gboolean (* setup) ( FuBackend* self, FuProgress* progress, GError** error )`
  No description available.
`coldplug: gboolean (* coldplug) ( FuBackend* self, FuProgress* progress, GError** error )`
  No description available.
`registered: void (* registered) ( FuBackend* self, FuDevice* device )`
  No description available.
`invalidate: void (* invalidate) ( FuBackend* self )`
  No description available.
`to_string: void (* to_string) ( FuBackend* self, guint indent, GString* str )`
  No description available.
`load: gboolean (* load) ( FuBackend* self, JsonObject* json_object, const gchar* tag, FuBackendLoadFlags flags, GError** error )`
  No description available.
`save: gboolean (* save) ( FuBackend* self, JsonBuilder* json_builder, const gchar* tag, FuBackendSaveFlags flags, GError** error )`
  No description available.

#### Virtual methods

###### FwupdPlugin.BackendClass.coldplug

Adds devices using the subclassed backend. If `fu_backend_setup()` has not already been called then it is run before this function automatically.

since: 1.6.1

###### FwupdPlugin.BackendClass.invalidate

Normally when calling `fu_backend_setup()` multiple times it is only actually done once. Calling this method causes the next requests to `fu_backend_setup()` to actually probe the hardware.

since: 1.8.0

###### FwupdPlugin.BackendClass.load

Loads the backend from a JSON object.

since: 1.8.5

###### FwupdPlugin.BackendClass.registered

Calls the ->registered() vfunc for the backend. This allows the backend to perform shared backend actions on superclassed devices.

since: 1.7.4

###### FwupdPlugin.BackendClass.save

Saves the backend to a JSON builder.

since: 1.8.5

###### FwupdPlugin.BackendClass.setup

Sets up the backend ready for use, which typically calls the subclassed setup function. No devices should be added or removed at this point.

since: 1.6.1

###### FwupdPlugin.BackendClass.to_string

No description available.

since: 1.0