Table of Contents

Interface IPluginInfo

Namespace
WindowSill.API
Assembly
WindowSill.API.dll

Provides access to plugin-specific information and resources.

public interface IPluginInfo
Extension Methods

Methods

GetPluginContentDirectory()

Gets the directory path where the plugin's content files and resources are stored.

string GetPluginContentDirectory()

Returns

string

The absolute path to the plugin's content directory.

Remarks

The content of this directory is wiped-out when the plugin is uninstalled or updated. Do not store user data here. Use GetPluginDataFolder() instead.

GetPluginDataFolder()

Gets the full path to the data folder used by the plugin.

string GetPluginDataFolder()

Returns

string

A string containing the absolute path to the plugin's data folder.

Remarks

The returned folder is intended for storing plugin-specific data such as user data that may not fit in ISettingsProvider. The folder is created if it does not exist.

GetPluginTempFolder()

Gets the full path to the temporary folder used by the plugin for storing transient files.

string GetPluginTempFolder()

Returns

string

A string containing the absolute path to the plugin's temporary folder.

Remarks

Use this folder to store files that are needed only for the duration of the plugin's operation. The folder is created if it does not exist. The contents of the folder is deleted on each restart of WindowSill.