File size: 2,302 Bytes
8c763fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
#nullable enable
using System;
using System.Collections.Generic;
namespace System.Management.Automation.Subsystem
{
/// <summary>
/// Define the kinds of subsystems.
/// </summary>
/// <remarks>
/// This enum uses power of 2 as the values for the enum elements, so as to make sure
/// the bitwise 'or' operation of the elements always results in an invalid value.
/// </remarks>
public enum SubsystemKind : uint
{
/// <summary>
/// Component that provides predictive suggestions to commandline input.
/// </summary>
CommandPredictor = 1,
/// <summary>
/// Cross platform desired state configuration component.
/// </summary>
CrossPlatformDsc = 2,
/// <summary>
/// Component that provides feedback when a command fails interactively.
/// </summary>
FeedbackProvider = 4,
}
/// <summary>
/// Define the base interface to implement a subsystem.
/// The API contracts for specific subsystems are defined within the specific interfaces/abstract classes that implements this interface.
/// </summary>
/// <remarks>
/// A user should not directly implement <see cref="ISubsystem"/>, but instead should derive from one of the concrete subsystem interfaces or abstract classes.
/// The instance of a type that only implements 'ISubsystem' cannot be registered to the <see cref="SubsystemManager"/>.
/// </remarks>
public interface ISubsystem
{
/// <summary>
/// Gets the unique identifier for a subsystem implementation.
/// </summary>
Guid Id { get; }
/// <summary>
/// Gets the name of a subsystem implementation.
/// </summary>
string Name { get; }
/// <summary>
/// Gets the description of a subsystem implementation.
/// </summary>
string Description { get; }
/// <summary>
/// Gets a dictionary that contains the functions to be defined at the global scope of a PowerShell session.
/// Key: function name; Value: function script.
/// </summary>
Dictionary<string, string>? FunctionsToDefine { get; }
}
}
|