LaunchBoxContributors
On this page

PluginConnectionMethod14.1

Class in Unbroken.LaunchBox.Plugins.Capabilities.Connections

C#
public sealed class PluginConnectionMethod
Describes one supported connection method and its ordered presentations.

Constructors

PluginConnectionMethod

C#
public PluginConnectionMethod(
    string id,
    PluginText name,
    IReadOnlyList<IPluginConnectionPresentation> presentations,
    PluginText? description = null
)
Creates a connection method.
id
The stable owner-local method ID, compared ordinally.
name
Its localizable name.
presentations
Nonempty presentations in provider-preferred order.
description
Optional localizable instructions.

Properties

  • DescriptionGets optional instructions.
  • IdGets the method ID.
  • NameGets the localizable name.
  • PresentationsGets an immutable snapshot of the ordered presentations.

Description

C#
public PluginText? Description { get; }
Gets optional instructions.

Id

C#
public string Id { get; }
Gets the method ID.

Name

C#
public PluginText Name { get; }
Gets the localizable name.

Presentations

C#
public IReadOnlyList<IPluginConnectionPresentation> Presentations { get; }
Gets an immutable snapshot of the ordered presentations.