PluginManifest

Record in Oadm.Sdk.Plugins · Oadm.Sdk.dll

Content of plugin.json next to the plugin assemblies. EnabledByDefault false: the plugin is off until an administrator turns it on (Plugins page). AlwaysOn true: core functionality that cannot be turned off (the stored choice is ignored). Description: one short sentence for the Plugins page.

public sealed record PluginManifest(string Id, string Version, string MinSdkVersion, string? DisplayName = null, bool EnabledByDefault = true, bool AlwaysOn = false, string? Description = null)

Guide: Plugin basics

Parameters

• Id: The plugin id (“acme.hello”); also the folder name.
• Version: The plugin’s version.
• MinSdkVersion: The oldest SDK the plugin works with (SdkInfo.Version).
• DisplayName: The name on the Plugins page.
• EnabledByDefault: False: off until an administrator turns it on.
• AlwaysOn: True: core functionality that cannot be turned off.
• Description: One short sentence for the Plugins page.

Properties

AlwaysOn

bool AlwaysOn { get; init; }

True: core functionality that cannot be turned off.

Description

string? Description { get; init; }

One short sentence for the Plugins page.

DisplayName

string? DisplayName { get; init; }

The name on the Plugins page.

EnabledByDefault

bool EnabledByDefault { get; init; }

False: off until an administrator turns it on.

Id

string Id { get; init; }

The plugin id (“acme.hello”); also the folder name.

MinSdkVersion

string MinSdkVersion { get; init; }

The oldest SDK the plugin works with (SdkInfo.Version).

Version

string Version { get; init; }

The plugin’s version.