# Class FilePlugin

OptimaJet.Workflow.Plugins.FilePlugin

Namespace: [OptimaJet.Workflow.Plugins](https://api.workflowengine.io/files-plugin/OptimaJet.Workflow.Plugins/)

```csharp
public class FilePlugin : ProviderProviders<ProvidersFilePlugin>, ICustomMixProvider, ICustomWorkflowActionProvider, IWorkflowActionProvider, IDisableProvider, ICustomDesignerParameterFormatProvider, IDesignerParameterFormatProvider, ICustomActivityProvider, ICustomConditionProvider, IWorkflowPlugin
```

## Type Hierarchy

-   [ProviderProviders<ProvidersFilePlugin>](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/ProviderProviders-TEnumProviders/)
    -   FilePlugin Current type
        -   Implemented interfaces
            -   [ICustomMixProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/ICustomMixProvider/)
                -   [ICustomActivityProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/ICustomActivityProvider/)
                -   [ICustomConditionProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/ICustomConditionProvider/)
                -   [ICustomDesignerParameterFormatProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/ICustomDesignerParameterFormatProvider/)
                    -   [IDesignerParameterFormatProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/IDesignerParameterFormatProvider/)
                -   [ICustomWorkflowActionProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/ICustomWorkflowActionProvider/)
                    -   [IDisableProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/IDisableProvider/)
                    -   [IWorkflowActionProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/IWorkflowActionProvider/)
            -   [IWorkflowPlugin](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins/IWorkflowPlugin/)

## Constructors

`public FilePlugin()` 

## Properties

`public string Name { get; protected set; }` 

The plugin name.

`public Dictionary<string, string> PluginSettings { get; protected set; }` 

The plugin settings.

## Methods

`public void OnPluginAdd(WorkflowRuntime runtime, List<string> schemes = null)` 

Called when a plugin is added to a runtime.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `runtime` | `WorkflowRuntime` | The instance of the runtime. |
| `schemes` | `List<String>` | The list of schemes for which the plugin is being added. |

`public Task OnRuntimeStartAsync(WorkflowRuntime runtime)` 

Called when the runtime is started.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `runtime` | `WorkflowRuntime` | The instance of the runtime. |

### Returns

| Type | Description |
| --- | --- |
| `Task` | A task that represents the asynchronous operation. |

## Fields

`public FileProvider FileProvider` 

`public ListFilesProvider ListFilesProvider` 

`public DirectoryProvider DirectoryProvider` 

`public CompressProvider CompressProvider` 

`public FTPProvider FTPProvider` 

[Previous Protocols](https://api.workflowengine.io/files-plugin/OptimaJet.Workflow.FilesPlugin.SFTPProvider/Protocols/) [Next ProvidersFilePlugin](https://api.workflowengine.io/files-plugin/OptimaJet.Workflow.Plugins.FilesPlugin/ProvidersFilePlugin/)