> ## Documentation Index
> Fetch the complete documentation index at: https://easyaf.nimbleapps.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# FileSystemOptions

> Specifies the options required to leverage the local file system as the SimpleMessageBus backing queue.

## Definition

**Assembly:** CloudNimble.SimpleMessageBus.Core.dll

**Namespace:** CloudNimble.SimpleMessageBus.Core

**Inheritance:** System.Object

## Syntax

```csharp theme={"dark"}
CloudNimble.SimpleMessageBus.Core.FileSystemOptions
```

## Summary

Specifies the options required to leverage the local file system as the SimpleMessageBus backing queue.

## Constructors

###  .ctor

The default constructor, which sets the default values equal to the values specified in [FileSystemConstants](https://easyaf.nimbleapps.cloud/simplemessagebus/api-reference/CloudNimble/SimpleMessageBus/Core/FileSystemConstants.md).

#### Syntax

```csharp theme={"dark"}
public FileSystemOptions()
```

###  .ctor Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public Object()
```

## Properties

###  CompletedFolderPath

The folder segment where successfully-processed queue items will be moved to upon completion.

#### Syntax

```csharp theme={"dark"}
public string CompletedFolderPath { get; }
```

#### Property Value

Type: `string`

###  ErrorFolderPath

The folder segment where failed items will be stored while they are waiting to be analyzed and reprocessed.

#### Syntax

```csharp theme={"dark"}
public string ErrorFolderPath { get; }
```

#### Property Value

Type: `string`

###  IsNetworkPath

Gets a boolean specifying whether or not the [FileSystemOptions.RootFolder](https://easyaf.nimbleapps.cloud/simplemessagebus/api-reference/CloudNimble/SimpleMessageBus/Core/FileSystemOptions.md#rootfolder) is a network path (either a UNC or mapped drive).

#### Syntax

```csharp theme={"dark"}
public bool IsNetworkPath { get; }
```

#### Property Value

Type: `bool`

###  QueueFolderPath

The folder segment where items will be stored while they are waiting to be processed.

#### Syntax

```csharp theme={"dark"}
public string QueueFolderPath { get; }
```

#### Property Value

Type: `string`

###  RootFolder

A string representing the folder that will hold the three required queue folders.

#### Syntax

```csharp theme={"dark"}
public string RootFolder { get; set; }
```

#### Property Value

Type: `string`

###  VirusScanDelayInSeconds

An integer representing the number of seconds to wait before firing FileSystemWatcher events to process the Queue.

#### Syntax

```csharp theme={"dark"}
public int VirusScanDelayInSeconds { get; set; }
```

#### Property Value

Type: `int`

## Methods

###  Equals Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual bool Equals(object obj)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `obj` | `object?` | - |

#### Returns

Type: `bool`

###  Equals Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public static bool Equals(object objA, object objB)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `objA` | `object?` | - |
| `objB` | `object?` | - |

#### Returns

Type: `bool`

###  GetHashCode Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual int GetHashCode()
```

#### Returns

Type: `int`

###  GetType Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public System.Type GetType()
```

#### Returns

Type: `System.Type`

###  MemberwiseClone Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
protected internal object MemberwiseClone()
```

#### Returns

Type: `object`

###  ReferenceEquals Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public static bool ReferenceEquals(object objA, object objB)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `objA` | `object?` | - |
| `objB` | `object?` | - |

#### Returns

Type: `bool`

###  ToString Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual string ToString()
```

#### Returns

Type: `string?`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.