Class ExtensionsClient

Namespace

RDCore.SDK.Extensibility

Assembly

RDCore.SDK.dll

An extensions provider service that manages the extensions of a RDCoreExtensionServerApp.

public class ExtensionsClient : IExtensionsProvider

Inheritance

object

ExtensionsClient

Implements

IExtensionsProvider

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ExtensionsClient(IOptions<SdkAppOptions>, IExtensionManifestValidationService, IFileSystem, ILogger<ExtensionsClient>)

An extensions provider service that manages the extensions of a RDCoreExtensionServerApp.

public ExtensionsClient(IOptions<SdkAppOptions> options, IExtensionManifestValidationService validation, IFileSystem fileSystem, ILogger<ExtensionsClient> logger)

Parameters

options IOptions<SdkAppOptions>

The extensions configuration settings.

validation IExtensionManifestValidationService

A service that validates an extension manifest.

fileSystem IFileSystem

Abstracts the file system.

logger ILogger<ExtensionsClient>

Methods

Allow(ExtensionInfo)

Enables the specified ExtensionInfo if the manifest and associated executable pass validation.

public bool Allow(ExtensionInfo extension)

Parameters

extension ExtensionInfo

The deserialized manifest of the extension to enable.

Returns

bool

true if the specified extension passed validation and was enabled, false otherwise.

Block(ExtensionInfo)

Disables the specified ExtensionInfo.

public bool Block(ExtensionInfo extension)

Parameters

extension ExtensionInfo

The deserialized manifest of the extension to disable.

Returns

bool

true if the specified extension could be disabled, false otherwise.

Describe(string, string)

Creates a serializable ExtensionInfo model for the specified extension executable name, with the specified description.

public ExtensionInfo? Describe(string name, string description)

Parameters

name string

The name of the executable extension.

description string

A short description of the extension.

Returns

ExtensionInfo

null if the specified extension cannot be described.

Remarks

The implementation validates that it is executing this method inside the target extension folder.

Discover()

Scans the extensions folder for subfolders containing an extension manifest.

public IEnumerable<ExtensionInfo> Discover()

Returns

IEnumerable<ExtensionInfo>

Returns all discovered valid extensions.

StartAsync(ExtensionInfo)

Asynchronously starts and attempts to connect with the server process for the specified ExtensionInfo.

public Task StartAsync(ExtensionInfo extension)

Parameters

extension ExtensionInfo

The deserialized manifest of the extension to start.

Returns

Task

An asynchronous Task that completes when the specified extension was successfully started and connected, or failed to do so.