Class ModuleDescriptor
Namespace: Cephalon.Abstractions.Modules
Assembly: Cephalon.Abstractions.dll
Describes a module for discovery, ordering, manifest generation, and diagnostics.
public sealed class ModuleDescriptorInheritance
Section titled “Inheritance”Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Constructors
Section titled “Constructors”ModuleDescriptor(string, string, string, IEnumerable<Type>?, IEnumerable<string>?, string?, IReadOnlyDictionary<string, string>?)
Section titled “ ModuleDescriptor(string, string, string, IEnumerable<Type>?, IEnumerable<string>?, string?, IReadOnlyDictionary<string, string>?)”Creates a module descriptor.
public ModuleDescriptor(string id, string displayName, string description, IEnumerable<Type>? dependsOn = null, IEnumerable<string>? tags = null, string? version = null, IReadOnlyDictionary<string, string>? metadata = null)Parameters
Section titled “Parameters”id string
The stable module identifier.
displayName string
The human-readable module name.
description string
The module description.
dependsOn IEnumerable<Type>?
The module types this module depends on.
tags IEnumerable<string>?
The tags associated with the module.
version string?
The declared module version.
metadata IReadOnlyDictionary<string, string>?
Optional module metadata.
Properties
Section titled “Properties”DependsOn
Section titled “ DependsOn”Gets the module types this module depends on.
public IReadOnlyList<Type> DependsOn { get; }Property Value
Section titled “Property Value”Description
Section titled “ Description”Gets the module description.
public string Description { get; }Property Value
Section titled “Property Value”DisplayName
Section titled “ DisplayName”Gets the human-readable module name.
public string DisplayName { get; }Property Value
Section titled “Property Value”Gets the stable module identifier.
public string Id { get; }Property Value
Section titled “Property Value”Metadata
Section titled “ Metadata”Gets optional module metadata.
public IReadOnlyDictionary<string, string> Metadata { get; }Property Value
Section titled “Property Value”IReadOnlyDictionary<string, string>
Gets the tags associated with the module.
public IReadOnlyList<string> Tags { get; }Property Value
Section titled “Property Value”Version
Section titled “ Version”Gets the declared module version, when one is available.
public string? Version { get; }