Tsarr Documentation - v2.16.0
    Preparing search index...

    Type Alias PluginInfo

    This is a serializable stub class that is used by the api to provide information about installed plugins.

    type PluginInfo = {
        Name?: string;
        Version?: string;
        ConfigurationFileName?: string | null;
        Description?: string;
        Id?: string;
        CanUninstall?: boolean;
        HasImage?: boolean;
        Status?:
            | "Active"
            | "Restart"
            | "Deleted"
            | "Superseded"
            | "Superceded"
            | "Malfunctioned"
            | "NotSupported"
            | "Disabled";
    }
    Index
    Name? Version? ConfigurationFileName? Description? Id? CanUninstall? HasImage? Status?
    Name?: string

    Gets or sets the name.

    Version?: string

    Gets or sets the version.

    ConfigurationFileName?: string | null

    Gets or sets the name of the configuration file.

    Description?: string

    Gets or sets the description.

    Id?: string

    Gets or sets the unique id.

    CanUninstall?: boolean

    Gets or sets a value indicating whether the plugin can be uninstalled.

    HasImage?: boolean

    Gets or sets a value indicating whether this plugin has a valid image.

    Status?:
        | "Active"
        | "Restart"
        | "Deleted"
        | "Superseded"
        | "Superceded"
        | "Malfunctioned"
        | "NotSupported"
        | "Disabled"

    Gets or sets a value indicating the status of the plugin.

    Settings
    Member Visibility

    On This Page
    Properties