Class PlugInInfo

Namespace: Phoenix.PlugIns
Assembly: Phoenix.PlugIns.dll

A class that represents the JSON metadata.phxplugin file that is stored with plug-ins to define what they contain.

public class PlugInInfo

Inheritance

object ← PlugInInfo

Inherited Members

object.Equals(object), object.Equals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object, object), object.ToString()

Constructors

PlugInInfo(Guid, IEnumerable, Framework, string, string, string, string, IReadOnlyDictionary<string, string>, Uri, string, string, IReadOnlyDictionary<string, string>)

Constructor

Fields

METADATA_FILENAME

The standard name of the metadata file.

Properties

Author

Who authored this plug-in

CurrentDisplayName

Attempt to retrieve the appropriate display name.

Description

A longer description of the component

DisplayName

A map of language to a human readible display name for the plug-in. Entries may be of the form languageCode2-countryCode2, languageCode2, or an empty string. The languageCode2 must be an ISO 639-1 two-letter country code. The countryCode2 must be an ISO 3166 two-letter subculture code (usually a country identifier). When choosing which name to display, the system will first try to match the user's languageCode2-countryCode2 combination, then just the languageCode2, then it will try to use the entry with an empty key, then it will try to use 'en', lastly falling back on the name of the implementing class. Tests are always case insensitive.

HelpUrl

A URL that provides help for the component

Icon

A path, usually relative to the metadata file, that points to an icon or bitmap file for the component.

Id

The UUID for the plug-in

ImplClass

The full class name that implements the plug-in, in dotted notation.

ImplFile

The main file that contains the implementing class. Must be a .dll for DotNet and a .jar for Java. May be relative to the 'metadata.phxplugin' file.

ImplFramework

What framework is used to implement this plug-in?

Options

An arbitrary string/value map of options. Refer to your SDK documentation for available options that can be set.

SupportedTypes

A list of unique string identifiers that define what types of plug-in this class implements. The plug-in framework is generic to allow for future types. The currently implemented types are 'Phoenix::IHarnessRunner' and 'Phoenix::IHarnessBuilderUI'.

Version

The version of this plug-in

Methods

GetMetadataForAssembly(Assembly)

Creates a list of PlugInInfo objects from the attributes on an Assembly.

GetPlugInType(string)

Get the Type object for the plug-in

Implements<T>()

Determine if the plug-in implements an interface

Implements(string)

Determine if the plug-in implements an interface.

Instantiate<T>(IServiceProvider, string)

Instantiates a new instance of the plug-in

ReadJson(string)

Reads a JSON string into an array of PlugInInfo objects

ReadJsonStreamAsync(Stream)

Reads a list of PlugInInfo objects from a stream

WriteJson(IEnumerable<PlugInInfo>)

Writes a list of PlugInInfo objects into a JSON string. Defaults to human readable (indented)

WriteJson(IEnumerable<PlugInInfo>, Formatting)

Writes a list of PlugInInfo objects into a JSON string.

WriteMetadataForDLLs(params string[])

Write plug-in metadata for a given set of DLLs. A single metadata file with the name Phoenix.PlugIns.PlugInInfo.METADATA_FILENAME will be written in each directory which contains the targeted DLLs. The file will contain metadata for all the targeted DLLs in that directory.