FwupdPlugin: fwupd Reference Manual

## FwupdPlugin FwupdPlugin |

## Functions

FwupdPlugin * | fwupd_plugin_new ()
gchar * | fwupd_plugin_to_string ()
const gchar * | fwupd_plugin_get_name ()
void | fwupd_plugin_set_name ()
guint64 | fwupd_plugin_get_flags ()
void | fwupd_plugin_set_flags ()
void | fwupd_plugin_add_flag ()
void | fwupd_plugin_remove_flag ()
gboolean | fwupd_plugin_has_flag ()
FwupdPlugin * | fwupd_plugin_from_variant ()
GPtrArray * | fwupd_plugin_array_from_variant ()

## Types and Values

#define | FWUPD_TYPE_PLUGIN
struct | FwupdPluginClass
| FwupdPlugin

## Description

## Functions

### fwupd_plugin_new ()

    FwupdPlugin *
    fwupd_plugin_new (void);

Creates a new plugin.

#### Returns

a new FwupdPlugin

Since: 1.5.0

### fwupd_plugin_to_string ()

    gchar *
    fwupd_plugin_to_string (FwupdPlugin *self);

Builds a text representation of the object.

#### Parameters

self | a FwupdPlugin |

#### Returns

text, or `NULL` for invalid

Since: 1.5.0

### fwupd_plugin_get_name ()

    const gchar *
    fwupd_plugin_get_name (FwupdPlugin *self);

Gets the plugin name.

#### Parameters

self | a FwupdPlugin |

#### Returns

the plugin name, or `NULL` if unset

Since: 1.5.0

### fwupd_plugin_set_name ()

    void
    fwupd_plugin_set_name (FwupdPlugin *self,
                           const gchar *name);

Sets the plugin name.

#### Parameters

self | a FwupdPlugin |
name | the plugin name, e.g. `bios` |

Since: 1.5.0

### fwupd_plugin_get_flags ()

    guint64
    fwupd_plugin_get_flags (FwupdPlugin *self);

Gets the plugin flags.

#### Parameters

self | a FwupdPlugin |

#### Returns

plugin flags, or 0 if unset

Since: 1.5.0

### fwupd_plugin_set_flags ()

    void
    fwupd_plugin_set_flags (FwupdPlugin *self,
                            guint64 flags);

Sets the plugin flags.

#### Parameters

self | a FwupdPlugin |
flags | plugin flags, e.g. `FWUPD_PLUGIN_FLAG_CAPSULES_UNSUPPORTED` |

Since: 1.5.0

### fwupd_plugin_add_flag ()

    void
    fwupd_plugin_add_flag (FwupdPlugin *self,
                           FwupdPluginFlags flag);

Adds a specific plugin flag to the plugin.

#### Parameters

self | a FwupdPlugin |
flag | the FwupdPluginFlags |

Since: 1.5.0

### fwupd_plugin_remove_flag ()

    void
    fwupd_plugin_remove_flag (FwupdPlugin *self,
                              FwupdPluginFlags flag);

Removes a specific plugin flag from the plugin.

#### Parameters

self | a FwupdPlugin |
flag | a plugin flag |

Since: 1.5.0

### fwupd_plugin_has_flag ()

    gboolean
    fwupd_plugin_has_flag (FwupdPlugin *self,
                           FwupdPluginFlags flag);

Finds if the plugin has a specific plugin flag.

#### Parameters

self | a FwupdPlugin |
flag | a plugin flag |

#### Returns

`TRUE` if the flag is set

Since: 1.5.0

### fwupd_plugin_from_variant ()

    FwupdPlugin *
    fwupd_plugin_from_variant (GVariant *value);

Creates a new plugin using serialized data.

#### Parameters

value | the serialized data |

#### Returns

a new FwupdPlugin, or `NULL` if `value` was invalid.

[transfer full]

Since: 1.5.0

### fwupd_plugin_array_from_variant ()

    GPtrArray *
    fwupd_plugin_array_from_variant (GVariant *value);

Creates an array of new plugins using serialized data.

#### Parameters

value | the serialized data |

#### Returns

plugins, or `NULL` if `value` was invalid.

[transfer container][element-type FwupdPlugin]

Since: 1.5.0

## Types and Values

### FWUPD_TYPE_PLUGIN

    #define FWUPD_TYPE_PLUGIN (fwupd_plugin_get_type ())

### struct FwupdPluginClass

    struct FwupdPluginClass {
    	GObjectClass			 parent_class;
    };

### FwupdPlugin

    typedef struct _FwupdPlugin FwupdPlugin;

A plugin which is used by fwupd to enumerate and update devices.

See also: [class`FwupdRelease` ]