PackageOffer

public sealed class PackageOffer

What the package server can do about one missing plugin.

Establishing this takes a round trip to the server, so it is done once, in the background, and the answer is carried around afterwards. An offer which is not IsAvailable names the reason in Obstacle, which is what the user is shown in place of a button they cannot press.

Properties

Authors

public string Authors { get; }

Gets the author line the package publishes, or null when there is none.

Description

public string Description { get; }

Gets the description the package author published, or null when there is none. This is the only account of what the plugin actually does which is available before installing it.

Homepage

public string Homepage { get; }

Gets the project home page the package publishes, or null.

Icon

public byte[] Icon { get; }

Gets the raw image bytes of the package icon, or null when the package publishes none — which is the common case. Callers decode this themselves; what the server hands over is whatever the author uploaded.

IsAvailable

public bool IsAvailable { get; }

Gets whether this plugin can actually be installed.

LatestVersion

public string LatestVersion { get; }

Gets the newest suitable version the server publishes, or null when the offer is blocked.

Obstacle

public string Obstacle { get; }

Gets the reason this plugin cannot be fetched, or null when it can.

PackageName

public string PackageName { get; }

Gets the name of the package which provides the plugin, or null when none was identified. This may be set even on a blocked offer, when the package was found but cannot be installed.

RequiredVersion

public string RequiredVersion { get; }

Gets the version the document was saved against, when the server still publishes it. Null when it does not, or when the offer is blocked.

Requirement

public PluginRequirement Requirement { get; }

Gets the missing plugin this offer concerns.

Methods

ToString

public override string ToString()

Describe the offer in one short line, for display beside the plugin name.

Overrides: Object.ToString

VersionFor

public string VersionFor(bool fleeting)

Gets the version to fetch for one kind of installation.

The two differ, and deliberately. A temporary installation exists so that one file can be read as its author saw it, and then be gone; the version the file was saved against is the one that will behave as its author intended, and since nothing survives the session there is no argument for anything newer. A permanent installation is the user adding this plugin to their Rhino for good, where pinning them to an old build on account of one received file would deny them every fix since, and they would never think to undo it.

A temporary installation falls back to the newest version when the server no longer publishes the exact one — yanked, or never pushed.

Parameters:

fleeting (bool)

True for a temporary installation.