Oadm.Sdk.Plugins

The plugin interfaces and the context the server gives them: task plugins, core plugins, steps, permissions.

Interfaces

Type	Description
`ICorePlugin`	A service that runs inside the server while it is turned on, usually with a page in the navigation rail (ICorePluginPage in the client part).
`ICorePluginContext`	What the server gives a core plugin in ICorePlugin.StartAsync.
`ICorePluginDownloads`	Optional for a core plugin: files its page downloads (gRPC PluginService.Download).
`IPlugin`	What every plugin has: an id, a name and an icon.
`IPluginEvents`	Pushes live events from a core plugin to every client page watching it (gRPC PluginService.Watch).
`IPluginSettings`	Settings store namespaced per plugin.
`ISecretProtector`	Server-side encryption for secrets a plugin persists.
`ITaskExecutionContext`	What the server gives one task while it runs on one device.
`ITaskPlugin`	An entry of the device context menu that runs on the server, one task per selected device.
`ITaskPluginQuery`	Optional for task plugins whose dialog must read the current device state before the user decides (existing users, current network settings, installed ACAP applications, firmware status).
`ITaskQueryContext`	What the server gives a query (ITaskPluginQuery.QueryAsync).
`ITaskStep`	One named step of a task, started with ITaskExecutionContext.BeginStep.
`ITrustAnchors`	Extra certificate authorities the server trusts when it rates device certificates (the Certificate column of the device grid), e.g.
`IUploadedFiles`	Files the user uploaded from the client (firmware images, ACAP .eap packages).

Classes

Type	Description
`DeviceIdentityException`	The device answering at an address is not the expected one (different or missing serial number).
`HostPermissionKeys`	The keys of the permissions OADM itself defines (the host’s rows of the matrix).
`PermissionKeys`	Keys of permissions: the format the host stores and checks.
`PluginDownload`	A file a core plugin sends to its client page through gRPC PluginService.Download (ICorePluginDownloads.OpenDownloadAsync): the host copies PluginDownload.Content to the client in chunks and disposes the download afterwards, also when the client cancels.
`SdkInfo`	The version of this SDK.
`TaskGroups`	Well-known context menu groups (ITaskPlugin.Group).
`TaskPluginNames`	Display name rules for task plugins, applied by the server loader and the client menu.
`TaskStepExtensions`	Helpers for the common step patterns on ITaskExecutionContext.
`TaskStepList`	The step list of one task: the state machine behind ITaskExecutionContext.PlanSteps and ITaskExecutionContext.BeginStep.
`TaskSupportReasons`	Plain-language texts for ITaskPlugin.NotSupportedReason: what is missing and what to do.

Records

Type	Description
`PermissionDefinition`	A right an administrator gives or takes per role on the Users page (the permission matrix).
`PluginEvent`	One live event of a core plugin for its client page (e.g.
`PluginManifest`	Content of plugin.json next to the plugin assemblies.
`TaskStepInfo`	Immutable view of one step.
`UploadedFile`	An uploaded file.

Enums

Type	Description
`CorePluginGroup`	Well-known context menu groups (ITaskPlugin.Group).
`TaskLogLevel`	The level of a task log entry (ITaskExecutionContext.Log).
`TaskStepState`	State of one step of a task.
`UserRole`	Role of an OADM user.