Skip to content

IPlugin

Interface in Oadm.Sdk.Plugins · Oadm.Sdk.dll

What every plugin has: an id, a name and an icon.

public interface IPlugin

Extended or implemented by IActionPlugin, ICorePlugin, ITaskPlugin

Guide: Plugin basics

string DisplayName { get; }

Name shown in menus and the toolbar, e.g. “Restart” or “Upgrade firmware” (the tasks pane shows ITaskPlugin.GetTaskName of task plugins). Task plugins: at most TaskPluginNames.MaxDisplayNameLength characters and no trailing “…” (the host never appends one and strips it defensively); the loader logs a warning and shortens longer names with an ellipsis.

string? IconKey { get; }

An icon of the client by key without “Icon.” (“restart”, “network”); null for none. See the UI kit.

string Id { get; }

Stable id, e.g. “oadm.restart”.