Interface IPluginProvision

The plugin provisions provided by the plugin manager

Namespace: Snowflake.Extensibility.Provisioning

Assembly: Snowflake.Framework.Primitives.dll

Syntax

public interface IPluginProvision

Properties

Author

Gets the author of the plugin.

Declaration

string Author { get; }

Property Value

Type	Description
System.String

CommonResourceDirectory

Gets the resource directory common to the plugin's module. The common resource directory is intended for static files that are shared between all plugins in the current module, and should not be modified after install.

Declaration

IReadOnlyDirectory CommonResourceDirectory { get; }

Property Value

Type	Description
IReadOnlyDirectory

ConfigurationStore

Gets the plugin's configuration store

Declaration

IPluginConfigurationStore ConfigurationStore { get; }

Property Value

Type	Description
IPluginConfigurationStore

ContentDirectory

Gets this plugin's content directory, or the root location of the plugin.

This should only be used for discretionary or informational purposes. Consider using DataDirectory, ResourceDirectory, or CommonResourceDirectory instead.

Declaration

DirectoryInfo ContentDirectory { get; }

Property Value

Type	Description
System.IO.DirectoryInfo

DataDirectory

Gets the plugin's data directory. The data directory should be used for temporary or generated data that may change or be updated frequently, such as auxillary configurations files or temporary files.

For configuration specifically, consider using ConfigurationStore.

Declaration

IDirectory DataDirectory { get; }

Property Value

Type	Description
IDirectory

Description

Gets a short description of the plugin

Declaration

string Description { get; }

Property Value

Type	Description
System.String

Logger

Gets the logger for the plugin

Declaration

ILogger Logger { get; }

Property Value

Type	Description
ILogger

Name

Gets the plugin's name

Declaration

string Name { get; }

Property Value

Type	Description
System.String

Properties

Gets the plugin's properties

Declaration

IPluginProperties Properties { get; }

Property Value

Type	Description
IPluginProperties

ResourceDirectory

Gets the plugin's resource directory. The resource directory is intended for static files that are required only by this plugin, and should not be modified after install.

Declaration

IReadOnlyDirectory ResourceDirectory { get; }

Property Value

Type	Description
IReadOnlyDirectory

Version

Gets the version of the plugin

Declaration

Version Version { get; }

Property Value

Type	Description
System.Version