PluginLicenseInfo

Record in Oadm.Sdk.Licensing · Oadm.Sdk.dll

A plugin’s license as OADM checked it: the status and, for a readable license, what it allows.

public sealed record PluginLicenseInfo(LicenseStatus Status, string Reason, LicenseData? Data = null, DateOnly? TrialEnds = null)

Parameters

Status: The state of the license.
Reason: One plain sentence for the Plugins page and the plugin’s own messages.
Data: The license’s content when it could be read and its signature matches; null otherwise.
TrialEnds: The last day of the trial while there is one; null otherwise.

Properties

Data

LicenseData? Data { get; init; }

The license’s content when it could be read and its signature matches; null otherwise.

IsValid

bool IsValid { get; }

The plugin may run: a valid license, a running trial, or no license needed.

NotRequired

static PluginLicenseInfo NotRequired { get; }

The state of a plugin that needs no license.

Reason

string Reason { get; init; }

One plain sentence for the Plugins page and the plugin’s own messages.

Status

LicenseStatus Status { get; init; }

The state of the license.

TrialEnds

DateOnly? TrialEnds { get; init; }

The last day of the trial while there is one; null otherwise.

Methods

Has

bool Has(string feature)

Whether the license unlocks feature: always when no license is needed or during the trial; with a valid license when it lists the feature or lists none (= every feature); never otherwise.

Limit

long? Limit(string name)

The limit name of a valid license; null when it sets none, no license is needed or the trial runs (no limit); 0 when the plugin may not run.